Merge "Fixed sanity cache clear in User::saveSettings()"
[lhc/web/wiklou.git] / includes / User.php
1 <?php
2 /**
3 * Implements the User class for the %MediaWiki software.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 /**
24 * String Some punctuation to prevent editing from broken text-mangling proxies.
25 * @ingroup Constants
26 */
27 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
28
29 /**
30 * The User object encapsulates all of the user-specific settings (user_id,
31 * name, rights, password, email address, options, last login time). Client
32 * classes use the getXXX() functions to access these fields. These functions
33 * do all the work of determining whether the user is logged in,
34 * whether the requested option can be satisfied from cookies or
35 * whether a database query is needed. Most of the settings needed
36 * for rendering normal pages are set in the cookie to minimize use
37 * of the database.
38 */
39 class User implements IDBAccessObject {
40 /**
41 * @const int Number of characters in user_token field.
42 */
43 const TOKEN_LENGTH = 32;
44
45 /**
46 * Global constant made accessible as class constants so that autoloader
47 * magic can be used.
48 */
49 const EDIT_TOKEN_SUFFIX = EDIT_TOKEN_SUFFIX;
50
51 /**
52 * @const int Serialized record version.
53 */
54 const VERSION = 10;
55
56 /**
57 * Maximum items in $mWatchedItems
58 */
59 const MAX_WATCHED_ITEMS_CACHE = 100;
60
61 /**
62 * Exclude user options that are set to their default value.
63 * @since 1.25
64 */
65 const GETOPTIONS_EXCLUDE_DEFAULTS = 1;
66
67 /**
68 * @var PasswordFactory Lazily loaded factory object for passwords
69 */
70 private static $mPasswordFactory = null;
71
72 /**
73 * Array of Strings List of member variables which are saved to the
74 * shared cache (memcached). Any operation which changes the
75 * corresponding database fields must call a cache-clearing function.
76 * @showinitializer
77 */
78 protected static $mCacheVars = array(
79 // user table
80 'mId',
81 'mName',
82 'mRealName',
83 'mEmail',
84 'mTouched',
85 'mToken',
86 'mEmailAuthenticated',
87 'mEmailToken',
88 'mEmailTokenExpires',
89 'mRegistration',
90 'mEditCount',
91 // user_groups table
92 'mGroups',
93 // user_properties table
94 'mOptionOverrides',
95 );
96
97 /**
98 * Array of Strings Core rights.
99 * Each of these should have a corresponding message of the form
100 * "right-$right".
101 * @showinitializer
102 */
103 protected static $mCoreRights = array(
104 'apihighlimits',
105 'applychangetags',
106 'autoconfirmed',
107 'autopatrol',
108 'bigdelete',
109 'block',
110 'blockemail',
111 'bot',
112 'browsearchive',
113 'changetags',
114 'createaccount',
115 'createpage',
116 'createtalk',
117 'delete',
118 'deletedhistory',
119 'deletedtext',
120 'deletelogentry',
121 'deleterevision',
122 'edit',
123 'editcontentmodel',
124 'editinterface',
125 'editprotected',
126 'editmyoptions',
127 'editmyprivateinfo',
128 'editmyusercss',
129 'editmyuserjs',
130 'editmywatchlist',
131 'editsemiprotected',
132 'editusercssjs', # deprecated
133 'editusercss',
134 'edituserjs',
135 'hideuser',
136 'import',
137 'importupload',
138 'ipblock-exempt',
139 'managechangetags',
140 'markbotedits',
141 'mergehistory',
142 'minoredit',
143 'move',
144 'movefile',
145 'move-categorypages',
146 'move-rootuserpages',
147 'move-subpages',
148 'nominornewtalk',
149 'noratelimit',
150 'override-export-depth',
151 'pagelang',
152 'passwordreset',
153 'patrol',
154 'patrolmarks',
155 'protect',
156 'proxyunbannable',
157 'purge',
158 'read',
159 'reupload',
160 'reupload-own',
161 'reupload-shared',
162 'rollback',
163 'sendemail',
164 'siteadmin',
165 'suppressionlog',
166 'suppressredirect',
167 'suppressrevision',
168 'unblockself',
169 'undelete',
170 'unwatchedpages',
171 'upload',
172 'upload_by_url',
173 'userrights',
174 'userrights-interwiki',
175 'viewmyprivateinfo',
176 'viewmywatchlist',
177 'viewsuppressed',
178 'writeapi',
179 );
180
181 /**
182 * String Cached results of getAllRights()
183 */
184 protected static $mAllRights = false;
185
186 /** Cache variables */
187 // @{
188 public $mId;
189 /** @var string */
190 public $mName;
191 /** @var string */
192 public $mRealName;
193 /**
194 * @todo Make this actually private
195 * @private
196 * @var Password
197 */
198 public $mPassword;
199 /**
200 * @todo Make this actually private
201 * @private
202 * @var Password
203 */
204 public $mNewpassword;
205 /** @var string */
206 public $mNewpassTime;
207 /** @var string */
208 public $mEmail;
209 /** @var string TS_MW timestamp from the DB */
210 public $mTouched;
211 /** @var string TS_MW timestamp from cache */
212 protected $mQuickTouched;
213 /** @var string */
214 protected $mToken;
215 /** @var string */
216 public $mEmailAuthenticated;
217 /** @var string */
218 protected $mEmailToken;
219 /** @var string */
220 protected $mEmailTokenExpires;
221 /** @var string */
222 protected $mRegistration;
223 /** @var int */
224 protected $mEditCount;
225 /** @var array */
226 public $mGroups;
227 /** @var array */
228 protected $mOptionOverrides;
229 /** @var string */
230 protected $mPasswordExpires;
231 // @}
232
233 /**
234 * Bool Whether the cache variables have been loaded.
235 */
236 // @{
237 public $mOptionsLoaded;
238
239 /**
240 * Array with already loaded items or true if all items have been loaded.
241 */
242 protected $mLoadedItems = array();
243 // @}
244
245 /**
246 * String Initialization data source if mLoadedItems!==true. May be one of:
247 * - 'defaults' anonymous user initialised from class defaults
248 * - 'name' initialise from mName
249 * - 'id' initialise from mId
250 * - 'session' log in from cookies or session if possible
251 *
252 * Use the User::newFrom*() family of functions to set this.
253 */
254 public $mFrom;
255
256 /**
257 * Lazy-initialized variables, invalidated with clearInstanceCache
258 */
259 protected $mNewtalk;
260 /** @var string */
261 protected $mDatePreference;
262 /** @var string */
263 public $mBlockedby;
264 /** @var string */
265 protected $mHash;
266 /** @var array */
267 public $mRights;
268 /** @var string */
269 protected $mBlockreason;
270 /** @var array */
271 protected $mEffectiveGroups;
272 /** @var array */
273 protected $mImplicitGroups;
274 /** @var array */
275 protected $mFormerGroups;
276 /** @var bool */
277 protected $mBlockedGlobally;
278 /** @var bool */
279 protected $mLocked;
280 /** @var bool */
281 public $mHideName;
282 /** @var array */
283 public $mOptions;
284
285 /**
286 * @var WebRequest
287 */
288 private $mRequest;
289
290 /** @var Block */
291 public $mBlock;
292
293 /** @var bool */
294 protected $mAllowUsertalk;
295
296 /** @var Block */
297 private $mBlockedFromCreateAccount = false;
298
299 /** @var array */
300 private $mWatchedItems = array();
301
302 /** @var integer User::READ_* constant bitfield used to load data */
303 protected $queryFlagsUsed = self::READ_NORMAL;
304
305 public static $idCacheByName = array();
306
307 /**
308 * Lightweight constructor for an anonymous user.
309 * Use the User::newFrom* factory functions for other kinds of users.
310 *
311 * @see newFromName()
312 * @see newFromId()
313 * @see newFromConfirmationCode()
314 * @see newFromSession()
315 * @see newFromRow()
316 */
317 public function __construct() {
318 $this->clearInstanceCache( 'defaults' );
319 }
320
321 /**
322 * @return string
323 */
324 public function __toString() {
325 return $this->getName();
326 }
327
328 /**
329 * Load the user table data for this object from the source given by mFrom.
330 *
331 * @param integer $flags User::READ_* constant bitfield
332 */
333 public function load( $flags = self::READ_NORMAL ) {
334 if ( $this->mLoadedItems === true ) {
335 return;
336 }
337
338 // Set it now to avoid infinite recursion in accessors
339 $this->mLoadedItems = true;
340 $this->queryFlagsUsed = $flags;
341
342 switch ( $this->mFrom ) {
343 case 'defaults':
344 $this->loadDefaults();
345 break;
346 case 'name':
347 // Make sure this thread sees its own changes
348 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
349 $flags |= self::READ_LATEST;
350 $this->queryFlagsUsed = $flags;
351 }
352
353 $this->mId = self::idFromName( $this->mName, $flags );
354 if ( !$this->mId ) {
355 // Nonexistent user placeholder object
356 $this->loadDefaults( $this->mName );
357 } else {
358 $this->loadFromId( $flags );
359 }
360 break;
361 case 'id':
362 $this->loadFromId( $flags );
363 break;
364 case 'session':
365 if ( !$this->loadFromSession() ) {
366 // Loading from session failed. Load defaults.
367 $this->loadDefaults();
368 }
369 Hooks::run( 'UserLoadAfterLoadFromSession', array( $this ) );
370 break;
371 default:
372 throw new UnexpectedValueException(
373 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
374 }
375 }
376
377 /**
378 * Load user table data, given mId has already been set.
379 * @param integer $flags User::READ_* constant bitfield
380 * @return bool False if the ID does not exist, true otherwise
381 */
382 public function loadFromId( $flags = self::READ_NORMAL ) {
383 if ( $this->mId == 0 ) {
384 $this->loadDefaults();
385 return false;
386 }
387
388 // Try cache (unless this needs to lock the DB).
389 // NOTE: if this thread called saveSettings(), the cache was cleared.
390 $locking = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING );
391 if ( $locking || !$this->loadFromCache() ) {
392 wfDebug( "User: cache miss for user {$this->mId}\n" );
393 // Load from DB (make sure this thread sees its own changes)
394 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
395 $flags |= self::READ_LATEST;
396 }
397 if ( !$this->loadFromDatabase( $flags ) ) {
398 // Can't load from ID, user is anonymous
399 return false;
400 }
401 $this->saveToCache();
402 }
403
404 $this->mLoadedItems = true;
405 $this->queryFlagsUsed = $flags;
406
407 return true;
408 }
409
410 /**
411 * Load user data from shared cache, given mId has already been set.
412 *
413 * @return bool false if the ID does not exist or data is invalid, true otherwise
414 * @since 1.25
415 */
416 protected function loadFromCache() {
417 if ( $this->mId == 0 ) {
418 $this->loadDefaults();
419 return false;
420 }
421
422 $key = wfMemcKey( 'user', 'id', $this->mId );
423 $data = ObjectCache::getMainWANInstance()->get( $key );
424 if ( !is_array( $data ) || $data['mVersion'] < self::VERSION ) {
425 // Object is expired
426 return false;
427 }
428
429 wfDebug( "User: got user {$this->mId} from cache\n" );
430
431 // Restore from cache
432 foreach ( self::$mCacheVars as $name ) {
433 $this->$name = $data[$name];
434 }
435
436 return true;
437 }
438
439 /**
440 * Save user data to the shared cache
441 *
442 * This method should not be called outside the User class
443 */
444 public function saveToCache() {
445 $this->load();
446 $this->loadGroups();
447 $this->loadOptions();
448
449 if ( $this->isAnon() ) {
450 // Anonymous users are uncached
451 return;
452 }
453
454 $data = array();
455 foreach ( self::$mCacheVars as $name ) {
456 $data[$name] = $this->$name;
457 }
458 $data['mVersion'] = self::VERSION;
459 $key = wfMemcKey( 'user', 'id', $this->mId );
460
461 ObjectCache::getMainWANInstance()->set( $key, $data, 3600 );
462 }
463
464 /** @name newFrom*() static factory methods */
465 // @{
466
467 /**
468 * Static factory method for creation from username.
469 *
470 * This is slightly less efficient than newFromId(), so use newFromId() if
471 * you have both an ID and a name handy.
472 *
473 * @param string $name Username, validated by Title::newFromText()
474 * @param string|bool $validate Validate username. Takes the same parameters as
475 * User::getCanonicalName(), except that true is accepted as an alias
476 * for 'valid', for BC.
477 *
478 * @return User|bool User object, or false if the username is invalid
479 * (e.g. if it contains illegal characters or is an IP address). If the
480 * username is not present in the database, the result will be a user object
481 * with a name, zero user ID and default settings.
482 */
483 public static function newFromName( $name, $validate = 'valid' ) {
484 if ( $validate === true ) {
485 $validate = 'valid';
486 }
487 $name = self::getCanonicalName( $name, $validate );
488 if ( $name === false ) {
489 return false;
490 } else {
491 // Create unloaded user object
492 $u = new User;
493 $u->mName = $name;
494 $u->mFrom = 'name';
495 $u->setItemLoaded( 'name' );
496 return $u;
497 }
498 }
499
500 /**
501 * Static factory method for creation from a given user ID.
502 *
503 * @param int $id Valid user ID
504 * @return User The corresponding User object
505 */
506 public static function newFromId( $id ) {
507 $u = new User;
508 $u->mId = $id;
509 $u->mFrom = 'id';
510 $u->setItemLoaded( 'id' );
511 return $u;
512 }
513
514 /**
515 * Factory method to fetch whichever user has a given email confirmation code.
516 * This code is generated when an account is created or its e-mail address
517 * has changed.
518 *
519 * If the code is invalid or has expired, returns NULL.
520 *
521 * @param string $code Confirmation code
522 * @param int $flags User::READ_* bitfield
523 * @return User|null
524 */
525 public static function newFromConfirmationCode( $code, $flags = 0 ) {
526 $db = ( $flags & self::READ_LATEST ) == self::READ_LATEST
527 ? wfGetDB( DB_MASTER )
528 : wfGetDB( DB_SLAVE );
529
530 $id = $db->selectField(
531 'user',
532 'user_id',
533 array(
534 'user_email_token' => md5( $code ),
535 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
536 )
537 );
538
539 return $id ? User::newFromId( $id ) : null;
540 }
541
542 /**
543 * Create a new user object using data from session or cookies. If the
544 * login credentials are invalid, the result is an anonymous user.
545 *
546 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
547 * @return User
548 */
549 public static function newFromSession( WebRequest $request = null ) {
550 $user = new User;
551 $user->mFrom = 'session';
552 $user->mRequest = $request;
553 return $user;
554 }
555
556 /**
557 * Create a new user object from a user row.
558 * The row should have the following fields from the user table in it:
559 * - either user_name or user_id to load further data if needed (or both)
560 * - user_real_name
561 * - all other fields (email, password, etc.)
562 * It is useless to provide the remaining fields if either user_id,
563 * user_name and user_real_name are not provided because the whole row
564 * will be loaded once more from the database when accessing them.
565 *
566 * @param stdClass $row A row from the user table
567 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
568 * @return User
569 */
570 public static function newFromRow( $row, $data = null ) {
571 $user = new User;
572 $user->loadFromRow( $row, $data );
573 return $user;
574 }
575
576 // @}
577
578 /**
579 * Get the username corresponding to a given user ID
580 * @param int $id User ID
581 * @return string|bool The corresponding username
582 */
583 public static function whoIs( $id ) {
584 return UserCache::singleton()->getProp( $id, 'name' );
585 }
586
587 /**
588 * Get the real name of a user given their user ID
589 *
590 * @param int $id User ID
591 * @return string|bool The corresponding user's real name
592 */
593 public static function whoIsReal( $id ) {
594 return UserCache::singleton()->getProp( $id, 'real_name' );
595 }
596
597 /**
598 * Get database id given a user name
599 * @param string $name Username
600 * @param integer $flags User::READ_* constant bitfield
601 * @return int|null The corresponding user's ID, or null if user is nonexistent
602 */
603 public static function idFromName( $name, $flags = self::READ_NORMAL ) {
604 $nt = Title::makeTitleSafe( NS_USER, $name );
605 if ( is_null( $nt ) ) {
606 // Illegal name
607 return null;
608 }
609
610 if ( isset( self::$idCacheByName[$name] ) ) {
611 return self::$idCacheByName[$name];
612 }
613
614 $db = ( $flags & self::READ_LATEST )
615 ? wfGetDB( DB_MASTER )
616 : wfGetDB( DB_SLAVE );
617
618 $s = $db->selectRow(
619 'user',
620 array( 'user_id' ),
621 array( 'user_name' => $nt->getText() ),
622 __METHOD__
623 );
624
625 if ( $s === false ) {
626 $result = null;
627 } else {
628 $result = $s->user_id;
629 }
630
631 self::$idCacheByName[$name] = $result;
632
633 if ( count( self::$idCacheByName ) > 1000 ) {
634 self::$idCacheByName = array();
635 }
636
637 return $result;
638 }
639
640 /**
641 * Reset the cache used in idFromName(). For use in tests.
642 */
643 public static function resetIdByNameCache() {
644 self::$idCacheByName = array();
645 }
646
647 /**
648 * Does the string match an anonymous IPv4 address?
649 *
650 * This function exists for username validation, in order to reject
651 * usernames which are similar in form to IP addresses. Strings such
652 * as 300.300.300.300 will return true because it looks like an IP
653 * address, despite not being strictly valid.
654 *
655 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
656 * address because the usemod software would "cloak" anonymous IP
657 * addresses like this, if we allowed accounts like this to be created
658 * new users could get the old edits of these anonymous users.
659 *
660 * @param string $name Name to match
661 * @return bool
662 */
663 public static function isIP( $name ) {
664 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
665 || IP::isIPv6( $name );
666 }
667
668 /**
669 * Is the input a valid username?
670 *
671 * Checks if the input is a valid username, we don't want an empty string,
672 * an IP address, anything that contains slashes (would mess up subpages),
673 * is longer than the maximum allowed username size or doesn't begin with
674 * a capital letter.
675 *
676 * @param string $name Name to match
677 * @return bool
678 */
679 public static function isValidUserName( $name ) {
680 global $wgContLang, $wgMaxNameChars;
681
682 if ( $name == ''
683 || User::isIP( $name )
684 || strpos( $name, '/' ) !== false
685 || strlen( $name ) > $wgMaxNameChars
686 || $name != $wgContLang->ucfirst( $name )
687 ) {
688 wfDebugLog( 'username', __METHOD__ .
689 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
690 return false;
691 }
692
693 // Ensure that the name can't be misresolved as a different title,
694 // such as with extra namespace keys at the start.
695 $parsed = Title::newFromText( $name );
696 if ( is_null( $parsed )
697 || $parsed->getNamespace()
698 || strcmp( $name, $parsed->getPrefixedText() ) ) {
699 wfDebugLog( 'username', __METHOD__ .
700 ": '$name' invalid due to ambiguous prefixes" );
701 return false;
702 }
703
704 // Check an additional blacklist of troublemaker characters.
705 // Should these be merged into the title char list?
706 $unicodeBlacklist = '/[' .
707 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
708 '\x{00a0}' . # non-breaking space
709 '\x{2000}-\x{200f}' . # various whitespace
710 '\x{2028}-\x{202f}' . # breaks and control chars
711 '\x{3000}' . # ideographic space
712 '\x{e000}-\x{f8ff}' . # private use
713 ']/u';
714 if ( preg_match( $unicodeBlacklist, $name ) ) {
715 wfDebugLog( 'username', __METHOD__ .
716 ": '$name' invalid due to blacklisted characters" );
717 return false;
718 }
719
720 return true;
721 }
722
723 /**
724 * Usernames which fail to pass this function will be blocked
725 * from user login and new account registrations, but may be used
726 * internally by batch processes.
727 *
728 * If an account already exists in this form, login will be blocked
729 * by a failure to pass this function.
730 *
731 * @param string $name Name to match
732 * @return bool
733 */
734 public static function isUsableName( $name ) {
735 global $wgReservedUsernames;
736 // Must be a valid username, obviously ;)
737 if ( !self::isValidUserName( $name ) ) {
738 return false;
739 }
740
741 static $reservedUsernames = false;
742 if ( !$reservedUsernames ) {
743 $reservedUsernames = $wgReservedUsernames;
744 Hooks::run( 'UserGetReservedNames', array( &$reservedUsernames ) );
745 }
746
747 // Certain names may be reserved for batch processes.
748 foreach ( $reservedUsernames as $reserved ) {
749 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
750 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
751 }
752 if ( $reserved == $name ) {
753 return false;
754 }
755 }
756 return true;
757 }
758
759 /**
760 * Usernames which fail to pass this function will be blocked
761 * from new account registrations, but may be used internally
762 * either by batch processes or by user accounts which have
763 * already been created.
764 *
765 * Additional blacklisting may be added here rather than in
766 * isValidUserName() to avoid disrupting existing accounts.
767 *
768 * @param string $name String to match
769 * @return bool
770 */
771 public static function isCreatableName( $name ) {
772 global $wgInvalidUsernameCharacters;
773
774 // Ensure that the username isn't longer than 235 bytes, so that
775 // (at least for the builtin skins) user javascript and css files
776 // will work. (bug 23080)
777 if ( strlen( $name ) > 235 ) {
778 wfDebugLog( 'username', __METHOD__ .
779 ": '$name' invalid due to length" );
780 return false;
781 }
782
783 // Preg yells if you try to give it an empty string
784 if ( $wgInvalidUsernameCharacters !== '' ) {
785 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
786 wfDebugLog( 'username', __METHOD__ .
787 ": '$name' invalid due to wgInvalidUsernameCharacters" );
788 return false;
789 }
790 }
791
792 return self::isUsableName( $name );
793 }
794
795 /**
796 * Is the input a valid password for this user?
797 *
798 * @param string $password Desired password
799 * @return bool
800 */
801 public function isValidPassword( $password ) {
802 // simple boolean wrapper for getPasswordValidity
803 return $this->getPasswordValidity( $password ) === true;
804 }
805
806
807 /**
808 * Given unvalidated password input, return error message on failure.
809 *
810 * @param string $password Desired password
811 * @return bool|string|array True on success, string or array of error message on failure
812 */
813 public function getPasswordValidity( $password ) {
814 $result = $this->checkPasswordValidity( $password );
815 if ( $result->isGood() ) {
816 return true;
817 } else {
818 $messages = array();
819 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
820 $messages[] = $error['message'];
821 }
822 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
823 $messages[] = $warning['message'];
824 }
825 if ( count( $messages ) === 1 ) {
826 return $messages[0];
827 }
828 return $messages;
829 }
830 }
831
832 /**
833 * Check if this is a valid password for this user
834 *
835 * Create a Status object based on the password's validity.
836 * The Status should be set to fatal if the user should not
837 * be allowed to log in, and should have any errors that
838 * would block changing the password.
839 *
840 * If the return value of this is not OK, the password
841 * should not be checked. If the return value is not Good,
842 * the password can be checked, but the user should not be
843 * able to set their password to this.
844 *
845 * @param string $password Desired password
846 * @param string $purpose one of 'login', 'create', 'reset'
847 * @return Status
848 * @since 1.23
849 */
850 public function checkPasswordValidity( $password, $purpose = 'login' ) {
851 global $wgPasswordPolicy;
852
853 $upp = new UserPasswordPolicy(
854 $wgPasswordPolicy['policies'],
855 $wgPasswordPolicy['checks']
856 );
857
858 $status = Status::newGood();
859 $result = false; // init $result to false for the internal checks
860
861 if ( !Hooks::run( 'isValidPassword', array( $password, &$result, $this ) ) ) {
862 $status->error( $result );
863 return $status;
864 }
865
866 if ( $result === false ) {
867 $status->merge( $upp->checkUserPassword( $this, $password, $purpose ) );
868 return $status;
869 } elseif ( $result === true ) {
870 return $status;
871 } else {
872 $status->error( $result );
873 return $status; // the isValidPassword hook set a string $result and returned true
874 }
875 }
876
877 /**
878 * Expire a user's password
879 * @since 1.23
880 * @param int $ts Optional timestamp to convert, default 0 for the current time
881 */
882 public function expirePassword( $ts = 0 ) {
883 $this->loadPasswords();
884 $timestamp = wfTimestamp( TS_MW, $ts );
885 $this->mPasswordExpires = $timestamp;
886 $this->saveSettings();
887 }
888
889 /**
890 * Clear the password expiration for a user
891 * @since 1.23
892 * @param bool $load Ensure user object is loaded first
893 */
894 public function resetPasswordExpiration( $load = true ) {
895 global $wgPasswordExpirationDays;
896 if ( $load ) {
897 $this->load();
898 }
899 $newExpire = null;
900 if ( $wgPasswordExpirationDays ) {
901 $newExpire = wfTimestamp(
902 TS_MW,
903 time() + ( $wgPasswordExpirationDays * 24 * 3600 )
904 );
905 }
906 // Give extensions a chance to force an expiration
907 Hooks::run( 'ResetPasswordExpiration', array( $this, &$newExpire ) );
908 $this->mPasswordExpires = $newExpire;
909 }
910
911 /**
912 * Check if the user's password is expired.
913 * TODO: Put this and password length into a PasswordPolicy object
914 * @since 1.23
915 * @return string|bool The expiration type, or false if not expired
916 * hard: A password change is required to login
917 * soft: Allow login, but encourage password change
918 * false: Password is not expired
919 */
920 public function getPasswordExpired() {
921 global $wgPasswordExpireGrace;
922 $expired = false;
923 $now = wfTimestamp();
924 $expiration = $this->getPasswordExpireDate();
925 $expUnix = wfTimestamp( TS_UNIX, $expiration );
926 if ( $expiration !== null && $expUnix < $now ) {
927 $expired = ( $expUnix + $wgPasswordExpireGrace < $now ) ? 'hard' : 'soft';
928 }
929 return $expired;
930 }
931
932 /**
933 * Get this user's password expiration date. Since this may be using
934 * the cached User object, we assume that whatever mechanism is setting
935 * the expiration date is also expiring the User cache.
936 * @since 1.23
937 * @return string|bool The datestamp of the expiration, or null if not set
938 */
939 public function getPasswordExpireDate() {
940 $this->load();
941 return $this->mPasswordExpires;
942 }
943
944 /**
945 * Given unvalidated user input, return a canonical username, or false if
946 * the username is invalid.
947 * @param string $name User input
948 * @param string|bool $validate Type of validation to use:
949 * - false No validation
950 * - 'valid' Valid for batch processes
951 * - 'usable' Valid for batch processes and login
952 * - 'creatable' Valid for batch processes, login and account creation
953 *
954 * @throws InvalidArgumentException
955 * @return bool|string
956 */
957 public static function getCanonicalName( $name, $validate = 'valid' ) {
958 // Force usernames to capital
959 global $wgContLang;
960 $name = $wgContLang->ucfirst( $name );
961
962 # Reject names containing '#'; these will be cleaned up
963 # with title normalisation, but then it's too late to
964 # check elsewhere
965 if ( strpos( $name, '#' ) !== false ) {
966 return false;
967 }
968
969 // Clean up name according to title rules,
970 // but only when validation is requested (bug 12654)
971 $t = ( $validate !== false ) ?
972 Title::newFromText( $name ) : Title::makeTitle( NS_USER, $name );
973 // Check for invalid titles
974 if ( is_null( $t ) ) {
975 return false;
976 }
977
978 // Reject various classes of invalid names
979 global $wgAuth;
980 $name = $wgAuth->getCanonicalName( $t->getText() );
981
982 switch ( $validate ) {
983 case false:
984 break;
985 case 'valid':
986 if ( !User::isValidUserName( $name ) ) {
987 $name = false;
988 }
989 break;
990 case 'usable':
991 if ( !User::isUsableName( $name ) ) {
992 $name = false;
993 }
994 break;
995 case 'creatable':
996 if ( !User::isCreatableName( $name ) ) {
997 $name = false;
998 }
999 break;
1000 default:
1001 throw new InvalidArgumentException(
1002 'Invalid parameter value for $validate in ' . __METHOD__ );
1003 }
1004 return $name;
1005 }
1006
1007 /**
1008 * Count the number of edits of a user
1009 *
1010 * @param int $uid User ID to check
1011 * @return int The user's edit count
1012 *
1013 * @deprecated since 1.21 in favour of User::getEditCount
1014 */
1015 public static function edits( $uid ) {
1016 wfDeprecated( __METHOD__, '1.21' );
1017 $user = self::newFromId( $uid );
1018 return $user->getEditCount();
1019 }
1020
1021 /**
1022 * Return a random password.
1023 *
1024 * @return string New random password
1025 */
1026 public static function randomPassword() {
1027 global $wgMinimalPasswordLength;
1028 // Decide the final password length based on our min password length,
1029 // stopping at a minimum of 10 chars.
1030 $length = max( 10, $wgMinimalPasswordLength );
1031 // Multiply by 1.25 to get the number of hex characters we need
1032 $length = $length * 1.25;
1033 // Generate random hex chars
1034 $hex = MWCryptRand::generateHex( $length );
1035 // Convert from base 16 to base 32 to get a proper password like string
1036 return wfBaseConvert( $hex, 16, 32 );
1037 }
1038
1039 /**
1040 * Set cached properties to default.
1041 *
1042 * @note This no longer clears uncached lazy-initialised properties;
1043 * the constructor does that instead.
1044 *
1045 * @param string|bool $name
1046 */
1047 public function loadDefaults( $name = false ) {
1048
1049 $passwordFactory = self::getPasswordFactory();
1050
1051 $this->mId = 0;
1052 $this->mName = $name;
1053 $this->mRealName = '';
1054 $this->mPassword = $passwordFactory->newFromCiphertext( null );
1055 $this->mNewpassword = $passwordFactory->newFromCiphertext( null );
1056 $this->mNewpassTime = null;
1057 $this->mEmail = '';
1058 $this->mOptionOverrides = null;
1059 $this->mOptionsLoaded = false;
1060
1061 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
1062 if ( $loggedOut !== null ) {
1063 $this->mTouched = wfTimestamp( TS_MW, $loggedOut );
1064 } else {
1065 $this->mTouched = '1'; # Allow any pages to be cached
1066 }
1067
1068 $this->mToken = null; // Don't run cryptographic functions till we need a token
1069 $this->mEmailAuthenticated = null;
1070 $this->mEmailToken = '';
1071 $this->mEmailTokenExpires = null;
1072 $this->mPasswordExpires = null;
1073 $this->resetPasswordExpiration( false );
1074 $this->mRegistration = wfTimestamp( TS_MW );
1075 $this->mGroups = array();
1076
1077 Hooks::run( 'UserLoadDefaults', array( $this, $name ) );
1078 }
1079
1080 /**
1081 * Return whether an item has been loaded.
1082 *
1083 * @param string $item Item to check. Current possibilities:
1084 * - id
1085 * - name
1086 * - realname
1087 * @param string $all 'all' to check if the whole object has been loaded
1088 * or any other string to check if only the item is available (e.g.
1089 * for optimisation)
1090 * @return bool
1091 */
1092 public function isItemLoaded( $item, $all = 'all' ) {
1093 return ( $this->mLoadedItems === true && $all === 'all' ) ||
1094 ( isset( $this->mLoadedItems[$item] ) && $this->mLoadedItems[$item] === true );
1095 }
1096
1097 /**
1098 * Set that an item has been loaded
1099 *
1100 * @param string $item
1101 */
1102 protected function setItemLoaded( $item ) {
1103 if ( is_array( $this->mLoadedItems ) ) {
1104 $this->mLoadedItems[$item] = true;
1105 }
1106 }
1107
1108 /**
1109 * Load user data from the session or login cookie.
1110 *
1111 * @return bool True if the user is logged in, false otherwise.
1112 */
1113 private function loadFromSession() {
1114 $result = null;
1115 Hooks::run( 'UserLoadFromSession', array( $this, &$result ) );
1116 if ( $result !== null ) {
1117 return $result;
1118 }
1119
1120 $request = $this->getRequest();
1121
1122 $cookieId = $request->getCookie( 'UserID' );
1123 $sessId = $request->getSessionData( 'wsUserID' );
1124
1125 if ( $cookieId !== null ) {
1126 $sId = intval( $cookieId );
1127 if ( $sessId !== null && $cookieId != $sessId ) {
1128 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
1129 cookie user ID ($sId) don't match!" );
1130 return false;
1131 }
1132 $request->setSessionData( 'wsUserID', $sId );
1133 } elseif ( $sessId !== null && $sessId != 0 ) {
1134 $sId = $sessId;
1135 } else {
1136 return false;
1137 }
1138
1139 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
1140 $sName = $request->getSessionData( 'wsUserName' );
1141 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
1142 $sName = $request->getCookie( 'UserName' );
1143 $request->setSessionData( 'wsUserName', $sName );
1144 } else {
1145 return false;
1146 }
1147
1148 $proposedUser = User::newFromId( $sId );
1149 if ( !$proposedUser->isLoggedIn() ) {
1150 // Not a valid ID
1151 return false;
1152 }
1153
1154 global $wgBlockDisablesLogin;
1155 if ( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
1156 // User blocked and we've disabled blocked user logins
1157 return false;
1158 }
1159
1160 if ( $request->getSessionData( 'wsToken' ) ) {
1161 $passwordCorrect =
1162 ( $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' ) );
1163 $from = 'session';
1164 } elseif ( $request->getCookie( 'Token' ) ) {
1165 # Get the token from DB/cache and clean it up to remove garbage padding.
1166 # This deals with historical problems with bugs and the default column value.
1167 $token = rtrim( $proposedUser->getToken( false ) ); // correct token
1168 // Make comparison in constant time (bug 61346)
1169 $passwordCorrect = strlen( $token )
1170 && hash_equals( $token, $request->getCookie( 'Token' ) );
1171 $from = 'cookie';
1172 } else {
1173 // No session or persistent login cookie
1174 return false;
1175 }
1176
1177 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1178 $this->loadFromUserObject( $proposedUser );
1179 $request->setSessionData( 'wsToken', $this->mToken );
1180 wfDebug( "User: logged in from $from\n" );
1181 return true;
1182 } else {
1183 // Invalid credentials
1184 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1185 return false;
1186 }
1187 }
1188
1189 /**
1190 * Load user and user_group data from the database.
1191 * $this->mId must be set, this is how the user is identified.
1192 *
1193 * @param integer $flags User::READ_* constant bitfield
1194 * @return bool True if the user exists, false if the user is anonymous
1195 */
1196 public function loadFromDatabase( $flags = self::READ_LATEST ) {
1197 // Paranoia
1198 $this->mId = intval( $this->mId );
1199
1200 // Anonymous user
1201 if ( !$this->mId ) {
1202 $this->loadDefaults();
1203 return false;
1204 }
1205
1206 list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
1207 $db = wfGetDB( $index );
1208
1209 $s = $db->selectRow(
1210 'user',
1211 self::selectFields(),
1212 array( 'user_id' => $this->mId ),
1213 __METHOD__,
1214 $options
1215 );
1216
1217 $this->queryFlagsUsed = $flags;
1218 Hooks::run( 'UserLoadFromDatabase', array( $this, &$s ) );
1219
1220 if ( $s !== false ) {
1221 // Initialise user table data
1222 $this->loadFromRow( $s );
1223 $this->mGroups = null; // deferred
1224 $this->getEditCount(); // revalidation for nulls
1225 return true;
1226 } else {
1227 // Invalid user_id
1228 $this->mId = 0;
1229 $this->loadDefaults();
1230 return false;
1231 }
1232 }
1233
1234 /**
1235 * Initialize this object from a row from the user table.
1236 *
1237 * @param stdClass $row Row from the user table to load.
1238 * @param array $data Further user data to load into the object
1239 *
1240 * user_groups Array with groups out of the user_groups table
1241 * user_properties Array with properties out of the user_properties table
1242 */
1243 protected function loadFromRow( $row, $data = null ) {
1244 $all = true;
1245 $passwordFactory = self::getPasswordFactory();
1246
1247 $this->mGroups = null; // deferred
1248
1249 if ( isset( $row->user_name ) ) {
1250 $this->mName = $row->user_name;
1251 $this->mFrom = 'name';
1252 $this->setItemLoaded( 'name' );
1253 } else {
1254 $all = false;
1255 }
1256
1257 if ( isset( $row->user_real_name ) ) {
1258 $this->mRealName = $row->user_real_name;
1259 $this->setItemLoaded( 'realname' );
1260 } else {
1261 $all = false;
1262 }
1263
1264 if ( isset( $row->user_id ) ) {
1265 $this->mId = intval( $row->user_id );
1266 $this->mFrom = 'id';
1267 $this->setItemLoaded( 'id' );
1268 } else {
1269 $all = false;
1270 }
1271
1272 if ( isset( $row->user_id ) && isset( $row->user_name ) ) {
1273 self::$idCacheByName[$row->user_name] = $row->user_id;
1274 }
1275
1276 if ( isset( $row->user_editcount ) ) {
1277 $this->mEditCount = $row->user_editcount;
1278 } else {
1279 $all = false;
1280 }
1281
1282 if ( isset( $row->user_password ) ) {
1283 // Check for *really* old password hashes that don't even have a type
1284 // The old hash format was just an md5 hex hash, with no type information
1285 if ( preg_match( '/^[0-9a-f]{32}$/', $row->user_password ) ) {
1286 $row->user_password = ":A:{$this->mId}:{$row->user_password}";
1287 }
1288
1289 try {
1290 $this->mPassword = $passwordFactory->newFromCiphertext( $row->user_password );
1291 } catch ( PasswordError $e ) {
1292 wfDebug( 'Invalid password hash found in database.' );
1293 $this->mPassword = $passwordFactory->newFromCiphertext( null );
1294 }
1295
1296 try {
1297 $this->mNewpassword = $passwordFactory->newFromCiphertext( $row->user_newpassword );
1298 } catch ( PasswordError $e ) {
1299 wfDebug( 'Invalid password hash found in database.' );
1300 $this->mNewpassword = $passwordFactory->newFromCiphertext( null );
1301 }
1302
1303 $this->mNewpassTime = wfTimestampOrNull( TS_MW, $row->user_newpass_time );
1304 $this->mPasswordExpires = wfTimestampOrNull( TS_MW, $row->user_password_expires );
1305 }
1306
1307 if ( isset( $row->user_email ) ) {
1308 $this->mEmail = $row->user_email;
1309 $this->mTouched = wfTimestamp( TS_MW, $row->user_touched );
1310 $this->mToken = $row->user_token;
1311 if ( $this->mToken == '' ) {
1312 $this->mToken = null;
1313 }
1314 $this->mEmailAuthenticated = wfTimestampOrNull( TS_MW, $row->user_email_authenticated );
1315 $this->mEmailToken = $row->user_email_token;
1316 $this->mEmailTokenExpires = wfTimestampOrNull( TS_MW, $row->user_email_token_expires );
1317 $this->mRegistration = wfTimestampOrNull( TS_MW, $row->user_registration );
1318 } else {
1319 $all = false;
1320 }
1321
1322 if ( $all ) {
1323 $this->mLoadedItems = true;
1324 }
1325
1326 if ( is_array( $data ) ) {
1327 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1328 $this->mGroups = $data['user_groups'];
1329 }
1330 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1331 $this->loadOptions( $data['user_properties'] );
1332 }
1333 }
1334 }
1335
1336 /**
1337 * Load the data for this user object from another user object.
1338 *
1339 * @param User $user
1340 */
1341 protected function loadFromUserObject( $user ) {
1342 $user->load();
1343 $user->loadGroups();
1344 $user->loadOptions();
1345 foreach ( self::$mCacheVars as $var ) {
1346 $this->$var = $user->$var;
1347 }
1348 }
1349
1350 /**
1351 * Load the groups from the database if they aren't already loaded.
1352 */
1353 private function loadGroups() {
1354 if ( is_null( $this->mGroups ) ) {
1355 $db = ( $this->queryFlagsUsed & self::READ_LATEST )
1356 ? wfGetDB( DB_MASTER )
1357 : wfGetDB( DB_SLAVE );
1358 $res = $db->select( 'user_groups',
1359 array( 'ug_group' ),
1360 array( 'ug_user' => $this->mId ),
1361 __METHOD__ );
1362 $this->mGroups = array();
1363 foreach ( $res as $row ) {
1364 $this->mGroups[] = $row->ug_group;
1365 }
1366 }
1367 }
1368
1369 /**
1370 * Load the user's password hashes from the database
1371 *
1372 * This is usually called in a scenario where the actual User object was
1373 * loaded from the cache, and then password comparison needs to be performed.
1374 * Password hashes are not stored in memcached.
1375 *
1376 * @since 1.24
1377 */
1378 private function loadPasswords() {
1379 if ( $this->getId() !== 0 &&
1380 ( $this->mPassword === null || $this->mNewpassword === null )
1381 ) {
1382 $db = ( $this->queryFlagsUsed & self::READ_LATEST )
1383 ? wfGetDB( DB_MASTER )
1384 : wfGetDB( DB_SLAVE );
1385
1386 $this->loadFromRow( $db->selectRow(
1387 'user',
1388 array( 'user_password', 'user_newpassword',
1389 'user_newpass_time', 'user_password_expires' ),
1390 array( 'user_id' => $this->getId() ),
1391 __METHOD__
1392 ) );
1393 }
1394 }
1395
1396 /**
1397 * Add the user to the group if he/she meets given criteria.
1398 *
1399 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1400 * possible to remove manually via Special:UserRights. In such case it
1401 * will not be re-added automatically. The user will also not lose the
1402 * group if they no longer meet the criteria.
1403 *
1404 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1405 *
1406 * @return array Array of groups the user has been promoted to.
1407 *
1408 * @see $wgAutopromoteOnce
1409 */
1410 public function addAutopromoteOnceGroups( $event ) {
1411 global $wgAutopromoteOnceLogInRC, $wgAuth;
1412
1413 if ( wfReadOnly() || !$this->getId() ) {
1414 return array();
1415 }
1416
1417 $toPromote = Autopromote::getAutopromoteOnceGroups( $this, $event );
1418 if ( !count( $toPromote ) ) {
1419 return array();
1420 }
1421
1422 if ( !$this->checkAndSetTouched() ) {
1423 return array(); // raced out (bug T48834)
1424 }
1425
1426 $oldGroups = $this->getGroups(); // previous groups
1427 foreach ( $toPromote as $group ) {
1428 $this->addGroup( $group );
1429 }
1430 // update groups in external authentication database
1431 Hooks::run( 'UserGroupsChanged', array( $this, $toPromote, array(), false ) );
1432 $wgAuth->updateExternalDBGroups( $this, $toPromote );
1433
1434 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1435
1436 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1437 $logEntry->setPerformer( $this );
1438 $logEntry->setTarget( $this->getUserPage() );
1439 $logEntry->setParameters( array(
1440 '4::oldgroups' => $oldGroups,
1441 '5::newgroups' => $newGroups,
1442 ) );
1443 $logid = $logEntry->insert();
1444 if ( $wgAutopromoteOnceLogInRC ) {
1445 $logEntry->publish( $logid );
1446 }
1447
1448 return $toPromote;
1449 }
1450
1451 /**
1452 * Bump user_touched if it didn't change since this object was loaded
1453 *
1454 * On success, the mTouched field is updated.
1455 * The user serialization cache is always cleared.
1456 *
1457 * @return bool Whether user_touched was actually updated
1458 * @since 1.26
1459 */
1460 protected function checkAndSetTouched() {
1461 $this->load();
1462
1463 if ( !$this->mId ) {
1464 return false; // anon
1465 }
1466
1467 // Get a new user_touched that is higher than the old one
1468 $oldTouched = $this->mTouched;
1469 $newTouched = $this->newTouchedTimestamp();
1470
1471 $dbw = wfGetDB( DB_MASTER );
1472 $dbw->update( 'user',
1473 array( 'user_touched' => $dbw->timestamp( $newTouched ) ),
1474 array(
1475 'user_id' => $this->mId,
1476 'user_touched' => $dbw->timestamp( $oldTouched ) // CAS check
1477 ),
1478 __METHOD__
1479 );
1480 $success = ( $dbw->affectedRows() > 0 );
1481
1482 if ( $success ) {
1483 $this->mTouched = $newTouched;
1484 $this->clearSharedCache();
1485 } else {
1486 // Clears on failure too since that is desired if the cache is stale
1487 $this->clearSharedCache( 'refresh' );
1488 }
1489
1490 return $success;
1491 }
1492
1493 /**
1494 * Clear various cached data stored in this object. The cache of the user table
1495 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1496 *
1497 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1498 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1499 */
1500 public function clearInstanceCache( $reloadFrom = false ) {
1501 $this->mNewtalk = -1;
1502 $this->mDatePreference = null;
1503 $this->mBlockedby = -1; # Unset
1504 $this->mHash = false;
1505 $this->mRights = null;
1506 $this->mEffectiveGroups = null;
1507 $this->mImplicitGroups = null;
1508 $this->mGroups = null;
1509 $this->mOptions = null;
1510 $this->mOptionsLoaded = false;
1511 $this->mEditCount = null;
1512
1513 if ( $reloadFrom ) {
1514 $this->mLoadedItems = array();
1515 $this->mFrom = $reloadFrom;
1516 }
1517 }
1518
1519 /**
1520 * Combine the language default options with any site-specific options
1521 * and add the default language variants.
1522 *
1523 * @return array Array of String options
1524 */
1525 public static function getDefaultOptions() {
1526 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1527
1528 static $defOpt = null;
1529 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1530 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1531 // mid-request and see that change reflected in the return value of this function.
1532 // Which is insane and would never happen during normal MW operation
1533 return $defOpt;
1534 }
1535
1536 $defOpt = $wgDefaultUserOptions;
1537 // Default language setting
1538 $defOpt['language'] = $wgContLang->getCode();
1539 foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
1540 $defOpt[$langCode == $wgContLang->getCode() ? 'variant' : "variant-$langCode"] = $langCode;
1541 }
1542 foreach ( SearchEngine::searchableNamespaces() as $nsnum => $nsname ) {
1543 $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1544 }
1545 $defOpt['skin'] = Skin::normalizeKey( $wgDefaultSkin );
1546
1547 Hooks::run( 'UserGetDefaultOptions', array( &$defOpt ) );
1548
1549 return $defOpt;
1550 }
1551
1552 /**
1553 * Get a given default option value.
1554 *
1555 * @param string $opt Name of option to retrieve
1556 * @return string Default option value
1557 */
1558 public static function getDefaultOption( $opt ) {
1559 $defOpts = self::getDefaultOptions();
1560 if ( isset( $defOpts[$opt] ) ) {
1561 return $defOpts[$opt];
1562 } else {
1563 return null;
1564 }
1565 }
1566
1567 /**
1568 * Get blocking information
1569 * @param bool $bFromSlave Whether to check the slave database first.
1570 * To improve performance, non-critical checks are done against slaves.
1571 * Check when actually saving should be done against master.
1572 */
1573 private function getBlockedStatus( $bFromSlave = true ) {
1574 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1575
1576 if ( -1 != $this->mBlockedby ) {
1577 return;
1578 }
1579
1580 wfDebug( __METHOD__ . ": checking...\n" );
1581
1582 // Initialize data...
1583 // Otherwise something ends up stomping on $this->mBlockedby when
1584 // things get lazy-loaded later, causing false positive block hits
1585 // due to -1 !== 0. Probably session-related... Nothing should be
1586 // overwriting mBlockedby, surely?
1587 $this->load();
1588
1589 # We only need to worry about passing the IP address to the Block generator if the
1590 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1591 # know which IP address they're actually coming from
1592 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->equals( $wgUser ) ) {
1593 $ip = $this->getRequest()->getIP();
1594 } else {
1595 $ip = null;
1596 }
1597
1598 // User/IP blocking
1599 $block = Block::newFromTarget( $this, $ip, !$bFromSlave );
1600
1601 // Proxy blocking
1602 if ( !$block instanceof Block && $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1603 && !in_array( $ip, $wgProxyWhitelist )
1604 ) {
1605 // Local list
1606 if ( self::isLocallyBlockedProxy( $ip ) ) {
1607 $block = new Block;
1608 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1609 $block->mReason = wfMessage( 'proxyblockreason' )->text();
1610 $block->setTarget( $ip );
1611 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1612 $block = new Block;
1613 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1614 $block->mReason = wfMessage( 'sorbsreason' )->text();
1615 $block->setTarget( $ip );
1616 }
1617 }
1618
1619 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1620 if ( !$block instanceof Block
1621 && $wgApplyIpBlocksToXff
1622 && $ip !== null
1623 && !$this->isAllowed( 'proxyunbannable' )
1624 && !in_array( $ip, $wgProxyWhitelist )
1625 ) {
1626 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1627 $xff = array_map( 'trim', explode( ',', $xff ) );
1628 $xff = array_diff( $xff, array( $ip ) );
1629 $xffblocks = Block::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1630 $block = Block::chooseBlock( $xffblocks, $xff );
1631 if ( $block instanceof Block ) {
1632 # Mangle the reason to alert the user that the block
1633 # originated from matching the X-Forwarded-For header.
1634 $block->mReason = wfMessage( 'xffblockreason', $block->mReason )->text();
1635 }
1636 }
1637
1638 if ( $block instanceof Block ) {
1639 wfDebug( __METHOD__ . ": Found block.\n" );
1640 $this->mBlock = $block;
1641 $this->mBlockedby = $block->getByName();
1642 $this->mBlockreason = $block->mReason;
1643 $this->mHideName = $block->mHideName;
1644 $this->mAllowUsertalk = !$block->prevents( 'editownusertalk' );
1645 } else {
1646 $this->mBlockedby = '';
1647 $this->mHideName = 0;
1648 $this->mAllowUsertalk = false;
1649 }
1650
1651 // Extensions
1652 Hooks::run( 'GetBlockedStatus', array( &$this ) );
1653
1654 }
1655
1656 /**
1657 * Whether the given IP is in a DNS blacklist.
1658 *
1659 * @param string $ip IP to check
1660 * @param bool $checkWhitelist Whether to check the whitelist first
1661 * @return bool True if blacklisted.
1662 */
1663 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1664 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1665
1666 if ( !$wgEnableDnsBlacklist ) {
1667 return false;
1668 }
1669
1670 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1671 return false;
1672 }
1673
1674 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1675 }
1676
1677 /**
1678 * Whether the given IP is in a given DNS blacklist.
1679 *
1680 * @param string $ip IP to check
1681 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1682 * @return bool True if blacklisted.
1683 */
1684 public function inDnsBlacklist( $ip, $bases ) {
1685
1686 $found = false;
1687 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1688 if ( IP::isIPv4( $ip ) ) {
1689 // Reverse IP, bug 21255
1690 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1691
1692 foreach ( (array)$bases as $base ) {
1693 // Make hostname
1694 // If we have an access key, use that too (ProjectHoneypot, etc.)
1695 $basename = $base;
1696 if ( is_array( $base ) ) {
1697 if ( count( $base ) >= 2 ) {
1698 // Access key is 1, base URL is 0
1699 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1700 } else {
1701 $host = "$ipReversed.{$base[0]}";
1702 }
1703 $basename = $base[0];
1704 } else {
1705 $host = "$ipReversed.$base";
1706 }
1707
1708 // Send query
1709 $ipList = gethostbynamel( $host );
1710
1711 if ( $ipList ) {
1712 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1713 $found = true;
1714 break;
1715 } else {
1716 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1717 }
1718 }
1719 }
1720
1721 return $found;
1722 }
1723
1724 /**
1725 * Check if an IP address is in the local proxy list
1726 *
1727 * @param string $ip
1728 *
1729 * @return bool
1730 */
1731 public static function isLocallyBlockedProxy( $ip ) {
1732 global $wgProxyList;
1733
1734 if ( !$wgProxyList ) {
1735 return false;
1736 }
1737
1738 if ( !is_array( $wgProxyList ) ) {
1739 // Load from the specified file
1740 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1741 }
1742
1743 if ( !is_array( $wgProxyList ) ) {
1744 $ret = false;
1745 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1746 $ret = true;
1747 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1748 // Old-style flipped proxy list
1749 $ret = true;
1750 } else {
1751 $ret = false;
1752 }
1753 return $ret;
1754 }
1755
1756 /**
1757 * Is this user subject to rate limiting?
1758 *
1759 * @return bool True if rate limited
1760 */
1761 public function isPingLimitable() {
1762 global $wgRateLimitsExcludedIPs;
1763 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1764 // No other good way currently to disable rate limits
1765 // for specific IPs. :P
1766 // But this is a crappy hack and should die.
1767 return false;
1768 }
1769 return !$this->isAllowed( 'noratelimit' );
1770 }
1771
1772 /**
1773 * Primitive rate limits: enforce maximum actions per time period
1774 * to put a brake on flooding.
1775 *
1776 * The method generates both a generic profiling point and a per action one
1777 * (suffix being "-$action".
1778 *
1779 * @note When using a shared cache like memcached, IP-address
1780 * last-hit counters will be shared across wikis.
1781 *
1782 * @param string $action Action to enforce; 'edit' if unspecified
1783 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1784 * @return bool True if a rate limiter was tripped
1785 */
1786 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1787 // Call the 'PingLimiter' hook
1788 $result = false;
1789 if ( !Hooks::run( 'PingLimiter', array( &$this, $action, &$result, $incrBy ) ) ) {
1790 return $result;
1791 }
1792
1793 global $wgRateLimits;
1794 if ( !isset( $wgRateLimits[$action] ) ) {
1795 return false;
1796 }
1797
1798 // Some groups shouldn't trigger the ping limiter, ever
1799 if ( !$this->isPingLimitable() ) {
1800 return false;
1801 }
1802
1803 global $wgMemc;
1804
1805 $limits = $wgRateLimits[$action];
1806 $keys = array();
1807 $id = $this->getId();
1808 $userLimit = false;
1809
1810 if ( isset( $limits['anon'] ) && $id == 0 ) {
1811 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1812 }
1813
1814 if ( isset( $limits['user'] ) && $id != 0 ) {
1815 $userLimit = $limits['user'];
1816 }
1817 if ( $this->isNewbie() ) {
1818 if ( isset( $limits['newbie'] ) && $id != 0 ) {
1819 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1820 }
1821 if ( isset( $limits['ip'] ) ) {
1822 $ip = $this->getRequest()->getIP();
1823 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1824 }
1825 if ( isset( $limits['subnet'] ) ) {
1826 $ip = $this->getRequest()->getIP();
1827 $matches = array();
1828 $subnet = false;
1829 if ( IP::isIPv6( $ip ) ) {
1830 $parts = IP::parseRange( "$ip/64" );
1831 $subnet = $parts[0];
1832 } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1833 // IPv4
1834 $subnet = $matches[1];
1835 }
1836 if ( $subnet !== false ) {
1837 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1838 }
1839 }
1840 }
1841 // Check for group-specific permissions
1842 // If more than one group applies, use the group with the highest limit
1843 foreach ( $this->getGroups() as $group ) {
1844 if ( isset( $limits[$group] ) ) {
1845 if ( $userLimit === false
1846 || $limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1847 ) {
1848 $userLimit = $limits[$group];
1849 }
1850 }
1851 }
1852 // Set the user limit key
1853 if ( $userLimit !== false ) {
1854 list( $max, $period ) = $userLimit;
1855 wfDebug( __METHOD__ . ": effective user limit: $max in {$period}s\n" );
1856 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1857 }
1858
1859 $triggered = false;
1860 foreach ( $keys as $key => $limit ) {
1861 list( $max, $period ) = $limit;
1862 $summary = "(limit $max in {$period}s)";
1863 $count = $wgMemc->get( $key );
1864 // Already pinged?
1865 if ( $count ) {
1866 if ( $count >= $max ) {
1867 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1868 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1869 $triggered = true;
1870 } else {
1871 wfDebug( __METHOD__ . ": ok. $key at $count $summary\n" );
1872 }
1873 } else {
1874 wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
1875 if ( $incrBy > 0 ) {
1876 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1877 }
1878 }
1879 if ( $incrBy > 0 ) {
1880 $wgMemc->incr( $key, $incrBy );
1881 }
1882 }
1883
1884 return $triggered;
1885 }
1886
1887 /**
1888 * Check if user is blocked
1889 *
1890 * @param bool $bFromSlave Whether to check the slave database instead of
1891 * the master. Hacked from false due to horrible probs on site.
1892 * @return bool True if blocked, false otherwise
1893 */
1894 public function isBlocked( $bFromSlave = true ) {
1895 return $this->getBlock( $bFromSlave ) instanceof Block && $this->getBlock()->prevents( 'edit' );
1896 }
1897
1898 /**
1899 * Get the block affecting the user, or null if the user is not blocked
1900 *
1901 * @param bool $bFromSlave Whether to check the slave database instead of the master
1902 * @return Block|null
1903 */
1904 public function getBlock( $bFromSlave = true ) {
1905 $this->getBlockedStatus( $bFromSlave );
1906 return $this->mBlock instanceof Block ? $this->mBlock : null;
1907 }
1908
1909 /**
1910 * Check if user is blocked from editing a particular article
1911 *
1912 * @param Title $title Title to check
1913 * @param bool $bFromSlave Whether to check the slave database instead of the master
1914 * @return bool
1915 */
1916 public function isBlockedFrom( $title, $bFromSlave = false ) {
1917 global $wgBlockAllowsUTEdit;
1918
1919 $blocked = $this->isBlocked( $bFromSlave );
1920 $allowUsertalk = ( $wgBlockAllowsUTEdit ? $this->mAllowUsertalk : false );
1921 // If a user's name is suppressed, they cannot make edits anywhere
1922 if ( !$this->mHideName && $allowUsertalk && $title->getText() === $this->getName()
1923 && $title->getNamespace() == NS_USER_TALK ) {
1924 $blocked = false;
1925 wfDebug( __METHOD__ . ": self-talk page, ignoring any blocks\n" );
1926 }
1927
1928 Hooks::run( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1929
1930 return $blocked;
1931 }
1932
1933 /**
1934 * If user is blocked, return the name of the user who placed the block
1935 * @return string Name of blocker
1936 */
1937 public function blockedBy() {
1938 $this->getBlockedStatus();
1939 return $this->mBlockedby;
1940 }
1941
1942 /**
1943 * If user is blocked, return the specified reason for the block
1944 * @return string Blocking reason
1945 */
1946 public function blockedFor() {
1947 $this->getBlockedStatus();
1948 return $this->mBlockreason;
1949 }
1950
1951 /**
1952 * If user is blocked, return the ID for the block
1953 * @return int Block ID
1954 */
1955 public function getBlockId() {
1956 $this->getBlockedStatus();
1957 return ( $this->mBlock ? $this->mBlock->getId() : false );
1958 }
1959
1960 /**
1961 * Check if user is blocked on all wikis.
1962 * Do not use for actual edit permission checks!
1963 * This is intended for quick UI checks.
1964 *
1965 * @param string $ip IP address, uses current client if none given
1966 * @return bool True if blocked, false otherwise
1967 */
1968 public function isBlockedGlobally( $ip = '' ) {
1969 if ( $this->mBlockedGlobally !== null ) {
1970 return $this->mBlockedGlobally;
1971 }
1972 // User is already an IP?
1973 if ( IP::isIPAddress( $this->getName() ) ) {
1974 $ip = $this->getName();
1975 } elseif ( !$ip ) {
1976 $ip = $this->getRequest()->getIP();
1977 }
1978 $blocked = false;
1979 Hooks::run( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1980 $this->mBlockedGlobally = (bool)$blocked;
1981 return $this->mBlockedGlobally;
1982 }
1983
1984 /**
1985 * Check if user account is locked
1986 *
1987 * @return bool True if locked, false otherwise
1988 */
1989 public function isLocked() {
1990 if ( $this->mLocked !== null ) {
1991 return $this->mLocked;
1992 }
1993 global $wgAuth;
1994 $authUser = $wgAuth->getUserInstance( $this );
1995 $this->mLocked = (bool)$authUser->isLocked();
1996 Hooks::run( 'UserIsLocked', array( $this, &$this->mLocked ) );
1997 return $this->mLocked;
1998 }
1999
2000 /**
2001 * Check if user account is hidden
2002 *
2003 * @return bool True if hidden, false otherwise
2004 */
2005 public function isHidden() {
2006 if ( $this->mHideName !== null ) {
2007 return $this->mHideName;
2008 }
2009 $this->getBlockedStatus();
2010 if ( !$this->mHideName ) {
2011 global $wgAuth;
2012 $authUser = $wgAuth->getUserInstance( $this );
2013 $this->mHideName = (bool)$authUser->isHidden();
2014 Hooks::run( 'UserIsHidden', array( $this, &$this->mHideName ) );
2015 }
2016 return $this->mHideName;
2017 }
2018
2019 /**
2020 * Get the user's ID.
2021 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2022 */
2023 public function getId() {
2024 if ( $this->mId === null && $this->mName !== null && User::isIP( $this->mName ) ) {
2025 // Special case, we know the user is anonymous
2026 return 0;
2027 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2028 // Don't load if this was initialized from an ID
2029 $this->load();
2030 }
2031 return $this->mId;
2032 }
2033
2034 /**
2035 * Set the user and reload all fields according to a given ID
2036 * @param int $v User ID to reload
2037 */
2038 public function setId( $v ) {
2039 $this->mId = $v;
2040 $this->clearInstanceCache( 'id' );
2041 }
2042
2043 /**
2044 * Get the user name, or the IP of an anonymous user
2045 * @return string User's name or IP address
2046 */
2047 public function getName() {
2048 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2049 // Special case optimisation
2050 return $this->mName;
2051 } else {
2052 $this->load();
2053 if ( $this->mName === false ) {
2054 // Clean up IPs
2055 $this->mName = IP::sanitizeIP( $this->getRequest()->getIP() );
2056 }
2057 return $this->mName;
2058 }
2059 }
2060
2061 /**
2062 * Set the user name.
2063 *
2064 * This does not reload fields from the database according to the given
2065 * name. Rather, it is used to create a temporary "nonexistent user" for
2066 * later addition to the database. It can also be used to set the IP
2067 * address for an anonymous user to something other than the current
2068 * remote IP.
2069 *
2070 * @note User::newFromName() has roughly the same function, when the named user
2071 * does not exist.
2072 * @param string $str New user name to set
2073 */
2074 public function setName( $str ) {
2075 $this->load();
2076 $this->mName = $str;
2077 }
2078
2079 /**
2080 * Get the user's name escaped by underscores.
2081 * @return string Username escaped by underscores.
2082 */
2083 public function getTitleKey() {
2084 return str_replace( ' ', '_', $this->getName() );
2085 }
2086
2087 /**
2088 * Check if the user has new messages.
2089 * @return bool True if the user has new messages
2090 */
2091 public function getNewtalk() {
2092 $this->load();
2093
2094 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2095 if ( $this->mNewtalk === -1 ) {
2096 $this->mNewtalk = false; # reset talk page status
2097
2098 // Check memcached separately for anons, who have no
2099 // entire User object stored in there.
2100 if ( !$this->mId ) {
2101 global $wgDisableAnonTalk;
2102 if ( $wgDisableAnonTalk ) {
2103 // Anon newtalk disabled by configuration.
2104 $this->mNewtalk = false;
2105 } else {
2106 $this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName() );
2107 }
2108 } else {
2109 $this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
2110 }
2111 }
2112
2113 return (bool)$this->mNewtalk;
2114 }
2115
2116 /**
2117 * Return the data needed to construct links for new talk page message
2118 * alerts. If there are new messages, this will return an associative array
2119 * with the following data:
2120 * wiki: The database name of the wiki
2121 * link: Root-relative link to the user's talk page
2122 * rev: The last talk page revision that the user has seen or null. This
2123 * is useful for building diff links.
2124 * If there are no new messages, it returns an empty array.
2125 * @note This function was designed to accomodate multiple talk pages, but
2126 * currently only returns a single link and revision.
2127 * @return array
2128 */
2129 public function getNewMessageLinks() {
2130 $talks = array();
2131 if ( !Hooks::run( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
2132 return $talks;
2133 } elseif ( !$this->getNewtalk() ) {
2134 return array();
2135 }
2136 $utp = $this->getTalkPage();
2137 $dbr = wfGetDB( DB_SLAVE );
2138 // Get the "last viewed rev" timestamp from the oldest message notification
2139 $timestamp = $dbr->selectField( 'user_newtalk',
2140 'MIN(user_last_timestamp)',
2141 $this->isAnon() ? array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
2142 __METHOD__ );
2143 $rev = $timestamp ? Revision::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2144 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
2145 }
2146
2147 /**
2148 * Get the revision ID for the last talk page revision viewed by the talk
2149 * page owner.
2150 * @return int|null Revision ID or null
2151 */
2152 public function getNewMessageRevisionId() {
2153 $newMessageRevisionId = null;
2154 $newMessageLinks = $this->getNewMessageLinks();
2155 if ( $newMessageLinks ) {
2156 // Note: getNewMessageLinks() never returns more than a single link
2157 // and it is always for the same wiki, but we double-check here in
2158 // case that changes some time in the future.
2159 if ( count( $newMessageLinks ) === 1
2160 && $newMessageLinks[0]['wiki'] === wfWikiID()
2161 && $newMessageLinks[0]['rev']
2162 ) {
2163 /** @var Revision $newMessageRevision */
2164 $newMessageRevision = $newMessageLinks[0]['rev'];
2165 $newMessageRevisionId = $newMessageRevision->getId();
2166 }
2167 }
2168 return $newMessageRevisionId;
2169 }
2170
2171 /**
2172 * Internal uncached check for new messages
2173 *
2174 * @see getNewtalk()
2175 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2176 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2177 * @return bool True if the user has new messages
2178 */
2179 protected function checkNewtalk( $field, $id ) {
2180 $dbr = wfGetDB( DB_SLAVE );
2181
2182 $ok = $dbr->selectField( 'user_newtalk', $field, array( $field => $id ), __METHOD__ );
2183
2184 return $ok !== false;
2185 }
2186
2187 /**
2188 * Add or update the new messages flag
2189 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2190 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2191 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2192 * @return bool True if successful, false otherwise
2193 */
2194 protected function updateNewtalk( $field, $id, $curRev = null ) {
2195 // Get timestamp of the talk page revision prior to the current one
2196 $prevRev = $curRev ? $curRev->getPrevious() : false;
2197 $ts = $prevRev ? $prevRev->getTimestamp() : null;
2198 // Mark the user as having new messages since this revision
2199 $dbw = wfGetDB( DB_MASTER );
2200 $dbw->insert( 'user_newtalk',
2201 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
2202 __METHOD__,
2203 'IGNORE' );
2204 if ( $dbw->affectedRows() ) {
2205 wfDebug( __METHOD__ . ": set on ($field, $id)\n" );
2206 return true;
2207 } else {
2208 wfDebug( __METHOD__ . " already set ($field, $id)\n" );
2209 return false;
2210 }
2211 }
2212
2213 /**
2214 * Clear the new messages flag for the given user
2215 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2216 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2217 * @return bool True if successful, false otherwise
2218 */
2219 protected function deleteNewtalk( $field, $id ) {
2220 $dbw = wfGetDB( DB_MASTER );
2221 $dbw->delete( 'user_newtalk',
2222 array( $field => $id ),
2223 __METHOD__ );
2224 if ( $dbw->affectedRows() ) {
2225 wfDebug( __METHOD__ . ": killed on ($field, $id)\n" );
2226 return true;
2227 } else {
2228 wfDebug( __METHOD__ . ": already gone ($field, $id)\n" );
2229 return false;
2230 }
2231 }
2232
2233 /**
2234 * Update the 'You have new messages!' status.
2235 * @param bool $val Whether the user has new messages
2236 * @param Revision $curRev New, as yet unseen revision of the user talk
2237 * page. Ignored if null or !$val.
2238 */
2239 public function setNewtalk( $val, $curRev = null ) {
2240 if ( wfReadOnly() ) {
2241 return;
2242 }
2243
2244 $this->load();
2245 $this->mNewtalk = $val;
2246
2247 if ( $this->isAnon() ) {
2248 $field = 'user_ip';
2249 $id = $this->getName();
2250 } else {
2251 $field = 'user_id';
2252 $id = $this->getId();
2253 }
2254
2255 if ( $val ) {
2256 $changed = $this->updateNewtalk( $field, $id, $curRev );
2257 } else {
2258 $changed = $this->deleteNewtalk( $field, $id );
2259 }
2260
2261 if ( $changed ) {
2262 $this->invalidateCache();
2263 }
2264 }
2265
2266 /**
2267 * Generate a current or new-future timestamp to be stored in the
2268 * user_touched field when we update things.
2269 * @return string Timestamp in TS_MW format
2270 */
2271 private function newTouchedTimestamp() {
2272 global $wgClockSkewFudge;
2273
2274 $time = wfTimestamp( TS_MW, time() + $wgClockSkewFudge );
2275 if ( $this->mTouched && $time <= $this->mTouched ) {
2276 $time = wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $this->mTouched ) + 1 );
2277 }
2278
2279 return $time;
2280 }
2281
2282 /**
2283 * Clear user data from memcached
2284 *
2285 * Use after applying updates to the database; caller's
2286 * responsibility to update user_touched if appropriate.
2287 *
2288 * Called implicitly from invalidateCache() and saveSettings().
2289 *
2290 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2291 */
2292 public function clearSharedCache( $mode = 'changed' ) {
2293 $id = $this->getId();
2294 if ( !$id ) {
2295 return;
2296 }
2297
2298 $key = wfMemcKey( 'user', 'id', $id );
2299 if ( $mode === 'refresh' ) {
2300 ObjectCache::getMainWANInstance()->delete( $key, 1 );
2301 } else {
2302 wfGetDB( DB_MASTER )->onTransactionPreCommitOrIdle( function() use ( $key ) {
2303 ObjectCache::getMainWANInstance()->delete( $key );
2304 } );
2305 }
2306 }
2307
2308 /**
2309 * Immediately touch the user data cache for this account
2310 *
2311 * Calls touch() and removes account data from memcached
2312 */
2313 public function invalidateCache() {
2314 $this->touch();
2315 $this->clearSharedCache();
2316 }
2317
2318 /**
2319 * Update the "touched" timestamp for the user
2320 *
2321 * This is useful on various login/logout events when making sure that
2322 * a browser or proxy that has multiple tenants does not suffer cache
2323 * pollution where the new user sees the old users content. The value
2324 * of getTouched() is checked when determining 304 vs 200 responses.
2325 * Unlike invalidateCache(), this preserves the User object cache and
2326 * avoids database writes.
2327 *
2328 * @since 1.25
2329 */
2330 public function touch() {
2331 $id = $this->getId();
2332 if ( $id ) {
2333 $key = wfMemcKey( 'user-quicktouched', 'id', $id );
2334 ObjectCache::getMainWANInstance()->touchCheckKey( $key );
2335 $this->mQuickTouched = null;
2336 }
2337 }
2338
2339 /**
2340 * Validate the cache for this account.
2341 * @param string $timestamp A timestamp in TS_MW format
2342 * @return bool
2343 */
2344 public function validateCache( $timestamp ) {
2345 return ( $timestamp >= $this->getTouched() );
2346 }
2347
2348 /**
2349 * Get the user touched timestamp
2350 *
2351 * Use this value only to validate caches via inequalities
2352 * such as in the case of HTTP If-Modified-Since response logic
2353 *
2354 * @return string TS_MW Timestamp
2355 */
2356 public function getTouched() {
2357 $this->load();
2358
2359 if ( $this->mId ) {
2360 if ( $this->mQuickTouched === null ) {
2361 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId );
2362 $cache = ObjectCache::getMainWANInstance();
2363
2364 $this->mQuickTouched = wfTimestamp( TS_MW, $cache->getCheckKeyTime( $key ) );
2365 }
2366
2367 return max( $this->mTouched, $this->mQuickTouched );
2368 }
2369
2370 return $this->mTouched;
2371 }
2372
2373 /**
2374 * Get the user_touched timestamp field (time of last DB updates)
2375 * @return string TS_MW Timestamp
2376 * @since 1.26
2377 */
2378 public function getDBTouched() {
2379 $this->load();
2380
2381 return $this->mTouched;
2382 }
2383
2384 /**
2385 * @return Password
2386 * @since 1.24
2387 */
2388 public function getPassword() {
2389 $this->loadPasswords();
2390
2391 return $this->mPassword;
2392 }
2393
2394 /**
2395 * @return Password
2396 * @since 1.24
2397 */
2398 public function getTemporaryPassword() {
2399 $this->loadPasswords();
2400
2401 return $this->mNewpassword;
2402 }
2403
2404 /**
2405 * Set the password and reset the random token.
2406 * Calls through to authentication plugin if necessary;
2407 * will have no effect if the auth plugin refuses to
2408 * pass the change through or if the legal password
2409 * checks fail.
2410 *
2411 * As a special case, setting the password to null
2412 * wipes it, so the account cannot be logged in until
2413 * a new password is set, for instance via e-mail.
2414 *
2415 * @param string $str New password to set
2416 * @throws PasswordError On failure
2417 *
2418 * @return bool
2419 */
2420 public function setPassword( $str ) {
2421 global $wgAuth;
2422
2423 $this->loadPasswords();
2424
2425 if ( $str !== null ) {
2426 if ( !$wgAuth->allowPasswordChange() ) {
2427 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2428 }
2429
2430 $status = $this->checkPasswordValidity( $str );
2431 if ( !$status->isGood() ) {
2432 throw new PasswordError( $status->getMessage()->text() );
2433 }
2434 }
2435
2436 if ( !$wgAuth->setPassword( $this, $str ) ) {
2437 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2438 }
2439
2440 $this->setInternalPassword( $str );
2441
2442 return true;
2443 }
2444
2445 /**
2446 * Set the password and reset the random token unconditionally.
2447 *
2448 * @param string|null $str New password to set or null to set an invalid
2449 * password hash meaning that the user will not be able to log in
2450 * through the web interface.
2451 */
2452 public function setInternalPassword( $str ) {
2453 $this->setToken();
2454 $this->setOption( 'watchlisttoken', false );
2455
2456 $passwordFactory = self::getPasswordFactory();
2457 $this->mPassword = $passwordFactory->newFromPlaintext( $str );
2458
2459 $this->mNewpassword = $passwordFactory->newFromCiphertext( null );
2460 $this->mNewpassTime = null;
2461 }
2462
2463 /**
2464 * Get the user's current token.
2465 * @param bool $forceCreation Force the generation of a new token if the
2466 * user doesn't have one (default=true for backwards compatibility).
2467 * @return string Token
2468 */
2469 public function getToken( $forceCreation = true ) {
2470 $this->load();
2471 if ( !$this->mToken && $forceCreation ) {
2472 $this->setToken();
2473 }
2474 return $this->mToken;
2475 }
2476
2477 /**
2478 * Set the random token (used for persistent authentication)
2479 * Called from loadDefaults() among other places.
2480 *
2481 * @param string|bool $token If specified, set the token to this value
2482 */
2483 public function setToken( $token = false ) {
2484 $this->load();
2485 if ( !$token ) {
2486 $this->mToken = MWCryptRand::generateHex( self::TOKEN_LENGTH );
2487 } else {
2488 $this->mToken = $token;
2489 }
2490 }
2491
2492 /**
2493 * Set the password for a password reminder or new account email
2494 *
2495 * @param string $str New password to set or null to set an invalid
2496 * password hash meaning that the user will not be able to use it
2497 * @param bool $throttle If true, reset the throttle timestamp to the present
2498 */
2499 public function setNewpassword( $str, $throttle = true ) {
2500 $this->loadPasswords();
2501
2502 $this->mNewpassword = self::getPasswordFactory()->newFromPlaintext( $str );
2503 if ( $str === null ) {
2504 $this->mNewpassTime = null;
2505 } elseif ( $throttle ) {
2506 $this->mNewpassTime = wfTimestampNow();
2507 }
2508 }
2509
2510 /**
2511 * Has password reminder email been sent within the last
2512 * $wgPasswordReminderResendTime hours?
2513 * @return bool
2514 */
2515 public function isPasswordReminderThrottled() {
2516 global $wgPasswordReminderResendTime;
2517 $this->load();
2518 if ( !$this->mNewpassTime || !$wgPasswordReminderResendTime ) {
2519 return false;
2520 }
2521 $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgPasswordReminderResendTime * 3600;
2522 return time() < $expiry;
2523 }
2524
2525 /**
2526 * Get the user's e-mail address
2527 * @return string User's email address
2528 */
2529 public function getEmail() {
2530 $this->load();
2531 Hooks::run( 'UserGetEmail', array( $this, &$this->mEmail ) );
2532 return $this->mEmail;
2533 }
2534
2535 /**
2536 * Get the timestamp of the user's e-mail authentication
2537 * @return string TS_MW timestamp
2538 */
2539 public function getEmailAuthenticationTimestamp() {
2540 $this->load();
2541 Hooks::run( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
2542 return $this->mEmailAuthenticated;
2543 }
2544
2545 /**
2546 * Set the user's e-mail address
2547 * @param string $str New e-mail address
2548 */
2549 public function setEmail( $str ) {
2550 $this->load();
2551 if ( $str == $this->mEmail ) {
2552 return;
2553 }
2554 $this->invalidateEmail();
2555 $this->mEmail = $str;
2556 Hooks::run( 'UserSetEmail', array( $this, &$this->mEmail ) );
2557 }
2558
2559 /**
2560 * Set the user's e-mail address and a confirmation mail if needed.
2561 *
2562 * @since 1.20
2563 * @param string $str New e-mail address
2564 * @return Status
2565 */
2566 public function setEmailWithConfirmation( $str ) {
2567 global $wgEnableEmail, $wgEmailAuthentication;
2568
2569 if ( !$wgEnableEmail ) {
2570 return Status::newFatal( 'emaildisabled' );
2571 }
2572
2573 $oldaddr = $this->getEmail();
2574 if ( $str === $oldaddr ) {
2575 return Status::newGood( true );
2576 }
2577
2578 $this->setEmail( $str );
2579
2580 if ( $str !== '' && $wgEmailAuthentication ) {
2581 // Send a confirmation request to the new address if needed
2582 $type = $oldaddr != '' ? 'changed' : 'set';
2583 $result = $this->sendConfirmationMail( $type );
2584 if ( $result->isGood() ) {
2585 // Say to the caller that a confirmation mail has been sent
2586 $result->value = 'eauth';
2587 }
2588 } else {
2589 $result = Status::newGood( true );
2590 }
2591
2592 return $result;
2593 }
2594
2595 /**
2596 * Get the user's real name
2597 * @return string User's real name
2598 */
2599 public function getRealName() {
2600 if ( !$this->isItemLoaded( 'realname' ) ) {
2601 $this->load();
2602 }
2603
2604 return $this->mRealName;
2605 }
2606
2607 /**
2608 * Set the user's real name
2609 * @param string $str New real name
2610 */
2611 public function setRealName( $str ) {
2612 $this->load();
2613 $this->mRealName = $str;
2614 }
2615
2616 /**
2617 * Get the user's current setting for a given option.
2618 *
2619 * @param string $oname The option to check
2620 * @param string $defaultOverride A default value returned if the option does not exist
2621 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2622 * @return string User's current value for the option
2623 * @see getBoolOption()
2624 * @see getIntOption()
2625 */
2626 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2627 global $wgHiddenPrefs;
2628 $this->loadOptions();
2629
2630 # We want 'disabled' preferences to always behave as the default value for
2631 # users, even if they have set the option explicitly in their settings (ie they
2632 # set it, and then it was disabled removing their ability to change it). But
2633 # we don't want to erase the preferences in the database in case the preference
2634 # is re-enabled again. So don't touch $mOptions, just override the returned value
2635 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2636 return self::getDefaultOption( $oname );
2637 }
2638
2639 if ( array_key_exists( $oname, $this->mOptions ) ) {
2640 return $this->mOptions[$oname];
2641 } else {
2642 return $defaultOverride;
2643 }
2644 }
2645
2646 /**
2647 * Get all user's options
2648 *
2649 * @param int $flags Bitwise combination of:
2650 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2651 * to the default value. (Since 1.25)
2652 * @return array
2653 */
2654 public function getOptions( $flags = 0 ) {
2655 global $wgHiddenPrefs;
2656 $this->loadOptions();
2657 $options = $this->mOptions;
2658
2659 # We want 'disabled' preferences to always behave as the default value for
2660 # users, even if they have set the option explicitly in their settings (ie they
2661 # set it, and then it was disabled removing their ability to change it). But
2662 # we don't want to erase the preferences in the database in case the preference
2663 # is re-enabled again. So don't touch $mOptions, just override the returned value
2664 foreach ( $wgHiddenPrefs as $pref ) {
2665 $default = self::getDefaultOption( $pref );
2666 if ( $default !== null ) {
2667 $options[$pref] = $default;
2668 }
2669 }
2670
2671 if ( $flags & self::GETOPTIONS_EXCLUDE_DEFAULTS ) {
2672 $options = array_diff_assoc( $options, self::getDefaultOptions() );
2673 }
2674
2675 return $options;
2676 }
2677
2678 /**
2679 * Get the user's current setting for a given option, as a boolean value.
2680 *
2681 * @param string $oname The option to check
2682 * @return bool User's current value for the option
2683 * @see getOption()
2684 */
2685 public function getBoolOption( $oname ) {
2686 return (bool)$this->getOption( $oname );
2687 }
2688
2689 /**
2690 * Get the user's current setting for a given option, as an integer value.
2691 *
2692 * @param string $oname The option to check
2693 * @param int $defaultOverride A default value returned if the option does not exist
2694 * @return int User's current value for the option
2695 * @see getOption()
2696 */
2697 public function getIntOption( $oname, $defaultOverride = 0 ) {
2698 $val = $this->getOption( $oname );
2699 if ( $val == '' ) {
2700 $val = $defaultOverride;
2701 }
2702 return intval( $val );
2703 }
2704
2705 /**
2706 * Set the given option for a user.
2707 *
2708 * You need to call saveSettings() to actually write to the database.
2709 *
2710 * @param string $oname The option to set
2711 * @param mixed $val New value to set
2712 */
2713 public function setOption( $oname, $val ) {
2714 $this->loadOptions();
2715
2716 // Explicitly NULL values should refer to defaults
2717 if ( is_null( $val ) ) {
2718 $val = self::getDefaultOption( $oname );
2719 }
2720
2721 $this->mOptions[$oname] = $val;
2722 }
2723
2724 /**
2725 * Get a token stored in the preferences (like the watchlist one),
2726 * resetting it if it's empty (and saving changes).
2727 *
2728 * @param string $oname The option name to retrieve the token from
2729 * @return string|bool User's current value for the option, or false if this option is disabled.
2730 * @see resetTokenFromOption()
2731 * @see getOption()
2732 * @deprecated 1.26 Applications should use the OAuth extension
2733 */
2734 public function getTokenFromOption( $oname ) {
2735 global $wgHiddenPrefs;
2736
2737 $id = $this->getId();
2738 if ( !$id || in_array( $oname, $wgHiddenPrefs ) ) {
2739 return false;
2740 }
2741
2742 $token = $this->getOption( $oname );
2743 if ( !$token ) {
2744 // Default to a value based on the user token to avoid space
2745 // wasted on storing tokens for all users. When this option
2746 // is set manually by the user, only then is it stored.
2747 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
2748 }
2749
2750 return $token;
2751 }
2752
2753 /**
2754 * Reset a token stored in the preferences (like the watchlist one).
2755 * *Does not* save user's preferences (similarly to setOption()).
2756 *
2757 * @param string $oname The option name to reset the token in
2758 * @return string|bool New token value, or false if this option is disabled.
2759 * @see getTokenFromOption()
2760 * @see setOption()
2761 */
2762 public function resetTokenFromOption( $oname ) {
2763 global $wgHiddenPrefs;
2764 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2765 return false;
2766 }
2767
2768 $token = MWCryptRand::generateHex( 40 );
2769 $this->setOption( $oname, $token );
2770 return $token;
2771 }
2772
2773 /**
2774 * Return a list of the types of user options currently returned by
2775 * User::getOptionKinds().
2776 *
2777 * Currently, the option kinds are:
2778 * - 'registered' - preferences which are registered in core MediaWiki or
2779 * by extensions using the UserGetDefaultOptions hook.
2780 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2781 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2782 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2783 * be used by user scripts.
2784 * - 'special' - "preferences" that are not accessible via User::getOptions
2785 * or User::setOptions.
2786 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2787 * These are usually legacy options, removed in newer versions.
2788 *
2789 * The API (and possibly others) use this function to determine the possible
2790 * option types for validation purposes, so make sure to update this when a
2791 * new option kind is added.
2792 *
2793 * @see User::getOptionKinds
2794 * @return array Option kinds
2795 */
2796 public static function listOptionKinds() {
2797 return array(
2798 'registered',
2799 'registered-multiselect',
2800 'registered-checkmatrix',
2801 'userjs',
2802 'special',
2803 'unused'
2804 );
2805 }
2806
2807 /**
2808 * Return an associative array mapping preferences keys to the kind of a preference they're
2809 * used for. Different kinds are handled differently when setting or reading preferences.
2810 *
2811 * See User::listOptionKinds for the list of valid option types that can be provided.
2812 *
2813 * @see User::listOptionKinds
2814 * @param IContextSource $context
2815 * @param array $options Assoc. array with options keys to check as keys.
2816 * Defaults to $this->mOptions.
2817 * @return array The key => kind mapping data
2818 */
2819 public function getOptionKinds( IContextSource $context, $options = null ) {
2820 $this->loadOptions();
2821 if ( $options === null ) {
2822 $options = $this->mOptions;
2823 }
2824
2825 $prefs = Preferences::getPreferences( $this, $context );
2826 $mapping = array();
2827
2828 // Pull out the "special" options, so they don't get converted as
2829 // multiselect or checkmatrix.
2830 $specialOptions = array_fill_keys( Preferences::getSaveBlacklist(), true );
2831 foreach ( $specialOptions as $name => $value ) {
2832 unset( $prefs[$name] );
2833 }
2834
2835 // Multiselect and checkmatrix options are stored in the database with
2836 // one key per option, each having a boolean value. Extract those keys.
2837 $multiselectOptions = array();
2838 foreach ( $prefs as $name => $info ) {
2839 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2840 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2841 $opts = HTMLFormField::flattenOptions( $info['options'] );
2842 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
2843
2844 foreach ( $opts as $value ) {
2845 $multiselectOptions["$prefix$value"] = true;
2846 }
2847
2848 unset( $prefs[$name] );
2849 }
2850 }
2851 $checkmatrixOptions = array();
2852 foreach ( $prefs as $name => $info ) {
2853 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2854 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2855 $columns = HTMLFormField::flattenOptions( $info['columns'] );
2856 $rows = HTMLFormField::flattenOptions( $info['rows'] );
2857 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
2858
2859 foreach ( $columns as $column ) {
2860 foreach ( $rows as $row ) {
2861 $checkmatrixOptions["$prefix$column-$row"] = true;
2862 }
2863 }
2864
2865 unset( $prefs[$name] );
2866 }
2867 }
2868
2869 // $value is ignored
2870 foreach ( $options as $key => $value ) {
2871 if ( isset( $prefs[$key] ) ) {
2872 $mapping[$key] = 'registered';
2873 } elseif ( isset( $multiselectOptions[$key] ) ) {
2874 $mapping[$key] = 'registered-multiselect';
2875 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
2876 $mapping[$key] = 'registered-checkmatrix';
2877 } elseif ( isset( $specialOptions[$key] ) ) {
2878 $mapping[$key] = 'special';
2879 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2880 $mapping[$key] = 'userjs';
2881 } else {
2882 $mapping[$key] = 'unused';
2883 }
2884 }
2885
2886 return $mapping;
2887 }
2888
2889 /**
2890 * Reset certain (or all) options to the site defaults
2891 *
2892 * The optional parameter determines which kinds of preferences will be reset.
2893 * Supported values are everything that can be reported by getOptionKinds()
2894 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2895 *
2896 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
2897 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
2898 * for backwards-compatibility.
2899 * @param IContextSource|null $context Context source used when $resetKinds
2900 * does not contain 'all', passed to getOptionKinds().
2901 * Defaults to RequestContext::getMain() when null.
2902 */
2903 public function resetOptions(
2904 $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ),
2905 IContextSource $context = null
2906 ) {
2907 $this->load();
2908 $defaultOptions = self::getDefaultOptions();
2909
2910 if ( !is_array( $resetKinds ) ) {
2911 $resetKinds = array( $resetKinds );
2912 }
2913
2914 if ( in_array( 'all', $resetKinds ) ) {
2915 $newOptions = $defaultOptions;
2916 } else {
2917 if ( $context === null ) {
2918 $context = RequestContext::getMain();
2919 }
2920
2921 $optionKinds = $this->getOptionKinds( $context );
2922 $resetKinds = array_intersect( $resetKinds, self::listOptionKinds() );
2923 $newOptions = array();
2924
2925 // Use default values for the options that should be deleted, and
2926 // copy old values for the ones that shouldn't.
2927 foreach ( $this->mOptions as $key => $value ) {
2928 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2929 if ( array_key_exists( $key, $defaultOptions ) ) {
2930 $newOptions[$key] = $defaultOptions[$key];
2931 }
2932 } else {
2933 $newOptions[$key] = $value;
2934 }
2935 }
2936 }
2937
2938 Hooks::run( 'UserResetAllOptions', array( $this, &$newOptions, $this->mOptions, $resetKinds ) );
2939
2940 $this->mOptions = $newOptions;
2941 $this->mOptionsLoaded = true;
2942 }
2943
2944 /**
2945 * Get the user's preferred date format.
2946 * @return string User's preferred date format
2947 */
2948 public function getDatePreference() {
2949 // Important migration for old data rows
2950 if ( is_null( $this->mDatePreference ) ) {
2951 global $wgLang;
2952 $value = $this->getOption( 'date' );
2953 $map = $wgLang->getDatePreferenceMigrationMap();
2954 if ( isset( $map[$value] ) ) {
2955 $value = $map[$value];
2956 }
2957 $this->mDatePreference = $value;
2958 }
2959 return $this->mDatePreference;
2960 }
2961
2962 /**
2963 * Determine based on the wiki configuration and the user's options,
2964 * whether this user must be over HTTPS no matter what.
2965 *
2966 * @return bool
2967 */
2968 public function requiresHTTPS() {
2969 global $wgSecureLogin;
2970 if ( !$wgSecureLogin ) {
2971 return false;
2972 } else {
2973 $https = $this->getBoolOption( 'prefershttps' );
2974 Hooks::run( 'UserRequiresHTTPS', array( $this, &$https ) );
2975 if ( $https ) {
2976 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
2977 }
2978 return $https;
2979 }
2980 }
2981
2982 /**
2983 * Get the user preferred stub threshold
2984 *
2985 * @return int
2986 */
2987 public function getStubThreshold() {
2988 global $wgMaxArticleSize; # Maximum article size, in Kb
2989 $threshold = $this->getIntOption( 'stubthreshold' );
2990 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2991 // If they have set an impossible value, disable the preference
2992 // so we can use the parser cache again.
2993 $threshold = 0;
2994 }
2995 return $threshold;
2996 }
2997
2998 /**
2999 * Get the permissions this user has.
3000 * @return array Array of String permission names
3001 */
3002 public function getRights() {
3003 if ( is_null( $this->mRights ) ) {
3004 $this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() );
3005 Hooks::run( 'UserGetRights', array( $this, &$this->mRights ) );
3006 // Force reindexation of rights when a hook has unset one of them
3007 $this->mRights = array_values( array_unique( $this->mRights ) );
3008 }
3009 return $this->mRights;
3010 }
3011
3012 /**
3013 * Get the list of explicit group memberships this user has.
3014 * The implicit * and user groups are not included.
3015 * @return array Array of String internal group names
3016 */
3017 public function getGroups() {
3018 $this->load();
3019 $this->loadGroups();
3020 return $this->mGroups;
3021 }
3022
3023 /**
3024 * Get the list of implicit group memberships this user has.
3025 * This includes all explicit groups, plus 'user' if logged in,
3026 * '*' for all accounts, and autopromoted groups
3027 * @param bool $recache Whether to avoid the cache
3028 * @return array Array of String internal group names
3029 */
3030 public function getEffectiveGroups( $recache = false ) {
3031 if ( $recache || is_null( $this->mEffectiveGroups ) ) {
3032 $this->mEffectiveGroups = array_unique( array_merge(
3033 $this->getGroups(), // explicit groups
3034 $this->getAutomaticGroups( $recache ) // implicit groups
3035 ) );
3036 // Hook for additional groups
3037 Hooks::run( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups ) );
3038 // Force reindexation of groups when a hook has unset one of them
3039 $this->mEffectiveGroups = array_values( array_unique( $this->mEffectiveGroups ) );
3040 }
3041 return $this->mEffectiveGroups;
3042 }
3043
3044 /**
3045 * Get the list of implicit group memberships this user has.
3046 * This includes 'user' if logged in, '*' for all accounts,
3047 * and autopromoted groups
3048 * @param bool $recache Whether to avoid the cache
3049 * @return array Array of String internal group names
3050 */
3051 public function getAutomaticGroups( $recache = false ) {
3052 if ( $recache || is_null( $this->mImplicitGroups ) ) {
3053 $this->mImplicitGroups = array( '*' );
3054 if ( $this->getId() ) {
3055 $this->mImplicitGroups[] = 'user';
3056
3057 $this->mImplicitGroups = array_unique( array_merge(
3058 $this->mImplicitGroups,
3059 Autopromote::getAutopromoteGroups( $this )
3060 ) );
3061 }
3062 if ( $recache ) {
3063 // Assure data consistency with rights/groups,
3064 // as getEffectiveGroups() depends on this function
3065 $this->mEffectiveGroups = null;
3066 }
3067 }
3068 return $this->mImplicitGroups;
3069 }
3070
3071 /**
3072 * Returns the groups the user has belonged to.
3073 *
3074 * The user may still belong to the returned groups. Compare with getGroups().
3075 *
3076 * The function will not return groups the user had belonged to before MW 1.17
3077 *
3078 * @return array Names of the groups the user has belonged to.
3079 */
3080 public function getFormerGroups() {
3081 $this->load();
3082
3083 if ( is_null( $this->mFormerGroups ) ) {
3084 $db = ( $this->queryFlagsUsed & self::READ_LATEST )
3085 ? wfGetDB( DB_MASTER )
3086 : wfGetDB( DB_SLAVE );
3087 $res = $db->select( 'user_former_groups',
3088 array( 'ufg_group' ),
3089 array( 'ufg_user' => $this->mId ),
3090 __METHOD__ );
3091 $this->mFormerGroups = array();
3092 foreach ( $res as $row ) {
3093 $this->mFormerGroups[] = $row->ufg_group;
3094 }
3095 }
3096
3097 return $this->mFormerGroups;
3098 }
3099
3100 /**
3101 * Get the user's edit count.
3102 * @return int|null Null for anonymous users
3103 */
3104 public function getEditCount() {
3105 if ( !$this->getId() ) {
3106 return null;
3107 }
3108
3109 if ( $this->mEditCount === null ) {
3110 /* Populate the count, if it has not been populated yet */
3111 $dbr = wfGetDB( DB_SLAVE );
3112 // check if the user_editcount field has been initialized
3113 $count = $dbr->selectField(
3114 'user', 'user_editcount',
3115 array( 'user_id' => $this->mId ),
3116 __METHOD__
3117 );
3118
3119 if ( $count === null ) {
3120 // it has not been initialized. do so.
3121 $count = $this->initEditCount();
3122 }
3123 $this->mEditCount = $count;
3124 }
3125 return (int)$this->mEditCount;
3126 }
3127
3128 /**
3129 * Add the user to the given group.
3130 * This takes immediate effect.
3131 * @param string $group Name of the group to add
3132 * @return bool
3133 */
3134 public function addGroup( $group ) {
3135 $this->load();
3136
3137 if ( !Hooks::run( 'UserAddGroup', array( $this, &$group ) ) ) {
3138 return false;
3139 }
3140
3141 $dbw = wfGetDB( DB_MASTER );
3142 if ( $this->getId() ) {
3143 $dbw->insert( 'user_groups',
3144 array(
3145 'ug_user' => $this->getID(),
3146 'ug_group' => $group,
3147 ),
3148 __METHOD__,
3149 array( 'IGNORE' ) );
3150 }
3151
3152 $this->loadGroups();
3153 $this->mGroups[] = $group;
3154 // In case loadGroups was not called before, we now have the right twice.
3155 // Get rid of the duplicate.
3156 $this->mGroups = array_unique( $this->mGroups );
3157
3158 // Refresh the groups caches, and clear the rights cache so it will be
3159 // refreshed on the next call to $this->getRights().
3160 $this->getEffectiveGroups( true );
3161 $this->mRights = null;
3162
3163 $this->invalidateCache();
3164
3165 return true;
3166 }
3167
3168 /**
3169 * Remove the user from the given group.
3170 * This takes immediate effect.
3171 * @param string $group Name of the group to remove
3172 * @return bool
3173 */
3174 public function removeGroup( $group ) {
3175 $this->load();
3176 if ( !Hooks::run( 'UserRemoveGroup', array( $this, &$group ) ) ) {
3177 return false;
3178 }
3179
3180 $dbw = wfGetDB( DB_MASTER );
3181 $dbw->delete( 'user_groups',
3182 array(
3183 'ug_user' => $this->getID(),
3184 'ug_group' => $group,
3185 ), __METHOD__
3186 );
3187 // Remember that the user was in this group
3188 $dbw->insert( 'user_former_groups',
3189 array(
3190 'ufg_user' => $this->getID(),
3191 'ufg_group' => $group,
3192 ),
3193 __METHOD__,
3194 array( 'IGNORE' )
3195 );
3196
3197 $this->loadGroups();
3198 $this->mGroups = array_diff( $this->mGroups, array( $group ) );
3199
3200 // Refresh the groups caches, and clear the rights cache so it will be
3201 // refreshed on the next call to $this->getRights().
3202 $this->getEffectiveGroups( true );
3203 $this->mRights = null;
3204
3205 $this->invalidateCache();
3206
3207 return true;
3208 }
3209
3210 /**
3211 * Get whether the user is logged in
3212 * @return bool
3213 */
3214 public function isLoggedIn() {
3215 return $this->getID() != 0;
3216 }
3217
3218 /**
3219 * Get whether the user is anonymous
3220 * @return bool
3221 */
3222 public function isAnon() {
3223 return !$this->isLoggedIn();
3224 }
3225
3226 /**
3227 * Check if user is allowed to access a feature / make an action
3228 *
3229 * @param string ... Permissions to test
3230 * @return bool True if user is allowed to perform *any* of the given actions
3231 */
3232 public function isAllowedAny() {
3233 $permissions = func_get_args();
3234 foreach ( $permissions as $permission ) {
3235 if ( $this->isAllowed( $permission ) ) {
3236 return true;
3237 }
3238 }
3239 return false;
3240 }
3241
3242 /**
3243 *
3244 * @param string ... Permissions to test
3245 * @return bool True if the user is allowed to perform *all* of the given actions
3246 */
3247 public function isAllowedAll() {
3248 $permissions = func_get_args();
3249 foreach ( $permissions as $permission ) {
3250 if ( !$this->isAllowed( $permission ) ) {
3251 return false;
3252 }
3253 }
3254 return true;
3255 }
3256
3257 /**
3258 * Internal mechanics of testing a permission
3259 * @param string $action
3260 * @return bool
3261 */
3262 public function isAllowed( $action = '' ) {
3263 if ( $action === '' ) {
3264 return true; // In the spirit of DWIM
3265 }
3266 // Patrolling may not be enabled
3267 if ( $action === 'patrol' || $action === 'autopatrol' ) {
3268 global $wgUseRCPatrol, $wgUseNPPatrol;
3269 if ( !$wgUseRCPatrol && !$wgUseNPPatrol ) {
3270 return false;
3271 }
3272 }
3273 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3274 // by misconfiguration: 0 == 'foo'
3275 return in_array( $action, $this->getRights(), true );
3276 }
3277
3278 /**
3279 * Check whether to enable recent changes patrol features for this user
3280 * @return bool True or false
3281 */
3282 public function useRCPatrol() {
3283 global $wgUseRCPatrol;
3284 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3285 }
3286
3287 /**
3288 * Check whether to enable new pages patrol features for this user
3289 * @return bool True or false
3290 */
3291 public function useNPPatrol() {
3292 global $wgUseRCPatrol, $wgUseNPPatrol;
3293 return (
3294 ( $wgUseRCPatrol || $wgUseNPPatrol )
3295 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3296 );
3297 }
3298
3299 /**
3300 * Get the WebRequest object to use with this object
3301 *
3302 * @return WebRequest
3303 */
3304 public function getRequest() {
3305 if ( $this->mRequest ) {
3306 return $this->mRequest;
3307 } else {
3308 global $wgRequest;
3309 return $wgRequest;
3310 }
3311 }
3312
3313 /**
3314 * Get the current skin, loading it if required
3315 * @return Skin The current skin
3316 * @todo FIXME: Need to check the old failback system [AV]
3317 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
3318 */
3319 public function getSkin() {
3320 wfDeprecated( __METHOD__, '1.18' );
3321 return RequestContext::getMain()->getSkin();
3322 }
3323
3324 /**
3325 * Get a WatchedItem for this user and $title.
3326 *
3327 * @since 1.22 $checkRights parameter added
3328 * @param Title $title
3329 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3330 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3331 * @return WatchedItem
3332 */
3333 public function getWatchedItem( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
3334 $key = $checkRights . ':' . $title->getNamespace() . ':' . $title->getDBkey();
3335
3336 if ( isset( $this->mWatchedItems[$key] ) ) {
3337 return $this->mWatchedItems[$key];
3338 }
3339
3340 if ( count( $this->mWatchedItems ) >= self::MAX_WATCHED_ITEMS_CACHE ) {
3341 $this->mWatchedItems = array();
3342 }
3343
3344 $this->mWatchedItems[$key] = WatchedItem::fromUserTitle( $this, $title, $checkRights );
3345 return $this->mWatchedItems[$key];
3346 }
3347
3348 /**
3349 * Check the watched status of an article.
3350 * @since 1.22 $checkRights parameter added
3351 * @param Title $title Title of the article to look at
3352 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3353 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3354 * @return bool
3355 */
3356 public function isWatched( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
3357 return $this->getWatchedItem( $title, $checkRights )->isWatched();
3358 }
3359
3360 /**
3361 * Watch an article.
3362 * @since 1.22 $checkRights parameter added
3363 * @param Title $title Title of the article to look at
3364 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3365 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3366 */
3367 public function addWatch( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
3368 $this->getWatchedItem( $title, $checkRights )->addWatch();
3369 $this->invalidateCache();
3370 }
3371
3372 /**
3373 * Stop watching an article.
3374 * @since 1.22 $checkRights parameter added
3375 * @param Title $title Title of the article to look at
3376 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3377 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3378 */
3379 public function removeWatch( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
3380 $this->getWatchedItem( $title, $checkRights )->removeWatch();
3381 $this->invalidateCache();
3382 }
3383
3384 /**
3385 * Clear the user's notification timestamp for the given title.
3386 * If e-notif e-mails are on, they will receive notification mails on
3387 * the next change of the page if it's watched etc.
3388 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3389 * @param Title $title Title of the article to look at
3390 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3391 */
3392 public function clearNotification( &$title, $oldid = 0 ) {
3393 global $wgUseEnotif, $wgShowUpdatedMarker;
3394
3395 // Do nothing if the database is locked to writes
3396 if ( wfReadOnly() ) {
3397 return;
3398 }
3399
3400 // Do nothing if not allowed to edit the watchlist
3401 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3402 return;
3403 }
3404
3405 // If we're working on user's talk page, we should update the talk page message indicator
3406 if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
3407 if ( !Hooks::run( 'UserClearNewTalkNotification', array( &$this, $oldid ) ) ) {
3408 return;
3409 }
3410
3411 $that = $this;
3412 // Try to update the DB post-send and only if needed...
3413 DeferredUpdates::addCallableUpdate( function() use ( $that, $title, $oldid ) {
3414 if ( !$that->getNewtalk() ) {
3415 return; // no notifications to clear
3416 }
3417
3418 // Delete the last notifications (they stack up)
3419 $that->setNewtalk( false );
3420
3421 // If there is a new, unseen, revision, use its timestamp
3422 $nextid = $oldid
3423 ? $title->getNextRevisionID( $oldid, Title::GAID_FOR_UPDATE )
3424 : null;
3425 if ( $nextid ) {
3426 $that->setNewtalk( true, Revision::newFromId( $nextid ) );
3427 }
3428 } );
3429 }
3430
3431 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3432 return;
3433 }
3434
3435 if ( $this->isAnon() ) {
3436 // Nothing else to do...
3437 return;
3438 }
3439
3440 // Only update the timestamp if the page is being watched.
3441 // The query to find out if it is watched is cached both in memcached and per-invocation,
3442 // and when it does have to be executed, it can be on a slave
3443 // If this is the user's newtalk page, we always update the timestamp
3444 $force = '';
3445 if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
3446 $force = 'force';
3447 }
3448
3449 $this->getWatchedItem( $title )->resetNotificationTimestamp(
3450 $force, $oldid, WatchedItem::DEFERRED
3451 );
3452 }
3453
3454 /**
3455 * Resets all of the given user's page-change notification timestamps.
3456 * If e-notif e-mails are on, they will receive notification mails on
3457 * the next change of any watched page.
3458 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3459 */
3460 public function clearAllNotifications() {
3461 if ( wfReadOnly() ) {
3462 return;
3463 }
3464
3465 // Do nothing if not allowed to edit the watchlist
3466 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3467 return;
3468 }
3469
3470 global $wgUseEnotif, $wgShowUpdatedMarker;
3471 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3472 $this->setNewtalk( false );
3473 return;
3474 }
3475 $id = $this->getId();
3476 if ( $id != 0 ) {
3477 $dbw = wfGetDB( DB_MASTER );
3478 $dbw->update( 'watchlist',
3479 array( /* SET */ 'wl_notificationtimestamp' => null ),
3480 array( /* WHERE */ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ),
3481 __METHOD__
3482 );
3483 // We also need to clear here the "you have new message" notification for the own user_talk page;
3484 // it's cleared one page view later in WikiPage::doViewUpdates().
3485 }
3486 }
3487
3488 /**
3489 * Set a cookie on the user's client. Wrapper for
3490 * WebResponse::setCookie
3491 * @param string $name Name of the cookie to set
3492 * @param string $value Value to set
3493 * @param int $exp Expiration time, as a UNIX time value;
3494 * if 0 or not specified, use the default $wgCookieExpiration
3495 * @param bool $secure
3496 * true: Force setting the secure attribute when setting the cookie
3497 * false: Force NOT setting the secure attribute when setting the cookie
3498 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3499 * @param array $params Array of options sent passed to WebResponse::setcookie()
3500 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3501 * is passed.
3502 */
3503 protected function setCookie(
3504 $name, $value, $exp = 0, $secure = null, $params = array(), $request = null
3505 ) {
3506 if ( $request === null ) {
3507 $request = $this->getRequest();
3508 }
3509 $params['secure'] = $secure;
3510 $request->response()->setcookie( $name, $value, $exp, $params );
3511 }
3512
3513 /**
3514 * Clear a cookie on the user's client
3515 * @param string $name Name of the cookie to clear
3516 * @param bool $secure
3517 * true: Force setting the secure attribute when setting the cookie
3518 * false: Force NOT setting the secure attribute when setting the cookie
3519 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3520 * @param array $params Array of options sent passed to WebResponse::setcookie()
3521 */
3522 protected function clearCookie( $name, $secure = null, $params = array() ) {
3523 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3524 }
3525
3526 /**
3527 * Set an extended login cookie on the user's client. The expiry of the cookie
3528 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3529 * variable.
3530 *
3531 * @see User::setCookie
3532 *
3533 * @param string $name Name of the cookie to set
3534 * @param string $value Value to set
3535 * @param bool $secure
3536 * true: Force setting the secure attribute when setting the cookie
3537 * false: Force NOT setting the secure attribute when setting the cookie
3538 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3539 */
3540 protected function setExtendedLoginCookie( $name, $value, $secure ) {
3541 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3542
3543 $exp = time();
3544 $exp += $wgExtendedLoginCookieExpiration !== null
3545 ? $wgExtendedLoginCookieExpiration
3546 : $wgCookieExpiration;
3547
3548 $this->setCookie( $name, $value, $exp, $secure );
3549 }
3550
3551 /**
3552 * Set the default cookies for this session on the user's client.
3553 *
3554 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3555 * is passed.
3556 * @param bool $secure Whether to force secure/insecure cookies or use default
3557 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3558 */
3559 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3560 global $wgExtendedLoginCookies;
3561
3562 if ( $request === null ) {
3563 $request = $this->getRequest();
3564 }
3565
3566 $this->load();
3567 if ( 0 == $this->mId ) {
3568 return;
3569 }
3570 if ( !$this->mToken ) {
3571 // When token is empty or NULL generate a new one and then save it to the database
3572 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
3573 // Simply by setting every cell in the user_token column to NULL and letting them be
3574 // regenerated as users log back into the wiki.
3575 $this->setToken();
3576 if ( !wfReadOnly() ) {
3577 $this->saveSettings();
3578 }
3579 }
3580 $session = array(
3581 'wsUserID' => $this->mId,
3582 'wsToken' => $this->mToken,
3583 'wsUserName' => $this->getName()
3584 );
3585 $cookies = array(
3586 'UserID' => $this->mId,
3587 'UserName' => $this->getName(),
3588 );
3589 if ( $rememberMe ) {
3590 $cookies['Token'] = $this->mToken;
3591 } else {
3592 $cookies['Token'] = false;
3593 }
3594
3595 Hooks::run( 'UserSetCookies', array( $this, &$session, &$cookies ) );
3596
3597 foreach ( $session as $name => $value ) {
3598 $request->setSessionData( $name, $value );
3599 }
3600 foreach ( $cookies as $name => $value ) {
3601 if ( $value === false ) {
3602 $this->clearCookie( $name );
3603 } elseif ( $rememberMe && in_array( $name, $wgExtendedLoginCookies ) ) {
3604 $this->setExtendedLoginCookie( $name, $value, $secure );
3605 } else {
3606 $this->setCookie( $name, $value, 0, $secure, array(), $request );
3607 }
3608 }
3609
3610 /**
3611 * If wpStickHTTPS was selected, also set an insecure cookie that
3612 * will cause the site to redirect the user to HTTPS, if they access
3613 * it over HTTP. Bug 29898. Use an un-prefixed cookie, so it's the same
3614 * as the one set by centralauth (bug 53538). Also set it to session, or
3615 * standard time setting, based on if rememberme was set.
3616 */
3617 if ( $request->getCheck( 'wpStickHTTPS' ) || $this->requiresHTTPS() ) {
3618 $this->setCookie(
3619 'forceHTTPS',
3620 'true',
3621 $rememberMe ? 0 : null,
3622 false,
3623 array( 'prefix' => '' ) // no prefix
3624 );
3625 }
3626 }
3627
3628 /**
3629 * Log this user out.
3630 */
3631 public function logout() {
3632 if ( Hooks::run( 'UserLogout', array( &$this ) ) ) {
3633 $this->doLogout();
3634 }
3635 }
3636
3637 /**
3638 * Clear the user's cookies and session, and reset the instance cache.
3639 * @see logout()
3640 */
3641 public function doLogout() {
3642 $this->clearInstanceCache( 'defaults' );
3643
3644 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3645
3646 $this->clearCookie( 'UserID' );
3647 $this->clearCookie( 'Token' );
3648 $this->clearCookie( 'forceHTTPS', false, array( 'prefix' => '' ) );
3649
3650 // Remember when user logged out, to prevent seeing cached pages
3651 $this->setCookie( 'LoggedOut', time(), time() + 86400 );
3652 }
3653
3654 /**
3655 * Save this user's settings into the database.
3656 * @todo Only rarely do all these fields need to be set!
3657 */
3658 public function saveSettings() {
3659 global $wgAuth;
3660
3661 if ( wfReadOnly() ) {
3662 // @TODO: caller should deal with this instead!
3663 // This should really just be an exception.
3664 MWExceptionHandler::logException( new DBExpectedError(
3665 null,
3666 "Could not update user with ID '{$this->mId}'; DB is read-only."
3667 ) );
3668 return;
3669 }
3670
3671 $this->load();
3672 $this->loadPasswords();
3673 if ( 0 == $this->mId ) {
3674 return; // anon
3675 }
3676
3677 // Get a new user_touched that is higher than the old one.
3678 // This will be used for a CAS check as a last-resort safety
3679 // check against race conditions and slave lag.
3680 $oldTouched = $this->mTouched;
3681 $newTouched = $this->newTouchedTimestamp();
3682
3683 if ( !$wgAuth->allowSetLocalPassword() ) {
3684 $this->mPassword = self::getPasswordFactory()->newFromCiphertext( null );
3685 }
3686
3687 $dbw = wfGetDB( DB_MASTER );
3688 $dbw->update( 'user',
3689 array( /* SET */
3690 'user_name' => $this->mName,
3691 'user_password' => $this->mPassword->toString(),
3692 'user_newpassword' => $this->mNewpassword->toString(),
3693 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
3694 'user_real_name' => $this->mRealName,
3695 'user_email' => $this->mEmail,
3696 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
3697 'user_touched' => $dbw->timestamp( $newTouched ),
3698 'user_token' => strval( $this->mToken ),
3699 'user_email_token' => $this->mEmailToken,
3700 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ),
3701 'user_password_expires' => $dbw->timestampOrNull( $this->mPasswordExpires ),
3702 ), array( /* WHERE */
3703 'user_id' => $this->mId,
3704 'user_touched' => $dbw->timestamp( $oldTouched ) // CAS check
3705 ), __METHOD__
3706 );
3707
3708 if ( !$dbw->affectedRows() ) {
3709 // Maybe the problem was a missed cache update; clear it to be safe
3710 $this->clearSharedCache( 'refresh' );
3711 // User was changed in the meantime or loaded with stale data
3712 $from = ( $this->queryFlagsUsed & self::READ_LATEST ) ? 'master' : 'slave';
3713 throw new MWException(
3714 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3715 " the version of the user to be saved is older than the current version."
3716 );
3717 }
3718
3719 $this->mTouched = $newTouched;
3720 $this->saveOptions();
3721
3722 Hooks::run( 'UserSaveSettings', array( $this ) );
3723 $this->clearSharedCache();
3724 $this->getUserPage()->invalidateCache();
3725 }
3726
3727 /**
3728 * If only this user's username is known, and it exists, return the user ID.
3729 *
3730 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3731 * @return int
3732 */
3733 public function idForName( $flags = 0 ) {
3734 $s = trim( $this->getName() );
3735 if ( $s === '' ) {
3736 return 0;
3737 }
3738
3739 $db = ( ( $flags & self::READ_LATEST ) == self::READ_LATEST )
3740 ? wfGetDB( DB_MASTER )
3741 : wfGetDB( DB_SLAVE );
3742
3743 $options = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING )
3744 ? array( 'LOCK IN SHARE MODE' )
3745 : array();
3746
3747 $id = $db->selectField( 'user',
3748 'user_id', array( 'user_name' => $s ), __METHOD__, $options );
3749
3750 return (int)$id;
3751 }
3752
3753 /**
3754 * Add a user to the database, return the user object
3755 *
3756 * @param string $name Username to add
3757 * @param array $params Array of Strings Non-default parameters to save to
3758 * the database as user_* fields:
3759 * - password: The user's password hash. Password logins will be disabled
3760 * if this is omitted.
3761 * - newpassword: Hash for a temporary password that has been mailed to
3762 * the user.
3763 * - email: The user's email address.
3764 * - email_authenticated: The email authentication timestamp.
3765 * - real_name: The user's real name.
3766 * - options: An associative array of non-default options.
3767 * - token: Random authentication token. Do not set.
3768 * - registration: Registration timestamp. Do not set.
3769 *
3770 * @return User|null User object, or null if the username already exists.
3771 */
3772 public static function createNew( $name, $params = array() ) {
3773 $user = new User;
3774 $user->load();
3775 $user->loadPasswords();
3776 $user->setToken(); // init token
3777 if ( isset( $params['options'] ) ) {
3778 $user->mOptions = $params['options'] + (array)$user->mOptions;
3779 unset( $params['options'] );
3780 }
3781 $dbw = wfGetDB( DB_MASTER );
3782 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3783
3784 $fields = array(
3785 'user_id' => $seqVal,
3786 'user_name' => $name,
3787 'user_password' => $user->mPassword->toString(),
3788 'user_newpassword' => $user->mNewpassword->toString(),
3789 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime ),
3790 'user_email' => $user->mEmail,
3791 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
3792 'user_real_name' => $user->mRealName,
3793 'user_token' => strval( $user->mToken ),
3794 'user_registration' => $dbw->timestamp( $user->mRegistration ),
3795 'user_editcount' => 0,
3796 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3797 );
3798 foreach ( $params as $name => $value ) {
3799 $fields["user_$name"] = $value;
3800 }
3801 $dbw->insert( 'user', $fields, __METHOD__, array( 'IGNORE' ) );
3802 if ( $dbw->affectedRows() ) {
3803 $newUser = User::newFromId( $dbw->insertId() );
3804 } else {
3805 $newUser = null;
3806 }
3807 return $newUser;
3808 }
3809
3810 /**
3811 * Add this existing user object to the database. If the user already
3812 * exists, a fatal status object is returned, and the user object is
3813 * initialised with the data from the database.
3814 *
3815 * Previously, this function generated a DB error due to a key conflict
3816 * if the user already existed. Many extension callers use this function
3817 * in code along the lines of:
3818 *
3819 * $user = User::newFromName( $name );
3820 * if ( !$user->isLoggedIn() ) {
3821 * $user->addToDatabase();
3822 * }
3823 * // do something with $user...
3824 *
3825 * However, this was vulnerable to a race condition (bug 16020). By
3826 * initialising the user object if the user exists, we aim to support this
3827 * calling sequence as far as possible.
3828 *
3829 * Note that if the user exists, this function will acquire a write lock,
3830 * so it is still advisable to make the call conditional on isLoggedIn(),
3831 * and to commit the transaction after calling.
3832 *
3833 * @throws MWException
3834 * @return Status
3835 */
3836 public function addToDatabase() {
3837 $this->load();
3838 $this->loadPasswords();
3839 if ( !$this->mToken ) {
3840 $this->setToken(); // init token
3841 }
3842
3843 $this->mTouched = $this->newTouchedTimestamp();
3844
3845 $dbw = wfGetDB( DB_MASTER );
3846 $inWrite = $dbw->writesOrCallbacksPending();
3847 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3848 $dbw->insert( 'user',
3849 array(
3850 'user_id' => $seqVal,
3851 'user_name' => $this->mName,
3852 'user_password' => $this->mPassword->toString(),
3853 'user_newpassword' => $this->mNewpassword->toString(),
3854 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
3855 'user_email' => $this->mEmail,
3856 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
3857 'user_real_name' => $this->mRealName,
3858 'user_token' => strval( $this->mToken ),
3859 'user_registration' => $dbw->timestamp( $this->mRegistration ),
3860 'user_editcount' => 0,
3861 'user_touched' => $dbw->timestamp( $this->mTouched ),
3862 ), __METHOD__,
3863 array( 'IGNORE' )
3864 );
3865 if ( !$dbw->affectedRows() ) {
3866 // The queries below cannot happen in the same REPEATABLE-READ snapshot.
3867 // Handle this by COMMIT, if possible, or by LOCK IN SHARE MODE otherwise.
3868 if ( $inWrite ) {
3869 // Can't commit due to pending writes that may need atomicity.
3870 // This may cause some lock contention unlike the case below.
3871 $options = array( 'LOCK IN SHARE MODE' );
3872 $flags = self::READ_LOCKING;
3873 } else {
3874 // Often, this case happens early in views before any writes when
3875 // using CentralAuth. It's should be OK to commit and break the snapshot.
3876 $dbw->commit( __METHOD__, 'flush' );
3877 $options = array();
3878 $flags = self::READ_LATEST;
3879 }
3880 $this->mId = $dbw->selectField( 'user', 'user_id',
3881 array( 'user_name' => $this->mName ), __METHOD__, $options );
3882 $loaded = false;
3883 if ( $this->mId ) {
3884 if ( $this->loadFromDatabase( $flags ) ) {
3885 $loaded = true;
3886 }
3887 }
3888 if ( !$loaded ) {
3889 throw new MWException( __METHOD__ . ": hit a key conflict attempting " .
3890 "to insert user '{$this->mName}' row, but it was not present in select!" );
3891 }
3892 return Status::newFatal( 'userexists' );
3893 }
3894 $this->mId = $dbw->insertId();
3895
3896 // Clear instance cache other than user table data, which is already accurate
3897 $this->clearInstanceCache();
3898
3899 $this->saveOptions();
3900 return Status::newGood();
3901 }
3902
3903 /**
3904 * If this user is logged-in and blocked,
3905 * block any IP address they've successfully logged in from.
3906 * @return bool A block was spread
3907 */
3908 public function spreadAnyEditBlock() {
3909 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3910 return $this->spreadBlock();
3911 }
3912 return false;
3913 }
3914
3915 /**
3916 * If this (non-anonymous) user is blocked,
3917 * block the IP address they've successfully logged in from.
3918 * @return bool A block was spread
3919 */
3920 protected function spreadBlock() {
3921 wfDebug( __METHOD__ . "()\n" );
3922 $this->load();
3923 if ( $this->mId == 0 ) {
3924 return false;
3925 }
3926
3927 $userblock = Block::newFromTarget( $this->getName() );
3928 if ( !$userblock ) {
3929 return false;
3930 }
3931
3932 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3933 }
3934
3935 /**
3936 * Get whether the user is explicitly blocked from account creation.
3937 * @return bool|Block
3938 */
3939 public function isBlockedFromCreateAccount() {
3940 $this->getBlockedStatus();
3941 if ( $this->mBlock && $this->mBlock->prevents( 'createaccount' ) ) {
3942 return $this->mBlock;
3943 }
3944
3945 # bug 13611: if the IP address the user is trying to create an account from is
3946 # blocked with createaccount disabled, prevent new account creation there even
3947 # when the user is logged in
3948 if ( $this->mBlockedFromCreateAccount === false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3949 $this->mBlockedFromCreateAccount = Block::newFromTarget( null, $this->getRequest()->getIP() );
3950 }
3951 return $this->mBlockedFromCreateAccount instanceof Block
3952 && $this->mBlockedFromCreateAccount->prevents( 'createaccount' )
3953 ? $this->mBlockedFromCreateAccount
3954 : false;
3955 }
3956
3957 /**
3958 * Get whether the user is blocked from using Special:Emailuser.
3959 * @return bool
3960 */
3961 public function isBlockedFromEmailuser() {
3962 $this->getBlockedStatus();
3963 return $this->mBlock && $this->mBlock->prevents( 'sendemail' );
3964 }
3965
3966 /**
3967 * Get whether the user is allowed to create an account.
3968 * @return bool
3969 */
3970 public function isAllowedToCreateAccount() {
3971 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3972 }
3973
3974 /**
3975 * Get this user's personal page title.
3976 *
3977 * @return Title User's personal page title
3978 */
3979 public function getUserPage() {
3980 return Title::makeTitle( NS_USER, $this->getName() );
3981 }
3982
3983 /**
3984 * Get this user's talk page title.
3985 *
3986 * @return Title User's talk page title
3987 */
3988 public function getTalkPage() {
3989 $title = $this->getUserPage();
3990 return $title->getTalkPage();
3991 }
3992
3993 /**
3994 * Determine whether the user is a newbie. Newbies are either
3995 * anonymous IPs, or the most recently created accounts.
3996 * @return bool
3997 */
3998 public function isNewbie() {
3999 return !$this->isAllowed( 'autoconfirmed' );
4000 }
4001
4002 /**
4003 * Check to see if the given clear-text password is one of the accepted passwords
4004 * @param string $password User password
4005 * @return bool True if the given password is correct, otherwise False
4006 */
4007 public function checkPassword( $password ) {
4008 global $wgAuth, $wgLegacyEncoding;
4009
4010 $this->loadPasswords();
4011
4012 // Some passwords will give a fatal Status, which means there is
4013 // some sort of technical or security reason for this password to
4014 // be completely invalid and should never be checked (e.g., T64685)
4015 if ( !$this->checkPasswordValidity( $password )->isOK() ) {
4016 return false;
4017 }
4018
4019 // Certain authentication plugins do NOT want to save
4020 // domain passwords in a mysql database, so we should
4021 // check this (in case $wgAuth->strict() is false).
4022 if ( $wgAuth->authenticate( $this->getName(), $password ) ) {
4023 return true;
4024 } elseif ( $wgAuth->strict() ) {
4025 // Auth plugin doesn't allow local authentication
4026 return false;
4027 } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) {
4028 // Auth plugin doesn't allow local authentication for this user name
4029 return false;
4030 }
4031
4032 if ( !$this->mPassword->equals( $password ) ) {
4033 if ( $wgLegacyEncoding ) {
4034 // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
4035 // Check for this with iconv
4036 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
4037 if ( $cp1252Password === $password || !$this->mPassword->equals( $cp1252Password ) ) {
4038 return false;
4039 }
4040 } else {
4041 return false;
4042 }
4043 }
4044
4045 $passwordFactory = self::getPasswordFactory();
4046 if ( $passwordFactory->needsUpdate( $this->mPassword ) && !wfReadOnly() ) {
4047 $this->mPassword = $passwordFactory->newFromPlaintext( $password );
4048 $this->saveSettings();
4049 }
4050
4051 return true;
4052 }
4053
4054 /**
4055 * Check if the given clear-text password matches the temporary password
4056 * sent by e-mail for password reset operations.
4057 *
4058 * @param string $plaintext
4059 *
4060 * @return bool True if matches, false otherwise
4061 */
4062 public function checkTemporaryPassword( $plaintext ) {
4063 global $wgNewPasswordExpiry;
4064
4065 $this->load();
4066 $this->loadPasswords();
4067 if ( $this->mNewpassword->equals( $plaintext ) ) {
4068 if ( is_null( $this->mNewpassTime ) ) {
4069 return true;
4070 }
4071 $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgNewPasswordExpiry;
4072 return ( time() < $expiry );
4073 } else {
4074 return false;
4075 }
4076 }
4077
4078 /**
4079 * Alias for getEditToken.
4080 * @deprecated since 1.19, use getEditToken instead.
4081 *
4082 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4083 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4084 * @return string The new edit token
4085 */
4086 public function editToken( $salt = '', $request = null ) {
4087 wfDeprecated( __METHOD__, '1.19' );
4088 return $this->getEditToken( $salt, $request );
4089 }
4090
4091 /**
4092 * Internal implementation for self::getEditToken() and
4093 * self::matchEditToken().
4094 *
4095 * @param string|array $salt
4096 * @param WebRequest $request
4097 * @param string|int $timestamp
4098 * @return string
4099 */
4100 private function getEditTokenAtTimestamp( $salt, $request, $timestamp ) {
4101 if ( $this->isAnon() ) {
4102 return self::EDIT_TOKEN_SUFFIX;
4103 } else {
4104 $token = $request->getSessionData( 'wsEditToken' );
4105 if ( $token === null ) {
4106 $token = MWCryptRand::generateHex( 32 );
4107 $request->setSessionData( 'wsEditToken', $token );
4108 }
4109 if ( is_array( $salt ) ) {
4110 $salt = implode( '|', $salt );
4111 }
4112 return hash_hmac( 'md5', $timestamp . $salt, $token, false ) .
4113 dechex( $timestamp ) .
4114 self::EDIT_TOKEN_SUFFIX;
4115 }
4116 }
4117
4118 /**
4119 * Initialize (if necessary) and return a session token value
4120 * which can be used in edit forms to show that the user's
4121 * login credentials aren't being hijacked with a foreign form
4122 * submission.
4123 *
4124 * @since 1.19
4125 *
4126 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4127 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4128 * @return string The new edit token
4129 */
4130 public function getEditToken( $salt = '', $request = null ) {
4131 return $this->getEditTokenAtTimestamp(
4132 $salt, $request ?: $this->getRequest(), wfTimestamp()
4133 );
4134 }
4135
4136 /**
4137 * Generate a looking random token for various uses.
4138 *
4139 * @return string The new random token
4140 * @deprecated since 1.20: Use MWCryptRand for secure purposes or
4141 * wfRandomString for pseudo-randomness.
4142 */
4143 public static function generateToken() {
4144 return MWCryptRand::generateHex( 32 );
4145 }
4146
4147 /**
4148 * Get the embedded timestamp from a token.
4149 * @param string $val Input token
4150 * @return int|null
4151 */
4152 public static function getEditTokenTimestamp( $val ) {
4153 $suffixLen = strlen( self::EDIT_TOKEN_SUFFIX );
4154 if ( strlen( $val ) <= 32 + $suffixLen ) {
4155 return null;
4156 }
4157
4158 return hexdec( substr( $val, 32, -$suffixLen ) );
4159 }
4160
4161 /**
4162 * Check given value against the token value stored in the session.
4163 * A match should confirm that the form was submitted from the
4164 * user's own login session, not a form submission from a third-party
4165 * site.
4166 *
4167 * @param string $val Input value to compare
4168 * @param string $salt Optional function-specific data for hashing
4169 * @param WebRequest|null $request Object to use or null to use $wgRequest
4170 * @param int $maxage Fail tokens older than this, in seconds
4171 * @return bool Whether the token matches
4172 */
4173 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4174 if ( $this->isAnon() ) {
4175 return $val === self::EDIT_TOKEN_SUFFIX;
4176 }
4177
4178 $timestamp = self::getEditTokenTimestamp( $val );
4179 if ( $timestamp === null ) {
4180 return false;
4181 }
4182 if ( $maxage !== null && $timestamp < wfTimestamp() - $maxage ) {
4183 // Expired token
4184 return false;
4185 }
4186
4187 $sessionToken = $this->getEditTokenAtTimestamp(
4188 $salt, $request ?: $this->getRequest(), $timestamp
4189 );
4190
4191 if ( $val != $sessionToken ) {
4192 wfDebug( "User::matchEditToken: broken session data\n" );
4193 }
4194
4195 return hash_equals( $sessionToken, $val );
4196 }
4197
4198 /**
4199 * Check given value against the token value stored in the session,
4200 * ignoring the suffix.
4201 *
4202 * @param string $val Input value to compare
4203 * @param string $salt Optional function-specific data for hashing
4204 * @param WebRequest|null $request Object to use or null to use $wgRequest
4205 * @param int $maxage Fail tokens older than this, in seconds
4206 * @return bool Whether the token matches
4207 */
4208 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4209 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . self::EDIT_TOKEN_SUFFIX;
4210 return $this->matchEditToken( $val, $salt, $request, $maxage );
4211 }
4212
4213 /**
4214 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4215 * mail to the user's given address.
4216 *
4217 * @param string $type Message to send, either "created", "changed" or "set"
4218 * @return Status
4219 */
4220 public function sendConfirmationMail( $type = 'created' ) {
4221 global $wgLang;
4222 $expiration = null; // gets passed-by-ref and defined in next line.
4223 $token = $this->confirmationToken( $expiration );
4224 $url = $this->confirmationTokenUrl( $token );
4225 $invalidateURL = $this->invalidationTokenUrl( $token );
4226 $this->saveSettings();
4227
4228 if ( $type == 'created' || $type === false ) {
4229 $message = 'confirmemail_body';
4230 } elseif ( $type === true ) {
4231 $message = 'confirmemail_body_changed';
4232 } else {
4233 // Messages: confirmemail_body_changed, confirmemail_body_set
4234 $message = 'confirmemail_body_' . $type;
4235 }
4236
4237 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4238 wfMessage( $message,
4239 $this->getRequest()->getIP(),
4240 $this->getName(),
4241 $url,
4242 $wgLang->timeanddate( $expiration, false ),
4243 $invalidateURL,
4244 $wgLang->date( $expiration, false ),
4245 $wgLang->time( $expiration, false ) )->text() );
4246 }
4247
4248 /**
4249 * Send an e-mail to this user's account. Does not check for
4250 * confirmed status or validity.
4251 *
4252 * @param string $subject Message subject
4253 * @param string $body Message body
4254 * @param User|null $from Optional sending user; if unspecified, default
4255 * $wgPasswordSender will be used.
4256 * @param string $replyto Reply-To address
4257 * @return Status
4258 */
4259 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4260 global $wgPasswordSender;
4261
4262 if ( $from instanceof User ) {
4263 $sender = MailAddress::newFromUser( $from );
4264 } else {
4265 $sender = new MailAddress( $wgPasswordSender,
4266 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4267 }
4268 $to = MailAddress::newFromUser( $this );
4269
4270 return UserMailer::send( $to, $sender, $subject, $body, array(
4271 'replyTo' => $replyto,
4272 ) );
4273 }
4274
4275 /**
4276 * Generate, store, and return a new e-mail confirmation code.
4277 * A hash (unsalted, since it's used as a key) is stored.
4278 *
4279 * @note Call saveSettings() after calling this function to commit
4280 * this change to the database.
4281 *
4282 * @param string &$expiration Accepts the expiration time
4283 * @return string New token
4284 */
4285 protected function confirmationToken( &$expiration ) {
4286 global $wgUserEmailConfirmationTokenExpiry;
4287 $now = time();
4288 $expires = $now + $wgUserEmailConfirmationTokenExpiry;
4289 $expiration = wfTimestamp( TS_MW, $expires );
4290 $this->load();
4291 $token = MWCryptRand::generateHex( 32 );
4292 $hash = md5( $token );
4293 $this->mEmailToken = $hash;
4294 $this->mEmailTokenExpires = $expiration;
4295 return $token;
4296 }
4297
4298 /**
4299 * Return a URL the user can use to confirm their email address.
4300 * @param string $token Accepts the email confirmation token
4301 * @return string New token URL
4302 */
4303 protected function confirmationTokenUrl( $token ) {
4304 return $this->getTokenUrl( 'ConfirmEmail', $token );
4305 }
4306
4307 /**
4308 * Return a URL the user can use to invalidate their email address.
4309 * @param string $token Accepts the email confirmation token
4310 * @return string New token URL
4311 */
4312 protected function invalidationTokenUrl( $token ) {
4313 return $this->getTokenUrl( 'InvalidateEmail', $token );
4314 }
4315
4316 /**
4317 * Internal function to format the e-mail validation/invalidation URLs.
4318 * This uses a quickie hack to use the
4319 * hardcoded English names of the Special: pages, for ASCII safety.
4320 *
4321 * @note Since these URLs get dropped directly into emails, using the
4322 * short English names avoids insanely long URL-encoded links, which
4323 * also sometimes can get corrupted in some browsers/mailers
4324 * (bug 6957 with Gmail and Internet Explorer).
4325 *
4326 * @param string $page Special page
4327 * @param string $token Token
4328 * @return string Formatted URL
4329 */
4330 protected function getTokenUrl( $page, $token ) {
4331 // Hack to bypass localization of 'Special:'
4332 $title = Title::makeTitle( NS_MAIN, "Special:$page/$token" );
4333 return $title->getCanonicalURL();
4334 }
4335
4336 /**
4337 * Mark the e-mail address confirmed.
4338 *
4339 * @note Call saveSettings() after calling this function to commit the change.
4340 *
4341 * @return bool
4342 */
4343 public function confirmEmail() {
4344 // Check if it's already confirmed, so we don't touch the database
4345 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4346 if ( !$this->isEmailConfirmed() ) {
4347 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4348 Hooks::run( 'ConfirmEmailComplete', array( $this ) );
4349 }
4350 return true;
4351 }
4352
4353 /**
4354 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4355 * address if it was already confirmed.
4356 *
4357 * @note Call saveSettings() after calling this function to commit the change.
4358 * @return bool Returns true
4359 */
4360 public function invalidateEmail() {
4361 $this->load();
4362 $this->mEmailToken = null;
4363 $this->mEmailTokenExpires = null;
4364 $this->setEmailAuthenticationTimestamp( null );
4365 $this->mEmail = '';
4366 Hooks::run( 'InvalidateEmailComplete', array( $this ) );
4367 return true;
4368 }
4369
4370 /**
4371 * Set the e-mail authentication timestamp.
4372 * @param string $timestamp TS_MW timestamp
4373 */
4374 public function setEmailAuthenticationTimestamp( $timestamp ) {
4375 $this->load();
4376 $this->mEmailAuthenticated = $timestamp;
4377 Hooks::run( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
4378 }
4379
4380 /**
4381 * Is this user allowed to send e-mails within limits of current
4382 * site configuration?
4383 * @return bool
4384 */
4385 public function canSendEmail() {
4386 global $wgEnableEmail, $wgEnableUserEmail;
4387 if ( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
4388 return false;
4389 }
4390 $canSend = $this->isEmailConfirmed();
4391 Hooks::run( 'UserCanSendEmail', array( &$this, &$canSend ) );
4392 return $canSend;
4393 }
4394
4395 /**
4396 * Is this user allowed to receive e-mails within limits of current
4397 * site configuration?
4398 * @return bool
4399 */
4400 public function canReceiveEmail() {
4401 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4402 }
4403
4404 /**
4405 * Is this user's e-mail address valid-looking and confirmed within
4406 * limits of the current site configuration?
4407 *
4408 * @note If $wgEmailAuthentication is on, this may require the user to have
4409 * confirmed their address by returning a code or using a password
4410 * sent to the address from the wiki.
4411 *
4412 * @return bool
4413 */
4414 public function isEmailConfirmed() {
4415 global $wgEmailAuthentication;
4416 $this->load();
4417 $confirmed = true;
4418 if ( Hooks::run( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
4419 if ( $this->isAnon() ) {
4420 return false;
4421 }
4422 if ( !Sanitizer::validateEmail( $this->mEmail ) ) {
4423 return false;
4424 }
4425 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4426 return false;
4427 }
4428 return true;
4429 } else {
4430 return $confirmed;
4431 }
4432 }
4433
4434 /**
4435 * Check whether there is an outstanding request for e-mail confirmation.
4436 * @return bool
4437 */
4438 public function isEmailConfirmationPending() {
4439 global $wgEmailAuthentication;
4440 return $wgEmailAuthentication &&
4441 !$this->isEmailConfirmed() &&
4442 $this->mEmailToken &&
4443 $this->mEmailTokenExpires > wfTimestamp();
4444 }
4445
4446 /**
4447 * Get the timestamp of account creation.
4448 *
4449 * @return string|bool|null Timestamp of account creation, false for
4450 * non-existent/anonymous user accounts, or null if existing account
4451 * but information is not in database.
4452 */
4453 public function getRegistration() {
4454 if ( $this->isAnon() ) {
4455 return false;
4456 }
4457 $this->load();
4458 return $this->mRegistration;
4459 }
4460
4461 /**
4462 * Get the timestamp of the first edit
4463 *
4464 * @return string|bool Timestamp of first edit, or false for
4465 * non-existent/anonymous user accounts.
4466 */
4467 public function getFirstEditTimestamp() {
4468 if ( $this->getId() == 0 ) {
4469 return false; // anons
4470 }
4471 $dbr = wfGetDB( DB_SLAVE );
4472 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4473 array( 'rev_user' => $this->getId() ),
4474 __METHOD__,
4475 array( 'ORDER BY' => 'rev_timestamp ASC' )
4476 );
4477 if ( !$time ) {
4478 return false; // no edits
4479 }
4480 return wfTimestamp( TS_MW, $time );
4481 }
4482
4483 /**
4484 * Get the permissions associated with a given list of groups
4485 *
4486 * @param array $groups Array of Strings List of internal group names
4487 * @return array Array of Strings List of permission key names for given groups combined
4488 */
4489 public static function getGroupPermissions( $groups ) {
4490 global $wgGroupPermissions, $wgRevokePermissions;
4491 $rights = array();
4492 // grant every granted permission first
4493 foreach ( $groups as $group ) {
4494 if ( isset( $wgGroupPermissions[$group] ) ) {
4495 $rights = array_merge( $rights,
4496 // array_filter removes empty items
4497 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4498 }
4499 }
4500 // now revoke the revoked permissions
4501 foreach ( $groups as $group ) {
4502 if ( isset( $wgRevokePermissions[$group] ) ) {
4503 $rights = array_diff( $rights,
4504 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4505 }
4506 }
4507 return array_unique( $rights );
4508 }
4509
4510 /**
4511 * Get all the groups who have a given permission
4512 *
4513 * @param string $role Role to check
4514 * @return array Array of Strings List of internal group names with the given permission
4515 */
4516 public static function getGroupsWithPermission( $role ) {
4517 global $wgGroupPermissions;
4518 $allowedGroups = array();
4519 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4520 if ( self::groupHasPermission( $group, $role ) ) {
4521 $allowedGroups[] = $group;
4522 }
4523 }
4524 return $allowedGroups;
4525 }
4526
4527 /**
4528 * Check, if the given group has the given permission
4529 *
4530 * If you're wanting to check whether all users have a permission, use
4531 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4532 * from anyone.
4533 *
4534 * @since 1.21
4535 * @param string $group Group to check
4536 * @param string $role Role to check
4537 * @return bool
4538 */
4539 public static function groupHasPermission( $group, $role ) {
4540 global $wgGroupPermissions, $wgRevokePermissions;
4541 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4542 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4543 }
4544
4545 /**
4546 * Check if all users have the given permission
4547 *
4548 * @since 1.22
4549 * @param string $right Right to check
4550 * @return bool
4551 */
4552 public static function isEveryoneAllowed( $right ) {
4553 global $wgGroupPermissions, $wgRevokePermissions;
4554 static $cache = array();
4555
4556 // Use the cached results, except in unit tests which rely on
4557 // being able change the permission mid-request
4558 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4559 return $cache[$right];
4560 }
4561
4562 if ( !isset( $wgGroupPermissions['*'][$right] ) || !$wgGroupPermissions['*'][$right] ) {
4563 $cache[$right] = false;
4564 return false;
4565 }
4566
4567 // If it's revoked anywhere, then everyone doesn't have it
4568 foreach ( $wgRevokePermissions as $rights ) {
4569 if ( isset( $rights[$right] ) && $rights[$right] ) {
4570 $cache[$right] = false;
4571 return false;
4572 }
4573 }
4574
4575 // Allow extensions (e.g. OAuth) to say false
4576 if ( !Hooks::run( 'UserIsEveryoneAllowed', array( $right ) ) ) {
4577 $cache[$right] = false;
4578 return false;
4579 }
4580
4581 $cache[$right] = true;
4582 return true;
4583 }
4584
4585 /**
4586 * Get the localized descriptive name for a group, if it exists
4587 *
4588 * @param string $group Internal group name
4589 * @return string Localized descriptive group name
4590 */
4591 public static function getGroupName( $group ) {
4592 $msg = wfMessage( "group-$group" );
4593 return $msg->isBlank() ? $group : $msg->text();
4594 }
4595
4596 /**
4597 * Get the localized descriptive name for a member of a group, if it exists
4598 *
4599 * @param string $group Internal group name
4600 * @param string $username Username for gender (since 1.19)
4601 * @return string Localized name for group member
4602 */
4603 public static function getGroupMember( $group, $username = '#' ) {
4604 $msg = wfMessage( "group-$group-member", $username );
4605 return $msg->isBlank() ? $group : $msg->text();
4606 }
4607
4608 /**
4609 * Return the set of defined explicit groups.
4610 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4611 * are not included, as they are defined automatically, not in the database.
4612 * @return array Array of internal group names
4613 */
4614 public static function getAllGroups() {
4615 global $wgGroupPermissions, $wgRevokePermissions;
4616 return array_diff(
4617 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4618 self::getImplicitGroups()
4619 );
4620 }
4621
4622 /**
4623 * Get a list of all available permissions.
4624 * @return string[] Array of permission names
4625 */
4626 public static function getAllRights() {
4627 if ( self::$mAllRights === false ) {
4628 global $wgAvailableRights;
4629 if ( count( $wgAvailableRights ) ) {
4630 self::$mAllRights = array_unique( array_merge( self::$mCoreRights, $wgAvailableRights ) );
4631 } else {
4632 self::$mAllRights = self::$mCoreRights;
4633 }
4634 Hooks::run( 'UserGetAllRights', array( &self::$mAllRights ) );
4635 }
4636 return self::$mAllRights;
4637 }
4638
4639 /**
4640 * Get a list of implicit groups
4641 * @return array Array of Strings Array of internal group names
4642 */
4643 public static function getImplicitGroups() {
4644 global $wgImplicitGroups;
4645
4646 $groups = $wgImplicitGroups;
4647 # Deprecated, use $wgImplicitGroups instead
4648 Hooks::run( 'UserGetImplicitGroups', array( &$groups ), '1.25' );
4649
4650 return $groups;
4651 }
4652
4653 /**
4654 * Get the title of a page describing a particular group
4655 *
4656 * @param string $group Internal group name
4657 * @return Title|bool Title of the page if it exists, false otherwise
4658 */
4659 public static function getGroupPage( $group ) {
4660 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4661 if ( $msg->exists() ) {
4662 $title = Title::newFromText( $msg->text() );
4663 if ( is_object( $title ) ) {
4664 return $title;
4665 }
4666 }
4667 return false;
4668 }
4669
4670 /**
4671 * Create a link to the group in HTML, if available;
4672 * else return the group name.
4673 *
4674 * @param string $group Internal name of the group
4675 * @param string $text The text of the link
4676 * @return string HTML link to the group
4677 */
4678 public static function makeGroupLinkHTML( $group, $text = '' ) {
4679 if ( $text == '' ) {
4680 $text = self::getGroupName( $group );
4681 }
4682 $title = self::getGroupPage( $group );
4683 if ( $title ) {
4684 return Linker::link( $title, htmlspecialchars( $text ) );
4685 } else {
4686 return htmlspecialchars( $text );
4687 }
4688 }
4689
4690 /**
4691 * Create a link to the group in Wikitext, if available;
4692 * else return the group name.
4693 *
4694 * @param string $group Internal name of the group
4695 * @param string $text The text of the link
4696 * @return string Wikilink to the group
4697 */
4698 public static function makeGroupLinkWiki( $group, $text = '' ) {
4699 if ( $text == '' ) {
4700 $text = self::getGroupName( $group );
4701 }
4702 $title = self::getGroupPage( $group );
4703 if ( $title ) {
4704 $page = $title->getFullText();
4705 return "[[$page|$text]]";
4706 } else {
4707 return $text;
4708 }
4709 }
4710
4711 /**
4712 * Returns an array of the groups that a particular group can add/remove.
4713 *
4714 * @param string $group The group to check for whether it can add/remove
4715 * @return array Array( 'add' => array( addablegroups ),
4716 * 'remove' => array( removablegroups ),
4717 * 'add-self' => array( addablegroups to self),
4718 * 'remove-self' => array( removable groups from self) )
4719 */
4720 public static function changeableByGroup( $group ) {
4721 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4722
4723 $groups = array(
4724 'add' => array(),
4725 'remove' => array(),
4726 'add-self' => array(),
4727 'remove-self' => array()
4728 );
4729
4730 if ( empty( $wgAddGroups[$group] ) ) {
4731 // Don't add anything to $groups
4732 } elseif ( $wgAddGroups[$group] === true ) {
4733 // You get everything
4734 $groups['add'] = self::getAllGroups();
4735 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4736 $groups['add'] = $wgAddGroups[$group];
4737 }
4738
4739 // Same thing for remove
4740 if ( empty( $wgRemoveGroups[$group] ) ) {
4741 // Do nothing
4742 } elseif ( $wgRemoveGroups[$group] === true ) {
4743 $groups['remove'] = self::getAllGroups();
4744 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4745 $groups['remove'] = $wgRemoveGroups[$group];
4746 }
4747
4748 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4749 if ( empty( $wgGroupsAddToSelf['user'] ) || $wgGroupsAddToSelf['user'] !== true ) {
4750 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4751 if ( is_int( $key ) ) {
4752 $wgGroupsAddToSelf['user'][] = $value;
4753 }
4754 }
4755 }
4756
4757 if ( empty( $wgGroupsRemoveFromSelf['user'] ) || $wgGroupsRemoveFromSelf['user'] !== true ) {
4758 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4759 if ( is_int( $key ) ) {
4760 $wgGroupsRemoveFromSelf['user'][] = $value;
4761 }
4762 }
4763 }
4764
4765 // Now figure out what groups the user can add to him/herself
4766 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4767 // Do nothing
4768 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4769 // No idea WHY this would be used, but it's there
4770 $groups['add-self'] = User::getAllGroups();
4771 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4772 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4773 }
4774
4775 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4776 // Do nothing
4777 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4778 $groups['remove-self'] = User::getAllGroups();
4779 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4780 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4781 }
4782
4783 return $groups;
4784 }
4785
4786 /**
4787 * Returns an array of groups that this user can add and remove
4788 * @return array Array( 'add' => array( addablegroups ),
4789 * 'remove' => array( removablegroups ),
4790 * 'add-self' => array( addablegroups to self),
4791 * 'remove-self' => array( removable groups from self) )
4792 */
4793 public function changeableGroups() {
4794 if ( $this->isAllowed( 'userrights' ) ) {
4795 // This group gives the right to modify everything (reverse-
4796 // compatibility with old "userrights lets you change
4797 // everything")
4798 // Using array_merge to make the groups reindexed
4799 $all = array_merge( User::getAllGroups() );
4800 return array(
4801 'add' => $all,
4802 'remove' => $all,
4803 'add-self' => array(),
4804 'remove-self' => array()
4805 );
4806 }
4807
4808 // Okay, it's not so simple, we will have to go through the arrays
4809 $groups = array(
4810 'add' => array(),
4811 'remove' => array(),
4812 'add-self' => array(),
4813 'remove-self' => array()
4814 );
4815 $addergroups = $this->getEffectiveGroups();
4816
4817 foreach ( $addergroups as $addergroup ) {
4818 $groups = array_merge_recursive(
4819 $groups, $this->changeableByGroup( $addergroup )
4820 );
4821 $groups['add'] = array_unique( $groups['add'] );
4822 $groups['remove'] = array_unique( $groups['remove'] );
4823 $groups['add-self'] = array_unique( $groups['add-self'] );
4824 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4825 }
4826 return $groups;
4827 }
4828
4829 /**
4830 * Deferred version of incEditCountImmediate()
4831 */
4832 public function incEditCount() {
4833 $that = $this;
4834 wfGetDB( DB_MASTER )->onTransactionPreCommitOrIdle( function() use ( $that ) {
4835 $that->incEditCountImmediate();
4836 } );
4837 }
4838
4839 /**
4840 * Increment the user's edit-count field.
4841 * Will have no effect for anonymous users.
4842 * @since 1.26
4843 */
4844 public function incEditCountImmediate() {
4845 if ( $this->isAnon() ) {
4846 return;
4847 }
4848
4849 $dbw = wfGetDB( DB_MASTER );
4850 // No rows will be "affected" if user_editcount is NULL
4851 $dbw->update(
4852 'user',
4853 array( 'user_editcount=user_editcount+1' ),
4854 array( 'user_id' => $this->getId() ),
4855 __METHOD__
4856 );
4857 // Lazy initialization check...
4858 if ( $dbw->affectedRows() == 0 ) {
4859 // Now here's a goddamn hack...
4860 $dbr = wfGetDB( DB_SLAVE );
4861 if ( $dbr !== $dbw ) {
4862 // If we actually have a slave server, the count is
4863 // at least one behind because the current transaction
4864 // has not been committed and replicated.
4865 $this->initEditCount( 1 );
4866 } else {
4867 // But if DB_SLAVE is selecting the master, then the
4868 // count we just read includes the revision that was
4869 // just added in the working transaction.
4870 $this->initEditCount();
4871 }
4872 }
4873 // Edit count in user cache too
4874 $this->invalidateCache();
4875 }
4876
4877 /**
4878 * Initialize user_editcount from data out of the revision table
4879 *
4880 * @param int $add Edits to add to the count from the revision table
4881 * @return int Number of edits
4882 */
4883 protected function initEditCount( $add = 0 ) {
4884 // Pull from a slave to be less cruel to servers
4885 // Accuracy isn't the point anyway here
4886 $dbr = wfGetDB( DB_SLAVE );
4887 $count = (int)$dbr->selectField(
4888 'revision',
4889 'COUNT(rev_user)',
4890 array( 'rev_user' => $this->getId() ),
4891 __METHOD__
4892 );
4893 $count = $count + $add;
4894
4895 $dbw = wfGetDB( DB_MASTER );
4896 $dbw->update(
4897 'user',
4898 array( 'user_editcount' => $count ),
4899 array( 'user_id' => $this->getId() ),
4900 __METHOD__
4901 );
4902
4903 return $count;
4904 }
4905
4906 /**
4907 * Get the description of a given right
4908 *
4909 * @param string $right Right to query
4910 * @return string Localized description of the right
4911 */
4912 public static function getRightDescription( $right ) {
4913 $key = "right-$right";
4914 $msg = wfMessage( $key );
4915 return $msg->isBlank() ? $right : $msg->text();
4916 }
4917
4918 /**
4919 * Make a new-style password hash
4920 *
4921 * @param string $password Plain-text password
4922 * @param bool|string $salt Optional salt, may be random or the user ID.
4923 * If unspecified or false, will generate one automatically
4924 * @return string Password hash
4925 * @deprecated since 1.24, use Password class
4926 */
4927 public static function crypt( $password, $salt = false ) {
4928 wfDeprecated( __METHOD__, '1.24' );
4929 $hash = self::getPasswordFactory()->newFromPlaintext( $password );
4930 return $hash->toString();
4931 }
4932
4933 /**
4934 * Compare a password hash with a plain-text password. Requires the user
4935 * ID if there's a chance that the hash is an old-style hash.
4936 *
4937 * @param string $hash Password hash
4938 * @param string $password Plain-text password to compare
4939 * @param string|bool $userId User ID for old-style password salt
4940 *
4941 * @return bool
4942 * @deprecated since 1.24, use Password class
4943 */
4944 public static function comparePasswords( $hash, $password, $userId = false ) {
4945 wfDeprecated( __METHOD__, '1.24' );
4946
4947 // Check for *really* old password hashes that don't even have a type
4948 // The old hash format was just an md5 hex hash, with no type information
4949 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
4950 global $wgPasswordSalt;
4951 if ( $wgPasswordSalt ) {
4952 $password = ":B:{$userId}:{$hash}";
4953 } else {
4954 $password = ":A:{$hash}";
4955 }
4956 }
4957
4958 $hash = self::getPasswordFactory()->newFromCiphertext( $hash );
4959 return $hash->equals( $password );
4960 }
4961
4962 /**
4963 * Add a newuser log entry for this user.
4964 * Before 1.19 the return value was always true.
4965 *
4966 * @param string|bool $action Account creation type.
4967 * - String, one of the following values:
4968 * - 'create' for an anonymous user creating an account for himself.
4969 * This will force the action's performer to be the created user itself,
4970 * no matter the value of $wgUser
4971 * - 'create2' for a logged in user creating an account for someone else
4972 * - 'byemail' when the created user will receive its password by e-mail
4973 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
4974 * - Boolean means whether the account was created by e-mail (deprecated):
4975 * - true will be converted to 'byemail'
4976 * - false will be converted to 'create' if this object is the same as
4977 * $wgUser and to 'create2' otherwise
4978 *
4979 * @param string $reason User supplied reason
4980 *
4981 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4982 */
4983 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4984 global $wgUser, $wgNewUserLog;
4985 if ( empty( $wgNewUserLog ) ) {
4986 return true; // disabled
4987 }
4988
4989 if ( $action === true ) {
4990 $action = 'byemail';
4991 } elseif ( $action === false ) {
4992 if ( $this->equals( $wgUser ) ) {
4993 $action = 'create';
4994 } else {
4995 $action = 'create2';
4996 }
4997 }
4998
4999 if ( $action === 'create' || $action === 'autocreate' ) {
5000 $performer = $this;
5001 } else {
5002 $performer = $wgUser;
5003 }
5004
5005 $logEntry = new ManualLogEntry( 'newusers', $action );
5006 $logEntry->setPerformer( $performer );
5007 $logEntry->setTarget( $this->getUserPage() );
5008 $logEntry->setComment( $reason );
5009 $logEntry->setParameters( array(
5010 '4::userid' => $this->getId(),
5011 ) );
5012 $logid = $logEntry->insert();
5013
5014 if ( $action !== 'autocreate' ) {
5015 $logEntry->publish( $logid );
5016 }
5017
5018 return (int)$logid;
5019 }
5020
5021 /**
5022 * Add an autocreate newuser log entry for this user
5023 * Used by things like CentralAuth and perhaps other authplugins.
5024 * Consider calling addNewUserLogEntry() directly instead.
5025 *
5026 * @return bool
5027 */
5028 public function addNewUserLogEntryAutoCreate() {
5029 $this->addNewUserLogEntry( 'autocreate' );
5030
5031 return true;
5032 }
5033
5034 /**
5035 * Load the user options either from cache, the database or an array
5036 *
5037 * @param array $data Rows for the current user out of the user_properties table
5038 */
5039 protected function loadOptions( $data = null ) {
5040 global $wgContLang;
5041
5042 $this->load();
5043
5044 if ( $this->mOptionsLoaded ) {
5045 return;
5046 }
5047
5048 $this->mOptions = self::getDefaultOptions();
5049
5050 if ( !$this->getId() ) {
5051 // For unlogged-in users, load language/variant options from request.
5052 // There's no need to do it for logged-in users: they can set preferences,
5053 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5054 // so don't override user's choice (especially when the user chooses site default).
5055 $variant = $wgContLang->getDefaultVariant();
5056 $this->mOptions['variant'] = $variant;
5057 $this->mOptions['language'] = $variant;
5058 $this->mOptionsLoaded = true;
5059 return;
5060 }
5061
5062 // Maybe load from the object
5063 if ( !is_null( $this->mOptionOverrides ) ) {
5064 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5065 foreach ( $this->mOptionOverrides as $key => $value ) {
5066 $this->mOptions[$key] = $value;
5067 }
5068 } else {
5069 if ( !is_array( $data ) ) {
5070 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5071 // Load from database
5072 $dbr = ( $this->queryFlagsUsed & self::READ_LATEST )
5073 ? wfGetDB( DB_MASTER )
5074 : wfGetDB( DB_SLAVE );
5075
5076 $res = $dbr->select(
5077 'user_properties',
5078 array( 'up_property', 'up_value' ),
5079 array( 'up_user' => $this->getId() ),
5080 __METHOD__
5081 );
5082
5083 $this->mOptionOverrides = array();
5084 $data = array();
5085 foreach ( $res as $row ) {
5086 $data[$row->up_property] = $row->up_value;
5087 }
5088 }
5089 foreach ( $data as $property => $value ) {
5090 $this->mOptionOverrides[$property] = $value;
5091 $this->mOptions[$property] = $value;
5092 }
5093 }
5094
5095 $this->mOptionsLoaded = true;
5096
5097 Hooks::run( 'UserLoadOptions', array( $this, &$this->mOptions ) );
5098 }
5099
5100 /**
5101 * Saves the non-default options for this user, as previously set e.g. via
5102 * setOption(), in the database's "user_properties" (preferences) table.
5103 * Usually used via saveSettings().
5104 */
5105 protected function saveOptions() {
5106 $this->loadOptions();
5107
5108 // Not using getOptions(), to keep hidden preferences in database
5109 $saveOptions = $this->mOptions;
5110
5111 // Allow hooks to abort, for instance to save to a global profile.
5112 // Reset options to default state before saving.
5113 if ( !Hooks::run( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
5114 return;
5115 }
5116
5117 $userId = $this->getId();
5118
5119 $insert_rows = array(); // all the new preference rows
5120 foreach ( $saveOptions as $key => $value ) {
5121 // Don't bother storing default values
5122 $defaultOption = self::getDefaultOption( $key );
5123 if ( ( $defaultOption === null && $value !== false && $value !== null )
5124 || $value != $defaultOption
5125 ) {
5126 $insert_rows[] = array(
5127 'up_user' => $userId,
5128 'up_property' => $key,
5129 'up_value' => $value,
5130 );
5131 }
5132 }
5133
5134 $dbw = wfGetDB( DB_MASTER );
5135
5136 $res = $dbw->select( 'user_properties',
5137 array( 'up_property', 'up_value' ), array( 'up_user' => $userId ), __METHOD__ );
5138
5139 // Find prior rows that need to be removed or updated. These rows will
5140 // all be deleted (the later so that INSERT IGNORE applies the new values).
5141 $keysDelete = array();
5142 foreach ( $res as $row ) {
5143 if ( !isset( $saveOptions[$row->up_property] )
5144 || strcmp( $saveOptions[$row->up_property], $row->up_value ) != 0
5145 ) {
5146 $keysDelete[] = $row->up_property;
5147 }
5148 }
5149
5150 if ( count( $keysDelete ) ) {
5151 // Do the DELETE by PRIMARY KEY for prior rows.
5152 // In the past a very large portion of calls to this function are for setting
5153 // 'rememberpassword' for new accounts (a preference that has since been removed).
5154 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5155 // caused gap locks on [max user ID,+infinity) which caused high contention since
5156 // updates would pile up on each other as they are for higher (newer) user IDs.
5157 // It might not be necessary these days, but it shouldn't hurt either.
5158 $dbw->delete( 'user_properties',
5159 array( 'up_user' => $userId, 'up_property' => $keysDelete ), __METHOD__ );
5160 }
5161 // Insert the new preference rows
5162 $dbw->insert( 'user_properties', $insert_rows, __METHOD__, array( 'IGNORE' ) );
5163 }
5164
5165 /**
5166 * Lazily instantiate and return a factory object for making passwords
5167 *
5168 * @return PasswordFactory
5169 */
5170 public static function getPasswordFactory() {
5171 if ( self::$mPasswordFactory === null ) {
5172 self::$mPasswordFactory = new PasswordFactory();
5173 self::$mPasswordFactory->init( RequestContext::getMain()->getConfig() );
5174 }
5175
5176 return self::$mPasswordFactory;
5177 }
5178
5179 /**
5180 * Provide an array of HTML5 attributes to put on an input element
5181 * intended for the user to enter a new password. This may include
5182 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5183 *
5184 * Do *not* use this when asking the user to enter his current password!
5185 * Regardless of configuration, users may have invalid passwords for whatever
5186 * reason (e.g., they were set before requirements were tightened up).
5187 * Only use it when asking for a new password, like on account creation or
5188 * ResetPass.
5189 *
5190 * Obviously, you still need to do server-side checking.
5191 *
5192 * NOTE: A combination of bugs in various browsers means that this function
5193 * actually just returns array() unconditionally at the moment. May as
5194 * well keep it around for when the browser bugs get fixed, though.
5195 *
5196 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5197 *
5198 * @return array Array of HTML attributes suitable for feeding to
5199 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5200 * That will get confused by the boolean attribute syntax used.)
5201 */
5202 public static function passwordChangeInputAttribs() {
5203 global $wgMinimalPasswordLength;
5204
5205 if ( $wgMinimalPasswordLength == 0 ) {
5206 return array();
5207 }
5208
5209 # Note that the pattern requirement will always be satisfied if the
5210 # input is empty, so we need required in all cases.
5211 #
5212 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5213 # if e-mail confirmation is being used. Since HTML5 input validation
5214 # is b0rked anyway in some browsers, just return nothing. When it's
5215 # re-enabled, fix this code to not output required for e-mail
5216 # registration.
5217 # $ret = array( 'required' );
5218 $ret = array();
5219
5220 # We can't actually do this right now, because Opera 9.6 will print out
5221 # the entered password visibly in its error message! When other
5222 # browsers add support for this attribute, or Opera fixes its support,
5223 # we can add support with a version check to avoid doing this on Opera
5224 # versions where it will be a problem. Reported to Opera as
5225 # DSK-262266, but they don't have a public bug tracker for us to follow.
5226 /*
5227 if ( $wgMinimalPasswordLength > 1 ) {
5228 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5229 $ret['title'] = wfMessage( 'passwordtooshort' )
5230 ->numParams( $wgMinimalPasswordLength )->text();
5231 }
5232 */
5233
5234 return $ret;
5235 }
5236
5237 /**
5238 * Return the list of user fields that should be selected to create
5239 * a new user object.
5240 * @return array
5241 */
5242 public static function selectFields() {
5243 return array(
5244 'user_id',
5245 'user_name',
5246 'user_real_name',
5247 'user_email',
5248 'user_touched',
5249 'user_token',
5250 'user_email_authenticated',
5251 'user_email_token',
5252 'user_email_token_expires',
5253 'user_registration',
5254 'user_editcount',
5255 );
5256 }
5257
5258 /**
5259 * Factory function for fatal permission-denied errors
5260 *
5261 * @since 1.22
5262 * @param string $permission User right required
5263 * @return Status
5264 */
5265 static function newFatalPermissionDeniedStatus( $permission ) {
5266 global $wgLang;
5267
5268 $groups = array_map(
5269 array( 'User', 'makeGroupLinkWiki' ),
5270 User::getGroupsWithPermission( $permission )
5271 );
5272
5273 if ( $groups ) {
5274 return Status::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5275 } else {
5276 return Status::newFatal( 'badaccess-group0' );
5277 }
5278 }
5279
5280 /**
5281 * Checks if two user objects point to the same user.
5282 *
5283 * @since 1.25
5284 * @param User $user
5285 * @return bool
5286 */
5287 public function equals( User $user ) {
5288 return $this->getName() === $user->getName();
5289 }
5290 }