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