Merge "Remove zh-tw message "editing""
[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 cache slave-loaded User object with ID '{$this->mId}'." );
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 $db = ( $this->queryFlagsUsed & self::READ_LATEST )
1375 ? wfGetDB( DB_MASTER )
1376 : wfGetDB( DB_SLAVE );
1377 $res = $db->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 &&
1399 ( $this->mPassword === null || $this->mNewpassword === null )
1400 ) {
1401 $db = ( $this->queryFlagsUsed & self::READ_LATEST )
1402 ? wfGetDB( DB_MASTER )
1403 : wfGetDB( DB_SLAVE );
1404
1405 $this->loadFromRow( $db->selectRow(
1406 'user',
1407 array( 'user_password', 'user_newpassword',
1408 'user_newpass_time', 'user_password_expires' ),
1409 array( 'user_id' => $this->getId() ),
1410 __METHOD__
1411 ) );
1412 }
1413 }
1414
1415 /**
1416 * Add the user to the group if he/she meets given criteria.
1417 *
1418 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1419 * possible to remove manually via Special:UserRights. In such case it
1420 * will not be re-added automatically. The user will also not lose the
1421 * group if they no longer meet the criteria.
1422 *
1423 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1424 *
1425 * @return array Array of groups the user has been promoted to.
1426 *
1427 * @see $wgAutopromoteOnce
1428 */
1429 public function addAutopromoteOnceGroups( $event ) {
1430 global $wgAutopromoteOnceLogInRC, $wgAuth;
1431
1432 $toPromote = array();
1433 if ( !wfReadOnly() && $this->getId() ) {
1434 $toPromote = Autopromote::getAutopromoteOnceGroups( $this, $event );
1435 if ( count( $toPromote ) ) {
1436 $oldGroups = $this->getGroups(); // previous groups
1437
1438 foreach ( $toPromote as $group ) {
1439 $this->addGroup( $group );
1440 }
1441 // update groups in external authentication database
1442 $wgAuth->updateExternalDBGroups( $this, $toPromote );
1443
1444 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1445
1446 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1447 $logEntry->setPerformer( $this );
1448 $logEntry->setTarget( $this->getUserPage() );
1449 $logEntry->setParameters( array(
1450 '4::oldgroups' => $oldGroups,
1451 '5::newgroups' => $newGroups,
1452 ) );
1453 $logid = $logEntry->insert();
1454 if ( $wgAutopromoteOnceLogInRC ) {
1455 $logEntry->publish( $logid );
1456 }
1457 }
1458 }
1459
1460 return $toPromote;
1461 }
1462
1463 /**
1464 * Clear various cached data stored in this object. The cache of the user table
1465 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1466 *
1467 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1468 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1469 */
1470 public function clearInstanceCache( $reloadFrom = false ) {
1471 $this->mNewtalk = -1;
1472 $this->mDatePreference = null;
1473 $this->mBlockedby = -1; # Unset
1474 $this->mHash = false;
1475 $this->mRights = null;
1476 $this->mEffectiveGroups = null;
1477 $this->mImplicitGroups = null;
1478 $this->mGroups = null;
1479 $this->mOptions = null;
1480 $this->mOptionsLoaded = false;
1481 $this->mEditCount = null;
1482
1483 if ( $reloadFrom ) {
1484 $this->mLoadedItems = array();
1485 $this->mFrom = $reloadFrom;
1486 }
1487 }
1488
1489 /**
1490 * Combine the language default options with any site-specific options
1491 * and add the default language variants.
1492 *
1493 * @return array Array of String options
1494 */
1495 public static function getDefaultOptions() {
1496 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1497
1498 static $defOpt = null;
1499 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1500 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1501 // mid-request and see that change reflected in the return value of this function.
1502 // Which is insane and would never happen during normal MW operation
1503 return $defOpt;
1504 }
1505
1506 $defOpt = $wgDefaultUserOptions;
1507 // Default language setting
1508 $defOpt['language'] = $wgContLang->getCode();
1509 foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
1510 $defOpt[$langCode == $wgContLang->getCode() ? 'variant' : "variant-$langCode"] = $langCode;
1511 }
1512 foreach ( SearchEngine::searchableNamespaces() as $nsnum => $nsname ) {
1513 $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1514 }
1515 $defOpt['skin'] = Skin::normalizeKey( $wgDefaultSkin );
1516
1517 Hooks::run( 'UserGetDefaultOptions', array( &$defOpt ) );
1518
1519 return $defOpt;
1520 }
1521
1522 /**
1523 * Get a given default option value.
1524 *
1525 * @param string $opt Name of option to retrieve
1526 * @return string Default option value
1527 */
1528 public static function getDefaultOption( $opt ) {
1529 $defOpts = self::getDefaultOptions();
1530 if ( isset( $defOpts[$opt] ) ) {
1531 return $defOpts[$opt];
1532 } else {
1533 return null;
1534 }
1535 }
1536
1537 /**
1538 * Get blocking information
1539 * @param bool $bFromSlave Whether to check the slave database first.
1540 * To improve performance, non-critical checks are done against slaves.
1541 * Check when actually saving should be done against master.
1542 */
1543 private function getBlockedStatus( $bFromSlave = true ) {
1544 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1545
1546 if ( -1 != $this->mBlockedby ) {
1547 return;
1548 }
1549
1550 wfDebug( __METHOD__ . ": checking...\n" );
1551
1552 // Initialize data...
1553 // Otherwise something ends up stomping on $this->mBlockedby when
1554 // things get lazy-loaded later, causing false positive block hits
1555 // due to -1 !== 0. Probably session-related... Nothing should be
1556 // overwriting mBlockedby, surely?
1557 $this->load();
1558
1559 # We only need to worry about passing the IP address to the Block generator if the
1560 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1561 # know which IP address they're actually coming from
1562 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1563 $ip = $this->getRequest()->getIP();
1564 } else {
1565 $ip = null;
1566 }
1567
1568 // User/IP blocking
1569 $block = Block::newFromTarget( $this, $ip, !$bFromSlave );
1570
1571 // Proxy blocking
1572 if ( !$block instanceof Block && $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1573 && !in_array( $ip, $wgProxyWhitelist )
1574 ) {
1575 // Local list
1576 if ( self::isLocallyBlockedProxy( $ip ) ) {
1577 $block = new Block;
1578 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1579 $block->mReason = wfMessage( 'proxyblockreason' )->text();
1580 $block->setTarget( $ip );
1581 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1582 $block = new Block;
1583 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1584 $block->mReason = wfMessage( 'sorbsreason' )->text();
1585 $block->setTarget( $ip );
1586 }
1587 }
1588
1589 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1590 if ( !$block instanceof Block
1591 && $wgApplyIpBlocksToXff
1592 && $ip !== null
1593 && !$this->isAllowed( 'proxyunbannable' )
1594 && !in_array( $ip, $wgProxyWhitelist )
1595 ) {
1596 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1597 $xff = array_map( 'trim', explode( ',', $xff ) );
1598 $xff = array_diff( $xff, array( $ip ) );
1599 $xffblocks = Block::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1600 $block = Block::chooseBlock( $xffblocks, $xff );
1601 if ( $block instanceof Block ) {
1602 # Mangle the reason to alert the user that the block
1603 # originated from matching the X-Forwarded-For header.
1604 $block->mReason = wfMessage( 'xffblockreason', $block->mReason )->text();
1605 }
1606 }
1607
1608 if ( $block instanceof Block ) {
1609 wfDebug( __METHOD__ . ": Found block.\n" );
1610 $this->mBlock = $block;
1611 $this->mBlockedby = $block->getByName();
1612 $this->mBlockreason = $block->mReason;
1613 $this->mHideName = $block->mHideName;
1614 $this->mAllowUsertalk = !$block->prevents( 'editownusertalk' );
1615 } else {
1616 $this->mBlockedby = '';
1617 $this->mHideName = 0;
1618 $this->mAllowUsertalk = false;
1619 }
1620
1621 // Extensions
1622 Hooks::run( 'GetBlockedStatus', array( &$this ) );
1623
1624 }
1625
1626 /**
1627 * Whether the given IP is in a DNS blacklist.
1628 *
1629 * @param string $ip IP to check
1630 * @param bool $checkWhitelist Whether to check the whitelist first
1631 * @return bool True if blacklisted.
1632 */
1633 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1634 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1635
1636 if ( !$wgEnableDnsBlacklist ) {
1637 return false;
1638 }
1639
1640 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1641 return false;
1642 }
1643
1644 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1645 }
1646
1647 /**
1648 * Whether the given IP is in a given DNS blacklist.
1649 *
1650 * @param string $ip IP to check
1651 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1652 * @return bool True if blacklisted.
1653 */
1654 public function inDnsBlacklist( $ip, $bases ) {
1655
1656 $found = false;
1657 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1658 if ( IP::isIPv4( $ip ) ) {
1659 // Reverse IP, bug 21255
1660 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1661
1662 foreach ( (array)$bases as $base ) {
1663 // Make hostname
1664 // If we have an access key, use that too (ProjectHoneypot, etc.)
1665 if ( is_array( $base ) ) {
1666 if ( count( $base ) >= 2 ) {
1667 // Access key is 1, base URL is 0
1668 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1669 } else {
1670 $host = "$ipReversed.{$base[0]}";
1671 }
1672 } else {
1673 $host = "$ipReversed.$base";
1674 }
1675
1676 // Send query
1677 $ipList = gethostbynamel( $host );
1678
1679 if ( $ipList ) {
1680 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!" );
1681 $found = true;
1682 break;
1683 } else {
1684 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base." );
1685 }
1686 }
1687 }
1688
1689 return $found;
1690 }
1691
1692 /**
1693 * Check if an IP address is in the local proxy list
1694 *
1695 * @param string $ip
1696 *
1697 * @return bool
1698 */
1699 public static function isLocallyBlockedProxy( $ip ) {
1700 global $wgProxyList;
1701
1702 if ( !$wgProxyList ) {
1703 return false;
1704 }
1705
1706 if ( !is_array( $wgProxyList ) ) {
1707 // Load from the specified file
1708 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1709 }
1710
1711 if ( !is_array( $wgProxyList ) ) {
1712 $ret = false;
1713 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1714 $ret = true;
1715 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1716 // Old-style flipped proxy list
1717 $ret = true;
1718 } else {
1719 $ret = false;
1720 }
1721 return $ret;
1722 }
1723
1724 /**
1725 * Is this user subject to rate limiting?
1726 *
1727 * @return bool True if rate limited
1728 */
1729 public function isPingLimitable() {
1730 global $wgRateLimitsExcludedIPs;
1731 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1732 // No other good way currently to disable rate limits
1733 // for specific IPs. :P
1734 // But this is a crappy hack and should die.
1735 return false;
1736 }
1737 return !$this->isAllowed( 'noratelimit' );
1738 }
1739
1740 /**
1741 * Primitive rate limits: enforce maximum actions per time period
1742 * to put a brake on flooding.
1743 *
1744 * The method generates both a generic profiling point and a per action one
1745 * (suffix being "-$action".
1746 *
1747 * @note When using a shared cache like memcached, IP-address
1748 * last-hit counters will be shared across wikis.
1749 *
1750 * @param string $action Action to enforce; 'edit' if unspecified
1751 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1752 * @return bool True if a rate limiter was tripped
1753 */
1754 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1755 // Call the 'PingLimiter' hook
1756 $result = false;
1757 if ( !Hooks::run( 'PingLimiter', array( &$this, $action, &$result, $incrBy ) ) ) {
1758 return $result;
1759 }
1760
1761 global $wgRateLimits;
1762 if ( !isset( $wgRateLimits[$action] ) ) {
1763 return false;
1764 }
1765
1766 // Some groups shouldn't trigger the ping limiter, ever
1767 if ( !$this->isPingLimitable() ) {
1768 return false;
1769 }
1770
1771 global $wgMemc;
1772
1773 $limits = $wgRateLimits[$action];
1774 $keys = array();
1775 $id = $this->getId();
1776 $userLimit = false;
1777
1778 if ( isset( $limits['anon'] ) && $id == 0 ) {
1779 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1780 }
1781
1782 if ( isset( $limits['user'] ) && $id != 0 ) {
1783 $userLimit = $limits['user'];
1784 }
1785 if ( $this->isNewbie() ) {
1786 if ( isset( $limits['newbie'] ) && $id != 0 ) {
1787 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1788 }
1789 if ( isset( $limits['ip'] ) ) {
1790 $ip = $this->getRequest()->getIP();
1791 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1792 }
1793 if ( isset( $limits['subnet'] ) ) {
1794 $ip = $this->getRequest()->getIP();
1795 $matches = array();
1796 $subnet = false;
1797 if ( IP::isIPv6( $ip ) ) {
1798 $parts = IP::parseRange( "$ip/64" );
1799 $subnet = $parts[0];
1800 } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1801 // IPv4
1802 $subnet = $matches[1];
1803 }
1804 if ( $subnet !== false ) {
1805 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1806 }
1807 }
1808 }
1809 // Check for group-specific permissions
1810 // If more than one group applies, use the group with the highest limit
1811 foreach ( $this->getGroups() as $group ) {
1812 if ( isset( $limits[$group] ) ) {
1813 if ( $userLimit === false
1814 || $limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1815 ) {
1816 $userLimit = $limits[$group];
1817 }
1818 }
1819 }
1820 // Set the user limit key
1821 if ( $userLimit !== false ) {
1822 list( $max, $period ) = $userLimit;
1823 wfDebug( __METHOD__ . ": effective user limit: $max in {$period}s\n" );
1824 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1825 }
1826
1827 $triggered = false;
1828 foreach ( $keys as $key => $limit ) {
1829 list( $max, $period ) = $limit;
1830 $summary = "(limit $max in {$period}s)";
1831 $count = $wgMemc->get( $key );
1832 // Already pinged?
1833 if ( $count ) {
1834 if ( $count >= $max ) {
1835 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1836 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1837 $triggered = true;
1838 } else {
1839 wfDebug( __METHOD__ . ": ok. $key at $count $summary\n" );
1840 }
1841 } else {
1842 wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
1843 if ( $incrBy > 0 ) {
1844 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1845 }
1846 }
1847 if ( $incrBy > 0 ) {
1848 $wgMemc->incr( $key, $incrBy );
1849 }
1850 }
1851
1852 return $triggered;
1853 }
1854
1855 /**
1856 * Check if user is blocked
1857 *
1858 * @param bool $bFromSlave Whether to check the slave database instead of
1859 * the master. Hacked from false due to horrible probs on site.
1860 * @return bool True if blocked, false otherwise
1861 */
1862 public function isBlocked( $bFromSlave = true ) {
1863 return $this->getBlock( $bFromSlave ) instanceof Block && $this->getBlock()->prevents( 'edit' );
1864 }
1865
1866 /**
1867 * Get the block affecting the user, or null if the user is not blocked
1868 *
1869 * @param bool $bFromSlave Whether to check the slave database instead of the master
1870 * @return Block|null
1871 */
1872 public function getBlock( $bFromSlave = true ) {
1873 $this->getBlockedStatus( $bFromSlave );
1874 return $this->mBlock instanceof Block ? $this->mBlock : null;
1875 }
1876
1877 /**
1878 * Check if user is blocked from editing a particular article
1879 *
1880 * @param Title $title Title to check
1881 * @param bool $bFromSlave Whether to check the slave database instead of the master
1882 * @return bool
1883 */
1884 public function isBlockedFrom( $title, $bFromSlave = false ) {
1885 global $wgBlockAllowsUTEdit;
1886
1887 $blocked = $this->isBlocked( $bFromSlave );
1888 $allowUsertalk = ( $wgBlockAllowsUTEdit ? $this->mAllowUsertalk : false );
1889 // If a user's name is suppressed, they cannot make edits anywhere
1890 if ( !$this->mHideName && $allowUsertalk && $title->getText() === $this->getName()
1891 && $title->getNamespace() == NS_USER_TALK ) {
1892 $blocked = false;
1893 wfDebug( __METHOD__ . ": self-talk page, ignoring any blocks\n" );
1894 }
1895
1896 Hooks::run( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1897
1898 return $blocked;
1899 }
1900
1901 /**
1902 * If user is blocked, return the name of the user who placed the block
1903 * @return string Name of blocker
1904 */
1905 public function blockedBy() {
1906 $this->getBlockedStatus();
1907 return $this->mBlockedby;
1908 }
1909
1910 /**
1911 * If user is blocked, return the specified reason for the block
1912 * @return string Blocking reason
1913 */
1914 public function blockedFor() {
1915 $this->getBlockedStatus();
1916 return $this->mBlockreason;
1917 }
1918
1919 /**
1920 * If user is blocked, return the ID for the block
1921 * @return int Block ID
1922 */
1923 public function getBlockId() {
1924 $this->getBlockedStatus();
1925 return ( $this->mBlock ? $this->mBlock->getId() : false );
1926 }
1927
1928 /**
1929 * Check if user is blocked on all wikis.
1930 * Do not use for actual edit permission checks!
1931 * This is intended for quick UI checks.
1932 *
1933 * @param string $ip IP address, uses current client if none given
1934 * @return bool True if blocked, false otherwise
1935 */
1936 public function isBlockedGlobally( $ip = '' ) {
1937 if ( $this->mBlockedGlobally !== null ) {
1938 return $this->mBlockedGlobally;
1939 }
1940 // User is already an IP?
1941 if ( IP::isIPAddress( $this->getName() ) ) {
1942 $ip = $this->getName();
1943 } elseif ( !$ip ) {
1944 $ip = $this->getRequest()->getIP();
1945 }
1946 $blocked = false;
1947 Hooks::run( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1948 $this->mBlockedGlobally = (bool)$blocked;
1949 return $this->mBlockedGlobally;
1950 }
1951
1952 /**
1953 * Check if user account is locked
1954 *
1955 * @return bool True if locked, false otherwise
1956 */
1957 public function isLocked() {
1958 if ( $this->mLocked !== null ) {
1959 return $this->mLocked;
1960 }
1961 global $wgAuth;
1962 $authUser = $wgAuth->getUserInstance( $this );
1963 $this->mLocked = (bool)$authUser->isLocked();
1964 return $this->mLocked;
1965 }
1966
1967 /**
1968 * Check if user account is hidden
1969 *
1970 * @return bool True if hidden, false otherwise
1971 */
1972 public function isHidden() {
1973 if ( $this->mHideName !== null ) {
1974 return $this->mHideName;
1975 }
1976 $this->getBlockedStatus();
1977 if ( !$this->mHideName ) {
1978 global $wgAuth;
1979 $authUser = $wgAuth->getUserInstance( $this );
1980 $this->mHideName = (bool)$authUser->isHidden();
1981 }
1982 return $this->mHideName;
1983 }
1984
1985 /**
1986 * Get the user's ID.
1987 * @return int The user's ID; 0 if the user is anonymous or nonexistent
1988 */
1989 public function getId() {
1990 if ( $this->mId === null && $this->mName !== null && User::isIP( $this->mName ) ) {
1991 // Special case, we know the user is anonymous
1992 return 0;
1993 } elseif ( !$this->isItemLoaded( 'id' ) ) {
1994 // Don't load if this was initialized from an ID
1995 $this->load();
1996 }
1997 return $this->mId;
1998 }
1999
2000 /**
2001 * Set the user and reload all fields according to a given ID
2002 * @param int $v User ID to reload
2003 */
2004 public function setId( $v ) {
2005 $this->mId = $v;
2006 $this->clearInstanceCache( 'id' );
2007 }
2008
2009 /**
2010 * Get the user name, or the IP of an anonymous user
2011 * @return string User's name or IP address
2012 */
2013 public function getName() {
2014 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2015 // Special case optimisation
2016 return $this->mName;
2017 } else {
2018 $this->load();
2019 if ( $this->mName === false ) {
2020 // Clean up IPs
2021 $this->mName = IP::sanitizeIP( $this->getRequest()->getIP() );
2022 }
2023 return $this->mName;
2024 }
2025 }
2026
2027 /**
2028 * Set the user name.
2029 *
2030 * This does not reload fields from the database according to the given
2031 * name. Rather, it is used to create a temporary "nonexistent user" for
2032 * later addition to the database. It can also be used to set the IP
2033 * address for an anonymous user to something other than the current
2034 * remote IP.
2035 *
2036 * @note User::newFromName() has roughly the same function, when the named user
2037 * does not exist.
2038 * @param string $str New user name to set
2039 */
2040 public function setName( $str ) {
2041 $this->load();
2042 $this->mName = $str;
2043 }
2044
2045 /**
2046 * Get the user's name escaped by underscores.
2047 * @return string Username escaped by underscores.
2048 */
2049 public function getTitleKey() {
2050 return str_replace( ' ', '_', $this->getName() );
2051 }
2052
2053 /**
2054 * Check if the user has new messages.
2055 * @return bool True if the user has new messages
2056 */
2057 public function getNewtalk() {
2058 $this->load();
2059
2060 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2061 if ( $this->mNewtalk === -1 ) {
2062 $this->mNewtalk = false; # reset talk page status
2063
2064 // Check memcached separately for anons, who have no
2065 // entire User object stored in there.
2066 if ( !$this->mId ) {
2067 global $wgDisableAnonTalk;
2068 if ( $wgDisableAnonTalk ) {
2069 // Anon newtalk disabled by configuration.
2070 $this->mNewtalk = false;
2071 } else {
2072 $this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName() );
2073 }
2074 } else {
2075 $this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
2076 }
2077 }
2078
2079 return (bool)$this->mNewtalk;
2080 }
2081
2082 /**
2083 * Return the data needed to construct links for new talk page message
2084 * alerts. If there are new messages, this will return an associative array
2085 * with the following data:
2086 * wiki: The database name of the wiki
2087 * link: Root-relative link to the user's talk page
2088 * rev: The last talk page revision that the user has seen or null. This
2089 * is useful for building diff links.
2090 * If there are no new messages, it returns an empty array.
2091 * @note This function was designed to accomodate multiple talk pages, but
2092 * currently only returns a single link and revision.
2093 * @return array
2094 */
2095 public function getNewMessageLinks() {
2096 $talks = array();
2097 if ( !Hooks::run( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
2098 return $talks;
2099 } elseif ( !$this->getNewtalk() ) {
2100 return array();
2101 }
2102 $utp = $this->getTalkPage();
2103 $dbr = wfGetDB( DB_SLAVE );
2104 // Get the "last viewed rev" timestamp from the oldest message notification
2105 $timestamp = $dbr->selectField( 'user_newtalk',
2106 'MIN(user_last_timestamp)',
2107 $this->isAnon() ? array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
2108 __METHOD__ );
2109 $rev = $timestamp ? Revision::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2110 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
2111 }
2112
2113 /**
2114 * Get the revision ID for the last talk page revision viewed by the talk
2115 * page owner.
2116 * @return int|null Revision ID or null
2117 */
2118 public function getNewMessageRevisionId() {
2119 $newMessageRevisionId = null;
2120 $newMessageLinks = $this->getNewMessageLinks();
2121 if ( $newMessageLinks ) {
2122 // Note: getNewMessageLinks() never returns more than a single link
2123 // and it is always for the same wiki, but we double-check here in
2124 // case that changes some time in the future.
2125 if ( count( $newMessageLinks ) === 1
2126 && $newMessageLinks[0]['wiki'] === wfWikiID()
2127 && $newMessageLinks[0]['rev']
2128 ) {
2129 $newMessageRevision = $newMessageLinks[0]['rev'];
2130 $newMessageRevisionId = $newMessageRevision->getId();
2131 }
2132 }
2133 return $newMessageRevisionId;
2134 }
2135
2136 /**
2137 * Internal uncached check for new messages
2138 *
2139 * @see getNewtalk()
2140 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2141 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2142 * @return bool True if the user has new messages
2143 */
2144 protected function checkNewtalk( $field, $id ) {
2145 $dbr = wfGetDB( DB_SLAVE );
2146
2147 $ok = $dbr->selectField( 'user_newtalk', $field, array( $field => $id ), __METHOD__ );
2148
2149 return $ok !== false;
2150 }
2151
2152 /**
2153 * Add or update the new messages flag
2154 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2155 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2156 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2157 * @return bool True if successful, false otherwise
2158 */
2159 protected function updateNewtalk( $field, $id, $curRev = null ) {
2160 // Get timestamp of the talk page revision prior to the current one
2161 $prevRev = $curRev ? $curRev->getPrevious() : false;
2162 $ts = $prevRev ? $prevRev->getTimestamp() : null;
2163 // Mark the user as having new messages since this revision
2164 $dbw = wfGetDB( DB_MASTER );
2165 $dbw->insert( 'user_newtalk',
2166 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
2167 __METHOD__,
2168 'IGNORE' );
2169 if ( $dbw->affectedRows() ) {
2170 wfDebug( __METHOD__ . ": set on ($field, $id)\n" );
2171 return true;
2172 } else {
2173 wfDebug( __METHOD__ . " already set ($field, $id)\n" );
2174 return false;
2175 }
2176 }
2177
2178 /**
2179 * Clear the new messages flag for the given user
2180 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2181 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2182 * @return bool True if successful, false otherwise
2183 */
2184 protected function deleteNewtalk( $field, $id ) {
2185 $dbw = wfGetDB( DB_MASTER );
2186 $dbw->delete( 'user_newtalk',
2187 array( $field => $id ),
2188 __METHOD__ );
2189 if ( $dbw->affectedRows() ) {
2190 wfDebug( __METHOD__ . ": killed on ($field, $id)\n" );
2191 return true;
2192 } else {
2193 wfDebug( __METHOD__ . ": already gone ($field, $id)\n" );
2194 return false;
2195 }
2196 }
2197
2198 /**
2199 * Update the 'You have new messages!' status.
2200 * @param bool $val Whether the user has new messages
2201 * @param Revision $curRev New, as yet unseen revision of the user talk
2202 * page. Ignored if null or !$val.
2203 */
2204 public function setNewtalk( $val, $curRev = null ) {
2205 global $wgMemc;
2206
2207 if ( wfReadOnly() ) {
2208 return;
2209 }
2210
2211 $this->load();
2212 $this->mNewtalk = $val;
2213
2214 if ( $this->isAnon() ) {
2215 $field = 'user_ip';
2216 $id = $this->getName();
2217 } else {
2218 $field = 'user_id';
2219 $id = $this->getId();
2220 }
2221
2222 if ( $val ) {
2223 $changed = $this->updateNewtalk( $field, $id, $curRev );
2224 } else {
2225 $changed = $this->deleteNewtalk( $field, $id );
2226 }
2227
2228 if ( $this->isAnon() ) {
2229 // Anons have a separate memcached space, since
2230 // user records aren't kept for them.
2231 $key = wfMemcKey( 'newtalk', 'ip', $id );
2232 $wgMemc->set( $key, $val ? 1 : 0, 1800 );
2233 }
2234 if ( $changed ) {
2235 $this->invalidateCache();
2236 }
2237 }
2238
2239 /**
2240 * Generate a current or new-future timestamp to be stored in the
2241 * user_touched field when we update things.
2242 * @return string Timestamp in TS_MW format
2243 */
2244 private function newTouchedTimestamp() {
2245 global $wgClockSkewFudge;
2246
2247 $time = wfTimestamp( TS_MW, time() + $wgClockSkewFudge );
2248 if ( $this->mTouched && $time <= $this->mTouched ) {
2249 $time = wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $this->mTouched ) + 1 );
2250 }
2251
2252 return $time;
2253 }
2254
2255 /**
2256 * Clear user data from memcached.
2257 * Use after applying fun updates to the database; caller's
2258 * responsibility to update user_touched if appropriate.
2259 *
2260 * Called implicitly from invalidateCache() and saveSettings().
2261 */
2262 public function clearSharedCache() {
2263 global $wgMemc;
2264
2265 $this->load();
2266 if ( $this->mId ) {
2267 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId ) );
2268 }
2269 }
2270
2271 /**
2272 * Immediately touch the user data cache for this account
2273 *
2274 * Calls touch() and removes account data from memcached
2275 */
2276 public function invalidateCache() {
2277 $this->touch();
2278 $this->clearSharedCache();
2279 }
2280
2281 /**
2282 * Update the "touched" timestamp for the user
2283 *
2284 * This is useful on various login/logout events when making sure that
2285 * a browser or proxy that has multiple tenants does not suffer cache
2286 * pollution where the new user sees the old users content. The value
2287 * of getTouched() is checked when determining 304 vs 200 responses.
2288 * Unlike invalidateCache(), this preserves the User object cache and
2289 * avoids database writes.
2290 *
2291 * @since 1.25
2292 */
2293 public function touch() {
2294 global $wgMemc;
2295
2296 $this->load();
2297
2298 if ( $this->mId ) {
2299 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId );
2300 $timestamp = $this->newTouchedTimestamp();
2301 $wgMemc->set( $key, $timestamp );
2302 $this->mQuickTouched = $timestamp;
2303 }
2304 }
2305
2306 /**
2307 * Validate the cache for this account.
2308 * @param string $timestamp A timestamp in TS_MW format
2309 * @return bool
2310 */
2311 public function validateCache( $timestamp ) {
2312 return ( $timestamp >= $this->getTouched() );
2313 }
2314
2315 /**
2316 * Get the user touched timestamp
2317 * @return string TS_MW Timestamp
2318 */
2319 public function getTouched() {
2320 global $wgMemc;
2321
2322 $this->load();
2323
2324 if ( $this->mId ) {
2325 if ( $this->mQuickTouched === null ) {
2326 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId );
2327 $timestamp = $wgMemc->get( $key );
2328 if ( $timestamp ) {
2329 $this->mQuickTouched = $timestamp;
2330 } else {
2331 # Set the timestamp to get HTTP 304 cache hits
2332 $this->touch();
2333 }
2334 }
2335
2336 return max( $this->mTouched, $this->mQuickTouched );
2337 }
2338
2339 return $this->mTouched;
2340 }
2341
2342 /**
2343 * @return Password
2344 * @since 1.24
2345 */
2346 public function getPassword() {
2347 $this->loadPasswords();
2348
2349 return $this->mPassword;
2350 }
2351
2352 /**
2353 * @return Password
2354 * @since 1.24
2355 */
2356 public function getTemporaryPassword() {
2357 $this->loadPasswords();
2358
2359 return $this->mNewpassword;
2360 }
2361
2362 /**
2363 * Set the password and reset the random token.
2364 * Calls through to authentication plugin if necessary;
2365 * will have no effect if the auth plugin refuses to
2366 * pass the change through or if the legal password
2367 * checks fail.
2368 *
2369 * As a special case, setting the password to null
2370 * wipes it, so the account cannot be logged in until
2371 * a new password is set, for instance via e-mail.
2372 *
2373 * @param string $str New password to set
2374 * @throws PasswordError On failure
2375 *
2376 * @return bool
2377 */
2378 public function setPassword( $str ) {
2379 global $wgAuth;
2380
2381 $this->loadPasswords();
2382
2383 if ( $str !== null ) {
2384 if ( !$wgAuth->allowPasswordChange() ) {
2385 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2386 }
2387
2388 $status = $this->checkPasswordValidity( $str );
2389 if ( !$status->isGood() ) {
2390 throw new PasswordError( $status->getMessage()->text() );
2391 }
2392 }
2393
2394 if ( !$wgAuth->setPassword( $this, $str ) ) {
2395 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2396 }
2397
2398 $this->setInternalPassword( $str );
2399
2400 return true;
2401 }
2402
2403 /**
2404 * Set the password and reset the random token unconditionally.
2405 *
2406 * @param string|null $str New password to set or null to set an invalid
2407 * password hash meaning that the user will not be able to log in
2408 * through the web interface.
2409 */
2410 public function setInternalPassword( $str ) {
2411 $this->setToken();
2412
2413 $passwordFactory = self::getPasswordFactory();
2414 $this->mPassword = $passwordFactory->newFromPlaintext( $str );
2415
2416 $this->mNewpassword = $passwordFactory->newFromCiphertext( null );
2417 $this->mNewpassTime = null;
2418 }
2419
2420 /**
2421 * Get the user's current token.
2422 * @param bool $forceCreation Force the generation of a new token if the
2423 * user doesn't have one (default=true for backwards compatibility).
2424 * @return string Token
2425 */
2426 public function getToken( $forceCreation = true ) {
2427 $this->load();
2428 if ( !$this->mToken && $forceCreation ) {
2429 $this->setToken();
2430 }
2431 return $this->mToken;
2432 }
2433
2434 /**
2435 * Set the random token (used for persistent authentication)
2436 * Called from loadDefaults() among other places.
2437 *
2438 * @param string|bool $token If specified, set the token to this value
2439 */
2440 public function setToken( $token = false ) {
2441 $this->load();
2442 if ( !$token ) {
2443 $this->mToken = MWCryptRand::generateHex( self::TOKEN_LENGTH );
2444 } else {
2445 $this->mToken = $token;
2446 }
2447 }
2448
2449 /**
2450 * Set the password for a password reminder or new account email
2451 *
2452 * @param string $str New password to set or null to set an invalid
2453 * password hash meaning that the user will not be able to use it
2454 * @param bool $throttle If true, reset the throttle timestamp to the present
2455 */
2456 public function setNewpassword( $str, $throttle = true ) {
2457 $this->loadPasswords();
2458
2459 $this->mNewpassword = self::getPasswordFactory()->newFromPlaintext( $str );
2460 if ( $str === null ) {
2461 $this->mNewpassTime = null;
2462 } elseif ( $throttle ) {
2463 $this->mNewpassTime = wfTimestampNow();
2464 }
2465 }
2466
2467 /**
2468 * Has password reminder email been sent within the last
2469 * $wgPasswordReminderResendTime hours?
2470 * @return bool
2471 */
2472 public function isPasswordReminderThrottled() {
2473 global $wgPasswordReminderResendTime;
2474 $this->load();
2475 if ( !$this->mNewpassTime || !$wgPasswordReminderResendTime ) {
2476 return false;
2477 }
2478 $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgPasswordReminderResendTime * 3600;
2479 return time() < $expiry;
2480 }
2481
2482 /**
2483 * Get the user's e-mail address
2484 * @return string User's email address
2485 */
2486 public function getEmail() {
2487 $this->load();
2488 Hooks::run( 'UserGetEmail', array( $this, &$this->mEmail ) );
2489 return $this->mEmail;
2490 }
2491
2492 /**
2493 * Get the timestamp of the user's e-mail authentication
2494 * @return string TS_MW timestamp
2495 */
2496 public function getEmailAuthenticationTimestamp() {
2497 $this->load();
2498 Hooks::run( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
2499 return $this->mEmailAuthenticated;
2500 }
2501
2502 /**
2503 * Set the user's e-mail address
2504 * @param string $str New e-mail address
2505 */
2506 public function setEmail( $str ) {
2507 $this->load();
2508 if ( $str == $this->mEmail ) {
2509 return;
2510 }
2511 $this->invalidateEmail();
2512 $this->mEmail = $str;
2513 Hooks::run( 'UserSetEmail', array( $this, &$this->mEmail ) );
2514 }
2515
2516 /**
2517 * Set the user's e-mail address and a confirmation mail if needed.
2518 *
2519 * @since 1.20
2520 * @param string $str New e-mail address
2521 * @return Status
2522 */
2523 public function setEmailWithConfirmation( $str ) {
2524 global $wgEnableEmail, $wgEmailAuthentication;
2525
2526 if ( !$wgEnableEmail ) {
2527 return Status::newFatal( 'emaildisabled' );
2528 }
2529
2530 $oldaddr = $this->getEmail();
2531 if ( $str === $oldaddr ) {
2532 return Status::newGood( true );
2533 }
2534
2535 $this->setEmail( $str );
2536
2537 if ( $str !== '' && $wgEmailAuthentication ) {
2538 // Send a confirmation request to the new address if needed
2539 $type = $oldaddr != '' ? 'changed' : 'set';
2540 $result = $this->sendConfirmationMail( $type );
2541 if ( $result->isGood() ) {
2542 // Say to the caller that a confirmation mail has been sent
2543 $result->value = 'eauth';
2544 }
2545 } else {
2546 $result = Status::newGood( true );
2547 }
2548
2549 return $result;
2550 }
2551
2552 /**
2553 * Get the user's real name
2554 * @return string User's real name
2555 */
2556 public function getRealName() {
2557 if ( !$this->isItemLoaded( 'realname' ) ) {
2558 $this->load();
2559 }
2560
2561 return $this->mRealName;
2562 }
2563
2564 /**
2565 * Set the user's real name
2566 * @param string $str New real name
2567 */
2568 public function setRealName( $str ) {
2569 $this->load();
2570 $this->mRealName = $str;
2571 }
2572
2573 /**
2574 * Get the user's current setting for a given option.
2575 *
2576 * @param string $oname The option to check
2577 * @param string $defaultOverride A default value returned if the option does not exist
2578 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2579 * @return string User's current value for the option
2580 * @see getBoolOption()
2581 * @see getIntOption()
2582 */
2583 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2584 global $wgHiddenPrefs;
2585 $this->loadOptions();
2586
2587 # We want 'disabled' preferences to always behave as the default value for
2588 # users, even if they have set the option explicitly in their settings (ie they
2589 # set it, and then it was disabled removing their ability to change it). But
2590 # we don't want to erase the preferences in the database in case the preference
2591 # is re-enabled again. So don't touch $mOptions, just override the returned value
2592 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2593 return self::getDefaultOption( $oname );
2594 }
2595
2596 if ( array_key_exists( $oname, $this->mOptions ) ) {
2597 return $this->mOptions[$oname];
2598 } else {
2599 return $defaultOverride;
2600 }
2601 }
2602
2603 /**
2604 * Get all user's options
2605 *
2606 * @param int $flags Bitwise combination of:
2607 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2608 * to the default value. (Since 1.25)
2609 * @return array
2610 */
2611 public function getOptions( $flags = 0 ) {
2612 global $wgHiddenPrefs;
2613 $this->loadOptions();
2614 $options = $this->mOptions;
2615
2616 # We want 'disabled' preferences to always behave as the default value for
2617 # users, even if they have set the option explicitly in their settings (ie they
2618 # set it, and then it was disabled removing their ability to change it). But
2619 # we don't want to erase the preferences in the database in case the preference
2620 # is re-enabled again. So don't touch $mOptions, just override the returned value
2621 foreach ( $wgHiddenPrefs as $pref ) {
2622 $default = self::getDefaultOption( $pref );
2623 if ( $default !== null ) {
2624 $options[$pref] = $default;
2625 }
2626 }
2627
2628 if ( $flags & self::GETOPTIONS_EXCLUDE_DEFAULTS ) {
2629 $options = array_diff_assoc( $options, self::getDefaultOptions() );
2630 }
2631
2632 return $options;
2633 }
2634
2635 /**
2636 * Get the user's current setting for a given option, as a boolean value.
2637 *
2638 * @param string $oname The option to check
2639 * @return bool User's current value for the option
2640 * @see getOption()
2641 */
2642 public function getBoolOption( $oname ) {
2643 return (bool)$this->getOption( $oname );
2644 }
2645
2646 /**
2647 * Get the user's current setting for a given option, as an integer value.
2648 *
2649 * @param string $oname The option to check
2650 * @param int $defaultOverride A default value returned if the option does not exist
2651 * @return int User's current value for the option
2652 * @see getOption()
2653 */
2654 public function getIntOption( $oname, $defaultOverride = 0 ) {
2655 $val = $this->getOption( $oname );
2656 if ( $val == '' ) {
2657 $val = $defaultOverride;
2658 }
2659 return intval( $val );
2660 }
2661
2662 /**
2663 * Set the given option for a user.
2664 *
2665 * You need to call saveSettings() to actually write to the database.
2666 *
2667 * @param string $oname The option to set
2668 * @param mixed $val New value to set
2669 */
2670 public function setOption( $oname, $val ) {
2671 $this->loadOptions();
2672
2673 // Explicitly NULL values should refer to defaults
2674 if ( is_null( $val ) ) {
2675 $val = self::getDefaultOption( $oname );
2676 }
2677
2678 $this->mOptions[$oname] = $val;
2679 }
2680
2681 /**
2682 * Get a token stored in the preferences (like the watchlist one),
2683 * resetting it if it's empty (and saving changes).
2684 *
2685 * @param string $oname The option name to retrieve the token from
2686 * @return string|bool User's current value for the option, or false if this option is disabled.
2687 * @see resetTokenFromOption()
2688 * @see getOption()
2689 */
2690 public function getTokenFromOption( $oname ) {
2691 global $wgHiddenPrefs;
2692 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2693 return false;
2694 }
2695
2696 $token = $this->getOption( $oname );
2697 if ( !$token ) {
2698 $token = $this->resetTokenFromOption( $oname );
2699 if ( !wfReadOnly() ) {
2700 $this->saveSettings();
2701 }
2702 }
2703 return $token;
2704 }
2705
2706 /**
2707 * Reset a token stored in the preferences (like the watchlist one).
2708 * *Does not* save user's preferences (similarly to setOption()).
2709 *
2710 * @param string $oname The option name to reset the token in
2711 * @return string|bool New token value, or false if this option is disabled.
2712 * @see getTokenFromOption()
2713 * @see setOption()
2714 */
2715 public function resetTokenFromOption( $oname ) {
2716 global $wgHiddenPrefs;
2717 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2718 return false;
2719 }
2720
2721 $token = MWCryptRand::generateHex( 40 );
2722 $this->setOption( $oname, $token );
2723 return $token;
2724 }
2725
2726 /**
2727 * Return a list of the types of user options currently returned by
2728 * User::getOptionKinds().
2729 *
2730 * Currently, the option kinds are:
2731 * - 'registered' - preferences which are registered in core MediaWiki or
2732 * by extensions using the UserGetDefaultOptions hook.
2733 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2734 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2735 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2736 * be used by user scripts.
2737 * - 'special' - "preferences" that are not accessible via User::getOptions
2738 * or User::setOptions.
2739 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2740 * These are usually legacy options, removed in newer versions.
2741 *
2742 * The API (and possibly others) use this function to determine the possible
2743 * option types for validation purposes, so make sure to update this when a
2744 * new option kind is added.
2745 *
2746 * @see User::getOptionKinds
2747 * @return array Option kinds
2748 */
2749 public static function listOptionKinds() {
2750 return array(
2751 'registered',
2752 'registered-multiselect',
2753 'registered-checkmatrix',
2754 'userjs',
2755 'special',
2756 'unused'
2757 );
2758 }
2759
2760 /**
2761 * Return an associative array mapping preferences keys to the kind of a preference they're
2762 * used for. Different kinds are handled differently when setting or reading preferences.
2763 *
2764 * See User::listOptionKinds for the list of valid option types that can be provided.
2765 *
2766 * @see User::listOptionKinds
2767 * @param IContextSource $context
2768 * @param array $options Assoc. array with options keys to check as keys.
2769 * Defaults to $this->mOptions.
2770 * @return array The key => kind mapping data
2771 */
2772 public function getOptionKinds( IContextSource $context, $options = null ) {
2773 $this->loadOptions();
2774 if ( $options === null ) {
2775 $options = $this->mOptions;
2776 }
2777
2778 $prefs = Preferences::getPreferences( $this, $context );
2779 $mapping = array();
2780
2781 // Pull out the "special" options, so they don't get converted as
2782 // multiselect or checkmatrix.
2783 $specialOptions = array_fill_keys( Preferences::getSaveBlacklist(), true );
2784 foreach ( $specialOptions as $name => $value ) {
2785 unset( $prefs[$name] );
2786 }
2787
2788 // Multiselect and checkmatrix options are stored in the database with
2789 // one key per option, each having a boolean value. Extract those keys.
2790 $multiselectOptions = array();
2791 foreach ( $prefs as $name => $info ) {
2792 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2793 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2794 $opts = HTMLFormField::flattenOptions( $info['options'] );
2795 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
2796
2797 foreach ( $opts as $value ) {
2798 $multiselectOptions["$prefix$value"] = true;
2799 }
2800
2801 unset( $prefs[$name] );
2802 }
2803 }
2804 $checkmatrixOptions = array();
2805 foreach ( $prefs as $name => $info ) {
2806 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2807 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2808 $columns = HTMLFormField::flattenOptions( $info['columns'] );
2809 $rows = HTMLFormField::flattenOptions( $info['rows'] );
2810 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
2811
2812 foreach ( $columns as $column ) {
2813 foreach ( $rows as $row ) {
2814 $checkmatrixOptions["$prefix$column-$row"] = true;
2815 }
2816 }
2817
2818 unset( $prefs[$name] );
2819 }
2820 }
2821
2822 // $value is ignored
2823 foreach ( $options as $key => $value ) {
2824 if ( isset( $prefs[$key] ) ) {
2825 $mapping[$key] = 'registered';
2826 } elseif ( isset( $multiselectOptions[$key] ) ) {
2827 $mapping[$key] = 'registered-multiselect';
2828 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
2829 $mapping[$key] = 'registered-checkmatrix';
2830 } elseif ( isset( $specialOptions[$key] ) ) {
2831 $mapping[$key] = 'special';
2832 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2833 $mapping[$key] = 'userjs';
2834 } else {
2835 $mapping[$key] = 'unused';
2836 }
2837 }
2838
2839 return $mapping;
2840 }
2841
2842 /**
2843 * Reset certain (or all) options to the site defaults
2844 *
2845 * The optional parameter determines which kinds of preferences will be reset.
2846 * Supported values are everything that can be reported by getOptionKinds()
2847 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2848 *
2849 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
2850 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
2851 * for backwards-compatibility.
2852 * @param IContextSource|null $context Context source used when $resetKinds
2853 * does not contain 'all', passed to getOptionKinds().
2854 * Defaults to RequestContext::getMain() when null.
2855 */
2856 public function resetOptions(
2857 $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ),
2858 IContextSource $context = null
2859 ) {
2860 $this->load();
2861 $defaultOptions = self::getDefaultOptions();
2862
2863 if ( !is_array( $resetKinds ) ) {
2864 $resetKinds = array( $resetKinds );
2865 }
2866
2867 if ( in_array( 'all', $resetKinds ) ) {
2868 $newOptions = $defaultOptions;
2869 } else {
2870 if ( $context === null ) {
2871 $context = RequestContext::getMain();
2872 }
2873
2874 $optionKinds = $this->getOptionKinds( $context );
2875 $resetKinds = array_intersect( $resetKinds, self::listOptionKinds() );
2876 $newOptions = array();
2877
2878 // Use default values for the options that should be deleted, and
2879 // copy old values for the ones that shouldn't.
2880 foreach ( $this->mOptions as $key => $value ) {
2881 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2882 if ( array_key_exists( $key, $defaultOptions ) ) {
2883 $newOptions[$key] = $defaultOptions[$key];
2884 }
2885 } else {
2886 $newOptions[$key] = $value;
2887 }
2888 }
2889 }
2890
2891 Hooks::run( 'UserResetAllOptions', array( $this, &$newOptions, $this->mOptions, $resetKinds ) );
2892
2893 $this->mOptions = $newOptions;
2894 $this->mOptionsLoaded = true;
2895 }
2896
2897 /**
2898 * Get the user's preferred date format.
2899 * @return string User's preferred date format
2900 */
2901 public function getDatePreference() {
2902 // Important migration for old data rows
2903 if ( is_null( $this->mDatePreference ) ) {
2904 global $wgLang;
2905 $value = $this->getOption( 'date' );
2906 $map = $wgLang->getDatePreferenceMigrationMap();
2907 if ( isset( $map[$value] ) ) {
2908 $value = $map[$value];
2909 }
2910 $this->mDatePreference = $value;
2911 }
2912 return $this->mDatePreference;
2913 }
2914
2915 /**
2916 * Determine based on the wiki configuration and the user's options,
2917 * whether this user must be over HTTPS no matter what.
2918 *
2919 * @return bool
2920 */
2921 public function requiresHTTPS() {
2922 global $wgSecureLogin;
2923 if ( !$wgSecureLogin ) {
2924 return false;
2925 } else {
2926 $https = $this->getBoolOption( 'prefershttps' );
2927 Hooks::run( 'UserRequiresHTTPS', array( $this, &$https ) );
2928 if ( $https ) {
2929 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
2930 }
2931 return $https;
2932 }
2933 }
2934
2935 /**
2936 * Get the user preferred stub threshold
2937 *
2938 * @return int
2939 */
2940 public function getStubThreshold() {
2941 global $wgMaxArticleSize; # Maximum article size, in Kb
2942 $threshold = $this->getIntOption( 'stubthreshold' );
2943 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2944 // If they have set an impossible value, disable the preference
2945 // so we can use the parser cache again.
2946 $threshold = 0;
2947 }
2948 return $threshold;
2949 }
2950
2951 /**
2952 * Get the permissions this user has.
2953 * @return array Array of String permission names
2954 */
2955 public function getRights() {
2956 if ( is_null( $this->mRights ) ) {
2957 $this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() );
2958 Hooks::run( 'UserGetRights', array( $this, &$this->mRights ) );
2959 // Force reindexation of rights when a hook has unset one of them
2960 $this->mRights = array_values( array_unique( $this->mRights ) );
2961 }
2962 return $this->mRights;
2963 }
2964
2965 /**
2966 * Get the list of explicit group memberships this user has.
2967 * The implicit * and user groups are not included.
2968 * @return array Array of String internal group names
2969 */
2970 public function getGroups() {
2971 $this->load();
2972 $this->loadGroups();
2973 return $this->mGroups;
2974 }
2975
2976 /**
2977 * Get the list of implicit group memberships this user has.
2978 * This includes all explicit groups, plus 'user' if logged in,
2979 * '*' for all accounts, and autopromoted groups
2980 * @param bool $recache Whether to avoid the cache
2981 * @return array Array of String internal group names
2982 */
2983 public function getEffectiveGroups( $recache = false ) {
2984 if ( $recache || is_null( $this->mEffectiveGroups ) ) {
2985 $this->mEffectiveGroups = array_unique( array_merge(
2986 $this->getGroups(), // explicit groups
2987 $this->getAutomaticGroups( $recache ) // implicit groups
2988 ) );
2989 // Hook for additional groups
2990 Hooks::run( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups ) );
2991 // Force reindexation of groups when a hook has unset one of them
2992 $this->mEffectiveGroups = array_values( array_unique( $this->mEffectiveGroups ) );
2993 }
2994 return $this->mEffectiveGroups;
2995 }
2996
2997 /**
2998 * Get the list of implicit group memberships this user has.
2999 * This includes 'user' if logged in, '*' for all accounts,
3000 * and autopromoted groups
3001 * @param bool $recache Whether to avoid the cache
3002 * @return array Array of String internal group names
3003 */
3004 public function getAutomaticGroups( $recache = false ) {
3005 if ( $recache || is_null( $this->mImplicitGroups ) ) {
3006 $this->mImplicitGroups = array( '*' );
3007 if ( $this->getId() ) {
3008 $this->mImplicitGroups[] = 'user';
3009
3010 $this->mImplicitGroups = array_unique( array_merge(
3011 $this->mImplicitGroups,
3012 Autopromote::getAutopromoteGroups( $this )
3013 ) );
3014 }
3015 if ( $recache ) {
3016 // Assure data consistency with rights/groups,
3017 // as getEffectiveGroups() depends on this function
3018 $this->mEffectiveGroups = null;
3019 }
3020 }
3021 return $this->mImplicitGroups;
3022 }
3023
3024 /**
3025 * Returns the groups the user has belonged to.
3026 *
3027 * The user may still belong to the returned groups. Compare with getGroups().
3028 *
3029 * The function will not return groups the user had belonged to before MW 1.17
3030 *
3031 * @return array Names of the groups the user has belonged to.
3032 */
3033 public function getFormerGroups() {
3034 $this->load();
3035
3036 if ( is_null( $this->mFormerGroups ) ) {
3037 $db = ( $this->queryFlagsUsed & self::READ_LATEST )
3038 ? wfGetDB( DB_MASTER )
3039 : wfGetDB( DB_SLAVE );
3040 $res = $db->select( 'user_former_groups',
3041 array( 'ufg_group' ),
3042 array( 'ufg_user' => $this->mId ),
3043 __METHOD__ );
3044 $this->mFormerGroups = array();
3045 foreach ( $res as $row ) {
3046 $this->mFormerGroups[] = $row->ufg_group;
3047 }
3048 }
3049
3050 return $this->mFormerGroups;
3051 }
3052
3053 /**
3054 * Get the user's edit count.
3055 * @return int|null Null for anonymous users
3056 */
3057 public function getEditCount() {
3058 if ( !$this->getId() ) {
3059 return null;
3060 }
3061
3062 if ( $this->mEditCount === null ) {
3063 /* Populate the count, if it has not been populated yet */
3064 $dbr = wfGetDB( DB_SLAVE );
3065 // check if the user_editcount field has been initialized
3066 $count = $dbr->selectField(
3067 'user', 'user_editcount',
3068 array( 'user_id' => $this->mId ),
3069 __METHOD__
3070 );
3071
3072 if ( $count === null ) {
3073 // it has not been initialized. do so.
3074 $count = $this->initEditCount();
3075 }
3076 $this->mEditCount = $count;
3077 }
3078 return (int)$this->mEditCount;
3079 }
3080
3081 /**
3082 * Add the user to the given group.
3083 * This takes immediate effect.
3084 * @param string $group Name of the group to add
3085 * @return bool
3086 */
3087 public function addGroup( $group ) {
3088 $this->load();
3089
3090 if ( !Hooks::run( 'UserAddGroup', array( $this, &$group ) ) ) {
3091 return false;
3092 }
3093
3094 $dbw = wfGetDB( DB_MASTER );
3095 if ( $this->getId() ) {
3096 $dbw->insert( 'user_groups',
3097 array(
3098 'ug_user' => $this->getID(),
3099 'ug_group' => $group,
3100 ),
3101 __METHOD__,
3102 array( 'IGNORE' ) );
3103 }
3104
3105 $this->loadGroups();
3106 $this->mGroups[] = $group;
3107 // In case loadGroups was not called before, we now have the right twice.
3108 // Get rid of the duplicate.
3109 $this->mGroups = array_unique( $this->mGroups );
3110
3111 // Refresh the groups caches, and clear the rights cache so it will be
3112 // refreshed on the next call to $this->getRights().
3113 $this->getEffectiveGroups( true );
3114 $this->mRights = null;
3115
3116 $this->invalidateCache();
3117
3118 return true;
3119 }
3120
3121 /**
3122 * Remove the user from the given group.
3123 * This takes immediate effect.
3124 * @param string $group Name of the group to remove
3125 * @return bool
3126 */
3127 public function removeGroup( $group ) {
3128 $this->load();
3129 if ( !Hooks::run( 'UserRemoveGroup', array( $this, &$group ) ) ) {
3130 return false;
3131 }
3132
3133 $dbw = wfGetDB( DB_MASTER );
3134 $dbw->delete( 'user_groups',
3135 array(
3136 'ug_user' => $this->getID(),
3137 'ug_group' => $group,
3138 ), __METHOD__
3139 );
3140 // Remember that the user was in this group
3141 $dbw->insert( 'user_former_groups',
3142 array(
3143 'ufg_user' => $this->getID(),
3144 'ufg_group' => $group,
3145 ),
3146 __METHOD__,
3147 array( 'IGNORE' )
3148 );
3149
3150 $this->loadGroups();
3151 $this->mGroups = array_diff( $this->mGroups, array( $group ) );
3152
3153 // Refresh the groups caches, and clear the rights cache so it will be
3154 // refreshed on the next call to $this->getRights().
3155 $this->getEffectiveGroups( true );
3156 $this->mRights = null;
3157
3158 $this->invalidateCache();
3159
3160 return true;
3161 }
3162
3163 /**
3164 * Get whether the user is logged in
3165 * @return bool
3166 */
3167 public function isLoggedIn() {
3168 return $this->getID() != 0;
3169 }
3170
3171 /**
3172 * Get whether the user is anonymous
3173 * @return bool
3174 */
3175 public function isAnon() {
3176 return !$this->isLoggedIn();
3177 }
3178
3179 /**
3180 * Check if user is allowed to access a feature / make an action
3181 *
3182 * @param string $permissions,... Permissions to test
3183 * @return bool True if user is allowed to perform *any* of the given actions
3184 */
3185 public function isAllowedAny( /*...*/ ) {
3186 $permissions = func_get_args();
3187 foreach ( $permissions as $permission ) {
3188 if ( $this->isAllowed( $permission ) ) {
3189 return true;
3190 }
3191 }
3192 return false;
3193 }
3194
3195 /**
3196 *
3197 * @param string $permissions,... Permissions to test
3198 * @return bool True if the user is allowed to perform *all* of the given actions
3199 */
3200 public function isAllowedAll( /*...*/ ) {
3201 $permissions = func_get_args();
3202 foreach ( $permissions as $permission ) {
3203 if ( !$this->isAllowed( $permission ) ) {
3204 return false;
3205 }
3206 }
3207 return true;
3208 }
3209
3210 /**
3211 * Internal mechanics of testing a permission
3212 * @param string $action
3213 * @return bool
3214 */
3215 public function isAllowed( $action = '' ) {
3216 if ( $action === '' ) {
3217 return true; // In the spirit of DWIM
3218 }
3219 // Patrolling may not be enabled
3220 if ( $action === 'patrol' || $action === 'autopatrol' ) {
3221 global $wgUseRCPatrol, $wgUseNPPatrol;
3222 if ( !$wgUseRCPatrol && !$wgUseNPPatrol ) {
3223 return false;
3224 }
3225 }
3226 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3227 // by misconfiguration: 0 == 'foo'
3228 return in_array( $action, $this->getRights(), true );
3229 }
3230
3231 /**
3232 * Check whether to enable recent changes patrol features for this user
3233 * @return bool True or false
3234 */
3235 public function useRCPatrol() {
3236 global $wgUseRCPatrol;
3237 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3238 }
3239
3240 /**
3241 * Check whether to enable new pages patrol features for this user
3242 * @return bool True or false
3243 */
3244 public function useNPPatrol() {
3245 global $wgUseRCPatrol, $wgUseNPPatrol;
3246 return (
3247 ( $wgUseRCPatrol || $wgUseNPPatrol )
3248 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3249 );
3250 }
3251
3252 /**
3253 * Get the WebRequest object to use with this object
3254 *
3255 * @return WebRequest
3256 */
3257 public function getRequest() {
3258 if ( $this->mRequest ) {
3259 return $this->mRequest;
3260 } else {
3261 global $wgRequest;
3262 return $wgRequest;
3263 }
3264 }
3265
3266 /**
3267 * Get the current skin, loading it if required
3268 * @return Skin The current skin
3269 * @todo FIXME: Need to check the old failback system [AV]
3270 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
3271 */
3272 public function getSkin() {
3273 wfDeprecated( __METHOD__, '1.18' );
3274 return RequestContext::getMain()->getSkin();
3275 }
3276
3277 /**
3278 * Get a WatchedItem for this user and $title.
3279 *
3280 * @since 1.22 $checkRights parameter added
3281 * @param Title $title
3282 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3283 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3284 * @return WatchedItem
3285 */
3286 public function getWatchedItem( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
3287 $key = $checkRights . ':' . $title->getNamespace() . ':' . $title->getDBkey();
3288
3289 if ( isset( $this->mWatchedItems[$key] ) ) {
3290 return $this->mWatchedItems[$key];
3291 }
3292
3293 if ( count( $this->mWatchedItems ) >= self::MAX_WATCHED_ITEMS_CACHE ) {
3294 $this->mWatchedItems = array();
3295 }
3296
3297 $this->mWatchedItems[$key] = WatchedItem::fromUserTitle( $this, $title, $checkRights );
3298 return $this->mWatchedItems[$key];
3299 }
3300
3301 /**
3302 * Check the watched status of an article.
3303 * @since 1.22 $checkRights parameter added
3304 * @param Title $title Title of the article to look at
3305 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3306 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3307 * @return bool
3308 */
3309 public function isWatched( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
3310 return $this->getWatchedItem( $title, $checkRights )->isWatched();
3311 }
3312
3313 /**
3314 * Watch an article.
3315 * @since 1.22 $checkRights parameter added
3316 * @param Title $title Title of the article to look at
3317 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3318 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3319 */
3320 public function addWatch( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
3321 $this->getWatchedItem( $title, $checkRights )->addWatch();
3322 $this->invalidateCache();
3323 }
3324
3325 /**
3326 * Stop watching an article.
3327 * @since 1.22 $checkRights parameter added
3328 * @param Title $title Title of the article to look at
3329 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3330 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3331 */
3332 public function removeWatch( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
3333 $this->getWatchedItem( $title, $checkRights )->removeWatch();
3334 $this->invalidateCache();
3335 }
3336
3337 /**
3338 * Clear the user's notification timestamp for the given title.
3339 * If e-notif e-mails are on, they will receive notification mails on
3340 * the next change of the page if it's watched etc.
3341 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3342 * @param Title $title Title of the article to look at
3343 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3344 */
3345 public function clearNotification( &$title, $oldid = 0 ) {
3346 global $wgUseEnotif, $wgShowUpdatedMarker;
3347
3348 // Do nothing if the database is locked to writes
3349 if ( wfReadOnly() ) {
3350 return;
3351 }
3352
3353 // Do nothing if not allowed to edit the watchlist
3354 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3355 return;
3356 }
3357
3358 // If we're working on user's talk page, we should update the talk page message indicator
3359 if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
3360 if ( !Hooks::run( 'UserClearNewTalkNotification', array( &$this, $oldid ) ) ) {
3361 return;
3362 }
3363
3364 $nextid = $oldid ? $title->getNextRevisionID( $oldid ) : null;
3365
3366 if ( !$oldid || !$nextid ) {
3367 // If we're looking at the latest revision, we should definitely clear it
3368 $this->setNewtalk( false );
3369 } else {
3370 // Otherwise we should update its revision, if it's present
3371 if ( $this->getNewtalk() ) {
3372 // Naturally the other one won't clear by itself
3373 $this->setNewtalk( false );
3374 $this->setNewtalk( true, Revision::newFromId( $nextid ) );
3375 }
3376 }
3377 }
3378
3379 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3380 return;
3381 }
3382
3383 if ( $this->isAnon() ) {
3384 // Nothing else to do...
3385 return;
3386 }
3387
3388 // Only update the timestamp if the page is being watched.
3389 // The query to find out if it is watched is cached both in memcached and per-invocation,
3390 // and when it does have to be executed, it can be on a slave
3391 // If this is the user's newtalk page, we always update the timestamp
3392 $force = '';
3393 if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
3394 $force = 'force';
3395 }
3396
3397 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force, $oldid );
3398 }
3399
3400 /**
3401 * Resets all of the given user's page-change notification timestamps.
3402 * If e-notif e-mails are on, they will receive notification mails on
3403 * the next change of any watched page.
3404 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3405 */
3406 public function clearAllNotifications() {
3407 if ( wfReadOnly() ) {
3408 return;
3409 }
3410
3411 // Do nothing if not allowed to edit the watchlist
3412 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3413 return;
3414 }
3415
3416 global $wgUseEnotif, $wgShowUpdatedMarker;
3417 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3418 $this->setNewtalk( false );
3419 return;
3420 }
3421 $id = $this->getId();
3422 if ( $id != 0 ) {
3423 $dbw = wfGetDB( DB_MASTER );
3424 $dbw->update( 'watchlist',
3425 array( /* SET */ 'wl_notificationtimestamp' => null ),
3426 array( /* WHERE */ 'wl_user' => $id ),
3427 __METHOD__
3428 );
3429 // We also need to clear here the "you have new message" notification for the own user_talk page;
3430 // it's cleared one page view later in WikiPage::doViewUpdates().
3431 }
3432 }
3433
3434 /**
3435 * Set a cookie on the user's client. Wrapper for
3436 * WebResponse::setCookie
3437 * @param string $name Name of the cookie to set
3438 * @param string $value Value to set
3439 * @param int $exp Expiration time, as a UNIX time value;
3440 * if 0 or not specified, use the default $wgCookieExpiration
3441 * @param bool $secure
3442 * true: Force setting the secure attribute when setting the cookie
3443 * false: Force NOT setting the secure attribute when setting the cookie
3444 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3445 * @param array $params Array of options sent passed to WebResponse::setcookie()
3446 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3447 * is passed.
3448 */
3449 protected function setCookie(
3450 $name, $value, $exp = 0, $secure = null, $params = array(), $request = null
3451 ) {
3452 if ( $request === null ) {
3453 $request = $this->getRequest();
3454 }
3455 $params['secure'] = $secure;
3456 $request->response()->setcookie( $name, $value, $exp, $params );
3457 }
3458
3459 /**
3460 * Clear a cookie on the user's client
3461 * @param string $name Name of the cookie to clear
3462 * @param bool $secure
3463 * true: Force setting the secure attribute when setting the cookie
3464 * false: Force NOT setting the secure attribute when setting the cookie
3465 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3466 * @param array $params Array of options sent passed to WebResponse::setcookie()
3467 */
3468 protected function clearCookie( $name, $secure = null, $params = array() ) {
3469 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3470 }
3471
3472 /**
3473 * Set the default cookies for this session on the user's client.
3474 *
3475 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3476 * is passed.
3477 * @param bool $secure Whether to force secure/insecure cookies or use default
3478 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3479 */
3480 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3481 if ( $request === null ) {
3482 $request = $this->getRequest();
3483 }
3484
3485 $this->load();
3486 if ( 0 == $this->mId ) {
3487 return;
3488 }
3489 if ( !$this->mToken ) {
3490 // When token is empty or NULL generate a new one and then save it to the database
3491 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
3492 // Simply by setting every cell in the user_token column to NULL and letting them be
3493 // regenerated as users log back into the wiki.
3494 $this->setToken();
3495 if ( !wfReadOnly() ) {
3496 $this->saveSettings();
3497 }
3498 }
3499 $session = array(
3500 'wsUserID' => $this->mId,
3501 'wsToken' => $this->mToken,
3502 'wsUserName' => $this->getName()
3503 );
3504 $cookies = array(
3505 'UserID' => $this->mId,
3506 'UserName' => $this->getName(),
3507 );
3508 if ( $rememberMe ) {
3509 $cookies['Token'] = $this->mToken;
3510 } else {
3511 $cookies['Token'] = false;
3512 }
3513
3514 Hooks::run( 'UserSetCookies', array( $this, &$session, &$cookies ) );
3515
3516 foreach ( $session as $name => $value ) {
3517 $request->setSessionData( $name, $value );
3518 }
3519 foreach ( $cookies as $name => $value ) {
3520 if ( $value === false ) {
3521 $this->clearCookie( $name );
3522 } else {
3523 $this->setCookie( $name, $value, 0, $secure, array(), $request );
3524 }
3525 }
3526
3527 /**
3528 * If wpStickHTTPS was selected, also set an insecure cookie that
3529 * will cause the site to redirect the user to HTTPS, if they access
3530 * it over HTTP. Bug 29898. Use an un-prefixed cookie, so it's the same
3531 * as the one set by centralauth (bug 53538). Also set it to session, or
3532 * standard time setting, based on if rememberme was set.
3533 */
3534 if ( $request->getCheck( 'wpStickHTTPS' ) || $this->requiresHTTPS() ) {
3535 $this->setCookie(
3536 'forceHTTPS',
3537 'true',
3538 $rememberMe ? 0 : null,
3539 false,
3540 array( 'prefix' => '' ) // no prefix
3541 );
3542 }
3543 }
3544
3545 /**
3546 * Log this user out.
3547 */
3548 public function logout() {
3549 if ( Hooks::run( 'UserLogout', array( &$this ) ) ) {
3550 $this->doLogout();
3551 }
3552 }
3553
3554 /**
3555 * Clear the user's cookies and session, and reset the instance cache.
3556 * @see logout()
3557 */
3558 public function doLogout() {
3559 $this->clearInstanceCache( 'defaults' );
3560
3561 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3562
3563 $this->clearCookie( 'UserID' );
3564 $this->clearCookie( 'Token' );
3565 $this->clearCookie( 'forceHTTPS', false, array( 'prefix' => '' ) );
3566
3567 // Remember when user logged out, to prevent seeing cached pages
3568 $this->setCookie( 'LoggedOut', time(), time() + 86400 );
3569 }
3570
3571 /**
3572 * Save this user's settings into the database.
3573 * @todo Only rarely do all these fields need to be set!
3574 */
3575 public function saveSettings() {
3576 global $wgAuth;
3577
3578 if ( wfReadOnly() ) {
3579 // @TODO: caller should deal with this instead!
3580 // This should really just be an exception.
3581 MWExceptionHandler::logException( new DBExpectedError(
3582 null,
3583 "Could not update user with ID '{$this->mId}'; DB is read-only."
3584 ) );
3585 return;
3586 }
3587
3588 $this->load();
3589 $this->loadPasswords();
3590 if ( 0 == $this->mId ) {
3591 return; // anon
3592 }
3593
3594 // This method is for updating existing users, so the user should
3595 // have been loaded from the master to begin with to avoid problems.
3596 if ( !( $this->queryFlagsUsed & self::READ_LATEST ) ) {
3597 wfWarn( "Attempting to save slave-loaded User object with ID '{$this->mId}'." );
3598 }
3599
3600 // Get a new user_touched that is higher than the old one.
3601 // This will be used for a CAS check as a last-resort safety
3602 // check against race conditions and slave lag.
3603 $oldTouched = $this->mTouched;
3604 $this->mTouched = $this->newTouchedTimestamp();
3605
3606 if ( !$wgAuth->allowSetLocalPassword() ) {
3607 $this->mPassword = self::getPasswordFactory()->newFromCiphertext( null );
3608 }
3609
3610 $dbw = wfGetDB( DB_MASTER );
3611 $dbw->update( 'user',
3612 array( /* SET */
3613 'user_name' => $this->mName,
3614 'user_password' => $this->mPassword->toString(),
3615 'user_newpassword' => $this->mNewpassword->toString(),
3616 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
3617 'user_real_name' => $this->mRealName,
3618 'user_email' => $this->mEmail,
3619 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
3620 'user_touched' => $dbw->timestamp( $this->mTouched ),
3621 'user_token' => strval( $this->mToken ),
3622 'user_email_token' => $this->mEmailToken,
3623 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ),
3624 'user_password_expires' => $dbw->timestampOrNull( $this->mPasswordExpires ),
3625 ), array( /* WHERE */
3626 'user_id' => $this->mId,
3627 'user_touched' => $dbw->timestamp( $oldTouched ) // CAS check
3628 ), __METHOD__
3629 );
3630
3631 if ( !$dbw->affectedRows() ) {
3632 // User was changed in the meantime or loaded with stale data
3633 MWExceptionHandler::logException( new MWException(
3634 "CAS update failed on user_touched for user ID '{$this->mId}'."
3635 ) );
3636 // Maybe the problem was a missed cache update; clear it to be safe
3637 $this->clearSharedCache();
3638
3639 return;
3640 }
3641
3642 $this->saveOptions();
3643
3644 Hooks::run( 'UserSaveSettings', array( $this ) );
3645 $this->clearSharedCache();
3646 $this->getUserPage()->invalidateCache();
3647 }
3648
3649 /**
3650 * If only this user's username is known, and it exists, return the user ID.
3651 * @return int
3652 */
3653 public function idForName() {
3654 $s = trim( $this->getName() );
3655 if ( $s === '' ) {
3656 return 0;
3657 }
3658
3659 $dbr = wfGetDB( DB_SLAVE );
3660 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__ );
3661 if ( $id === false ) {
3662 $id = 0;
3663 }
3664 return $id;
3665 }
3666
3667 /**
3668 * Add a user to the database, return the user object
3669 *
3670 * @param string $name Username to add
3671 * @param array $params Array of Strings Non-default parameters to save to
3672 * the database as user_* fields:
3673 * - password: The user's password hash. Password logins will be disabled
3674 * if this is omitted.
3675 * - newpassword: Hash for a temporary password that has been mailed to
3676 * the user.
3677 * - email: The user's email address.
3678 * - email_authenticated: The email authentication timestamp.
3679 * - real_name: The user's real name.
3680 * - options: An associative array of non-default options.
3681 * - token: Random authentication token. Do not set.
3682 * - registration: Registration timestamp. Do not set.
3683 *
3684 * @return User|null User object, or null if the username already exists.
3685 */
3686 public static function createNew( $name, $params = array() ) {
3687 $user = new User;
3688 $user->load();
3689 $user->loadPasswords();
3690 $user->setToken(); // init token
3691 if ( isset( $params['options'] ) ) {
3692 $user->mOptions = $params['options'] + (array)$user->mOptions;
3693 unset( $params['options'] );
3694 }
3695 $dbw = wfGetDB( DB_MASTER );
3696 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3697
3698 $fields = array(
3699 'user_id' => $seqVal,
3700 'user_name' => $name,
3701 'user_password' => $user->mPassword->toString(),
3702 'user_newpassword' => $user->mNewpassword->toString(),
3703 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime ),
3704 'user_email' => $user->mEmail,
3705 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
3706 'user_real_name' => $user->mRealName,
3707 'user_token' => strval( $user->mToken ),
3708 'user_registration' => $dbw->timestamp( $user->mRegistration ),
3709 'user_editcount' => 0,
3710 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3711 );
3712 foreach ( $params as $name => $value ) {
3713 $fields["user_$name"] = $value;
3714 }
3715 $dbw->insert( 'user', $fields, __METHOD__, array( 'IGNORE' ) );
3716 if ( $dbw->affectedRows() ) {
3717 $newUser = User::newFromId( $dbw->insertId() );
3718 } else {
3719 $newUser = null;
3720 }
3721 return $newUser;
3722 }
3723
3724 /**
3725 * Add this existing user object to the database. If the user already
3726 * exists, a fatal status object is returned, and the user object is
3727 * initialised with the data from the database.
3728 *
3729 * Previously, this function generated a DB error due to a key conflict
3730 * if the user already existed. Many extension callers use this function
3731 * in code along the lines of:
3732 *
3733 * $user = User::newFromName( $name );
3734 * if ( !$user->isLoggedIn() ) {
3735 * $user->addToDatabase();
3736 * }
3737 * // do something with $user...
3738 *
3739 * However, this was vulnerable to a race condition (bug 16020). By
3740 * initialising the user object if the user exists, we aim to support this
3741 * calling sequence as far as possible.
3742 *
3743 * Note that if the user exists, this function will acquire a write lock,
3744 * so it is still advisable to make the call conditional on isLoggedIn(),
3745 * and to commit the transaction after calling.
3746 *
3747 * @throws MWException
3748 * @return Status
3749 */
3750 public function addToDatabase() {
3751 $this->load();
3752 $this->loadPasswords();
3753 if ( !$this->mToken ) {
3754 $this->setToken(); // init token
3755 }
3756
3757 $this->mTouched = $this->newTouchedTimestamp();
3758
3759 $dbw = wfGetDB( DB_MASTER );
3760 $inWrite = $dbw->writesOrCallbacksPending();
3761 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3762 $dbw->insert( 'user',
3763 array(
3764 'user_id' => $seqVal,
3765 'user_name' => $this->mName,
3766 'user_password' => $this->mPassword->toString(),
3767 'user_newpassword' => $this->mNewpassword->toString(),
3768 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
3769 'user_email' => $this->mEmail,
3770 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
3771 'user_real_name' => $this->mRealName,
3772 'user_token' => strval( $this->mToken ),
3773 'user_registration' => $dbw->timestamp( $this->mRegistration ),
3774 'user_editcount' => 0,
3775 'user_touched' => $dbw->timestamp( $this->mTouched ),
3776 ), __METHOD__,
3777 array( 'IGNORE' )
3778 );
3779 if ( !$dbw->affectedRows() ) {
3780 // The queries below cannot happen in the same REPEATABLE-READ snapshot.
3781 // Handle this by COMMIT, if possible, or by LOCK IN SHARE MODE otherwise.
3782 if ( $inWrite ) {
3783 // Can't commit due to pending writes that may need atomicity.
3784 // This may cause some lock contention unlike the case below.
3785 $options = array( 'LOCK IN SHARE MODE' );
3786 $flags = self::READ_LOCKING;
3787 } else {
3788 // Often, this case happens early in views before any writes when
3789 // using CentralAuth. It's should be OK to commit and break the snapshot.
3790 $dbw->commit( __METHOD__, 'flush' );
3791 $options = array();
3792 $flags = self::READ_LATEST;
3793 }
3794 $this->mId = $dbw->selectField( 'user', 'user_id',
3795 array( 'user_name' => $this->mName ), __METHOD__, $options );
3796 $loaded = false;
3797 if ( $this->mId ) {
3798 if ( $this->loadFromDatabase( $flags ) ) {
3799 $loaded = true;
3800 }
3801 }
3802 if ( !$loaded ) {
3803 throw new MWException( __METHOD__ . ": hit a key conflict attempting " .
3804 "to insert user '{$this->mName}' row, but it was not present in select!" );
3805 }
3806 return Status::newFatal( 'userexists' );
3807 }
3808 $this->mId = $dbw->insertId();
3809
3810 // Clear instance cache other than user table data, which is already accurate
3811 $this->clearInstanceCache();
3812
3813 $this->saveOptions();
3814 return Status::newGood();
3815 }
3816
3817 /**
3818 * If this user is logged-in and blocked,
3819 * block any IP address they've successfully logged in from.
3820 * @return bool A block was spread
3821 */
3822 public function spreadAnyEditBlock() {
3823 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3824 return $this->spreadBlock();
3825 }
3826 return false;
3827 }
3828
3829 /**
3830 * If this (non-anonymous) user is blocked,
3831 * block the IP address they've successfully logged in from.
3832 * @return bool A block was spread
3833 */
3834 protected function spreadBlock() {
3835 wfDebug( __METHOD__ . "()\n" );
3836 $this->load();
3837 if ( $this->mId == 0 ) {
3838 return false;
3839 }
3840
3841 $userblock = Block::newFromTarget( $this->getName() );
3842 if ( !$userblock ) {
3843 return false;
3844 }
3845
3846 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3847 }
3848
3849 /**
3850 * Get whether the user is explicitly blocked from account creation.
3851 * @return bool|Block
3852 */
3853 public function isBlockedFromCreateAccount() {
3854 $this->getBlockedStatus();
3855 if ( $this->mBlock && $this->mBlock->prevents( 'createaccount' ) ) {
3856 return $this->mBlock;
3857 }
3858
3859 # bug 13611: if the IP address the user is trying to create an account from is
3860 # blocked with createaccount disabled, prevent new account creation there even
3861 # when the user is logged in
3862 if ( $this->mBlockedFromCreateAccount === false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3863 $this->mBlockedFromCreateAccount = Block::newFromTarget( null, $this->getRequest()->getIP() );
3864 }
3865 return $this->mBlockedFromCreateAccount instanceof Block
3866 && $this->mBlockedFromCreateAccount->prevents( 'createaccount' )
3867 ? $this->mBlockedFromCreateAccount
3868 : false;
3869 }
3870
3871 /**
3872 * Get whether the user is blocked from using Special:Emailuser.
3873 * @return bool
3874 */
3875 public function isBlockedFromEmailuser() {
3876 $this->getBlockedStatus();
3877 return $this->mBlock && $this->mBlock->prevents( 'sendemail' );
3878 }
3879
3880 /**
3881 * Get whether the user is allowed to create an account.
3882 * @return bool
3883 */
3884 public function isAllowedToCreateAccount() {
3885 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3886 }
3887
3888 /**
3889 * Get this user's personal page title.
3890 *
3891 * @return Title User's personal page title
3892 */
3893 public function getUserPage() {
3894 return Title::makeTitle( NS_USER, $this->getName() );
3895 }
3896
3897 /**
3898 * Get this user's talk page title.
3899 *
3900 * @return Title User's talk page title
3901 */
3902 public function getTalkPage() {
3903 $title = $this->getUserPage();
3904 return $title->getTalkPage();
3905 }
3906
3907 /**
3908 * Determine whether the user is a newbie. Newbies are either
3909 * anonymous IPs, or the most recently created accounts.
3910 * @return bool
3911 */
3912 public function isNewbie() {
3913 return !$this->isAllowed( 'autoconfirmed' );
3914 }
3915
3916 /**
3917 * Check to see if the given clear-text password is one of the accepted passwords
3918 * @param string $password User password
3919 * @return bool True if the given password is correct, otherwise False
3920 */
3921 public function checkPassword( $password ) {
3922 global $wgAuth, $wgLegacyEncoding;
3923
3924 $this->loadPasswords();
3925
3926 // Some passwords will give a fatal Status, which means there is
3927 // some sort of technical or security reason for this password to
3928 // be completely invalid and should never be checked (e.g., T64685)
3929 if ( !$this->checkPasswordValidity( $password )->isOK() ) {
3930 return false;
3931 }
3932
3933 // Certain authentication plugins do NOT want to save
3934 // domain passwords in a mysql database, so we should
3935 // check this (in case $wgAuth->strict() is false).
3936 if ( $wgAuth->authenticate( $this->getName(), $password ) ) {
3937 return true;
3938 } elseif ( $wgAuth->strict() ) {
3939 // Auth plugin doesn't allow local authentication
3940 return false;
3941 } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) {
3942 // Auth plugin doesn't allow local authentication for this user name
3943 return false;
3944 }
3945
3946 if ( !$this->mPassword->equals( $password ) ) {
3947 if ( $wgLegacyEncoding ) {
3948 // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3949 // Check for this with iconv
3950 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3951 if ( $cp1252Password === $password || !$this->mPassword->equals( $cp1252Password ) ) {
3952 return false;
3953 }
3954 } else {
3955 return false;
3956 }
3957 }
3958
3959 $passwordFactory = self::getPasswordFactory();
3960 if ( $passwordFactory->needsUpdate( $this->mPassword ) && !wfReadOnly() ) {
3961 $this->mPassword = $passwordFactory->newFromPlaintext( $password );
3962 $this->saveSettings();
3963 }
3964
3965 return true;
3966 }
3967
3968 /**
3969 * Check if the given clear-text password matches the temporary password
3970 * sent by e-mail for password reset operations.
3971 *
3972 * @param string $plaintext
3973 *
3974 * @return bool True if matches, false otherwise
3975 */
3976 public function checkTemporaryPassword( $plaintext ) {
3977 global $wgNewPasswordExpiry;
3978
3979 $this->load();
3980 $this->loadPasswords();
3981 if ( $this->mNewpassword->equals( $plaintext ) ) {
3982 if ( is_null( $this->mNewpassTime ) ) {
3983 return true;
3984 }
3985 $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgNewPasswordExpiry;
3986 return ( time() < $expiry );
3987 } else {
3988 return false;
3989 }
3990 }
3991
3992 /**
3993 * Alias for getEditToken.
3994 * @deprecated since 1.19, use getEditToken instead.
3995 *
3996 * @param string|array $salt Array of Strings Optional function-specific data for hashing
3997 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
3998 * @return string The new edit token
3999 */
4000 public function editToken( $salt = '', $request = null ) {
4001 wfDeprecated( __METHOD__, '1.19' );
4002 return $this->getEditToken( $salt, $request );
4003 }
4004
4005 /**
4006 * Internal implementation for self::getEditToken() and
4007 * self::matchEditToken().
4008 *
4009 * @param string|array $salt
4010 * @param WebRequest $request
4011 * @param string|int $timestamp
4012 * @return string
4013 */
4014 private function getEditTokenAtTimestamp( $salt, $request, $timestamp ) {
4015 if ( $this->isAnon() ) {
4016 return self::EDIT_TOKEN_SUFFIX;
4017 } else {
4018 $token = $request->getSessionData( 'wsEditToken' );
4019 if ( $token === null ) {
4020 $token = MWCryptRand::generateHex( 32 );
4021 $request->setSessionData( 'wsEditToken', $token );
4022 }
4023 if ( is_array( $salt ) ) {
4024 $salt = implode( '|', $salt );
4025 }
4026 return hash_hmac( 'md5', $timestamp . $salt, $token, false ) .
4027 dechex( $timestamp ) .
4028 self::EDIT_TOKEN_SUFFIX;
4029 }
4030 }
4031
4032 /**
4033 * Initialize (if necessary) and return a session token value
4034 * which can be used in edit forms to show that the user's
4035 * login credentials aren't being hijacked with a foreign form
4036 * submission.
4037 *
4038 * @since 1.19
4039 *
4040 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4041 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4042 * @return string The new edit token
4043 */
4044 public function getEditToken( $salt = '', $request = null ) {
4045 return $this->getEditTokenAtTimestamp(
4046 $salt, $request ?: $this->getRequest(), wfTimestamp()
4047 );
4048 }
4049
4050 /**
4051 * Generate a looking random token for various uses.
4052 *
4053 * @return string The new random token
4054 * @deprecated since 1.20: Use MWCryptRand for secure purposes or
4055 * wfRandomString for pseudo-randomness.
4056 */
4057 public static function generateToken() {
4058 return MWCryptRand::generateHex( 32 );
4059 }
4060
4061 /**
4062 * Get the embedded timestamp from a token.
4063 * @param string $val Input token
4064 * @return int|null
4065 */
4066 public static function getEditTokenTimestamp( $val ) {
4067 $suffixLen = strlen( self::EDIT_TOKEN_SUFFIX );
4068 if ( strlen( $val ) <= 32 + $suffixLen ) {
4069 return null;
4070 }
4071
4072 return hexdec( substr( $val, 32, -$suffixLen ) );
4073 }
4074
4075 /**
4076 * Check given value against the token value stored in the session.
4077 * A match should confirm that the form was submitted from the
4078 * user's own login session, not a form submission from a third-party
4079 * site.
4080 *
4081 * @param string $val Input value to compare
4082 * @param string $salt Optional function-specific data for hashing
4083 * @param WebRequest|null $request Object to use or null to use $wgRequest
4084 * @param int $maxage Fail tokens older than this, in seconds
4085 * @return bool Whether the token matches
4086 */
4087 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4088 if ( $this->isAnon() ) {
4089 return $val === self::EDIT_TOKEN_SUFFIX;
4090 }
4091
4092 $timestamp = self::getEditTokenTimestamp( $val );
4093 if ( $timestamp === null ) {
4094 return false;
4095 }
4096 if ( $maxage !== null && $timestamp < wfTimestamp() - $maxage ) {
4097 // Expired token
4098 return false;
4099 }
4100
4101 $sessionToken = $this->getEditTokenAtTimestamp(
4102 $salt, $request ?: $this->getRequest(), $timestamp
4103 );
4104
4105 if ( $val != $sessionToken ) {
4106 wfDebug( "User::matchEditToken: broken session data\n" );
4107 }
4108
4109 return hash_equals( $sessionToken, $val );
4110 }
4111
4112 /**
4113 * Check given value against the token value stored in the session,
4114 * ignoring the suffix.
4115 *
4116 * @param string $val Input value to compare
4117 * @param string $salt Optional function-specific data for hashing
4118 * @param WebRequest|null $request Object to use or null to use $wgRequest
4119 * @param int $maxage Fail tokens older than this, in seconds
4120 * @return bool Whether the token matches
4121 */
4122 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4123 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . self::EDIT_TOKEN_SUFFIX;
4124 return $this->matchEditToken( $val, $salt, $request, $maxage );
4125 }
4126
4127 /**
4128 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4129 * mail to the user's given address.
4130 *
4131 * @param string $type Message to send, either "created", "changed" or "set"
4132 * @return Status
4133 */
4134 public function sendConfirmationMail( $type = 'created' ) {
4135 global $wgLang;
4136 $expiration = null; // gets passed-by-ref and defined in next line.
4137 $token = $this->confirmationToken( $expiration );
4138 $url = $this->confirmationTokenUrl( $token );
4139 $invalidateURL = $this->invalidationTokenUrl( $token );
4140 $this->saveSettings();
4141
4142 if ( $type == 'created' || $type === false ) {
4143 $message = 'confirmemail_body';
4144 } elseif ( $type === true ) {
4145 $message = 'confirmemail_body_changed';
4146 } else {
4147 // Messages: confirmemail_body_changed, confirmemail_body_set
4148 $message = 'confirmemail_body_' . $type;
4149 }
4150
4151 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4152 wfMessage( $message,
4153 $this->getRequest()->getIP(),
4154 $this->getName(),
4155 $url,
4156 $wgLang->timeanddate( $expiration, false ),
4157 $invalidateURL,
4158 $wgLang->date( $expiration, false ),
4159 $wgLang->time( $expiration, false ) )->text() );
4160 }
4161
4162 /**
4163 * Send an e-mail to this user's account. Does not check for
4164 * confirmed status or validity.
4165 *
4166 * @param string $subject Message subject
4167 * @param string $body Message body
4168 * @param string $from Optional From address; if unspecified, default
4169 * $wgPasswordSender will be used.
4170 * @param string $replyto Reply-To address
4171 * @return Status
4172 */
4173 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4174 if ( is_null( $from ) ) {
4175 global $wgPasswordSender;
4176 $sender = new MailAddress( $wgPasswordSender,
4177 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4178 } else {
4179 $sender = MailAddress::newFromUser( $from );
4180 }
4181
4182 $to = MailAddress::newFromUser( $this );
4183 return UserMailer::send( $to, $sender, $subject, $body, $replyto );
4184 }
4185
4186 /**
4187 * Generate, store, and return a new e-mail confirmation code.
4188 * A hash (unsalted, since it's used as a key) is stored.
4189 *
4190 * @note Call saveSettings() after calling this function to commit
4191 * this change to the database.
4192 *
4193 * @param string &$expiration Accepts the expiration time
4194 * @return string New token
4195 */
4196 protected function confirmationToken( &$expiration ) {
4197 global $wgUserEmailConfirmationTokenExpiry;
4198 $now = time();
4199 $expires = $now + $wgUserEmailConfirmationTokenExpiry;
4200 $expiration = wfTimestamp( TS_MW, $expires );
4201 $this->load();
4202 $token = MWCryptRand::generateHex( 32 );
4203 $hash = md5( $token );
4204 $this->mEmailToken = $hash;
4205 $this->mEmailTokenExpires = $expiration;
4206 return $token;
4207 }
4208
4209 /**
4210 * Return a URL the user can use to confirm their email address.
4211 * @param string $token Accepts the email confirmation token
4212 * @return string New token URL
4213 */
4214 protected function confirmationTokenUrl( $token ) {
4215 return $this->getTokenUrl( 'ConfirmEmail', $token );
4216 }
4217
4218 /**
4219 * Return a URL the user can use to invalidate their email address.
4220 * @param string $token Accepts the email confirmation token
4221 * @return string New token URL
4222 */
4223 protected function invalidationTokenUrl( $token ) {
4224 return $this->getTokenUrl( 'InvalidateEmail', $token );
4225 }
4226
4227 /**
4228 * Internal function to format the e-mail validation/invalidation URLs.
4229 * This uses a quickie hack to use the
4230 * hardcoded English names of the Special: pages, for ASCII safety.
4231 *
4232 * @note Since these URLs get dropped directly into emails, using the
4233 * short English names avoids insanely long URL-encoded links, which
4234 * also sometimes can get corrupted in some browsers/mailers
4235 * (bug 6957 with Gmail and Internet Explorer).
4236 *
4237 * @param string $page Special page
4238 * @param string $token Token
4239 * @return string Formatted URL
4240 */
4241 protected function getTokenUrl( $page, $token ) {
4242 // Hack to bypass localization of 'Special:'
4243 $title = Title::makeTitle( NS_MAIN, "Special:$page/$token" );
4244 return $title->getCanonicalURL();
4245 }
4246
4247 /**
4248 * Mark the e-mail address confirmed.
4249 *
4250 * @note Call saveSettings() after calling this function to commit the change.
4251 *
4252 * @return bool
4253 */
4254 public function confirmEmail() {
4255 // Check if it's already confirmed, so we don't touch the database
4256 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4257 if ( !$this->isEmailConfirmed() ) {
4258 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4259 Hooks::run( 'ConfirmEmailComplete', array( $this ) );
4260 }
4261 return true;
4262 }
4263
4264 /**
4265 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4266 * address if it was already confirmed.
4267 *
4268 * @note Call saveSettings() after calling this function to commit the change.
4269 * @return bool Returns true
4270 */
4271 public function invalidateEmail() {
4272 $this->load();
4273 $this->mEmailToken = null;
4274 $this->mEmailTokenExpires = null;
4275 $this->setEmailAuthenticationTimestamp( null );
4276 $this->mEmail = '';
4277 Hooks::run( 'InvalidateEmailComplete', array( $this ) );
4278 return true;
4279 }
4280
4281 /**
4282 * Set the e-mail authentication timestamp.
4283 * @param string $timestamp TS_MW timestamp
4284 */
4285 public function setEmailAuthenticationTimestamp( $timestamp ) {
4286 $this->load();
4287 $this->mEmailAuthenticated = $timestamp;
4288 Hooks::run( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
4289 }
4290
4291 /**
4292 * Is this user allowed to send e-mails within limits of current
4293 * site configuration?
4294 * @return bool
4295 */
4296 public function canSendEmail() {
4297 global $wgEnableEmail, $wgEnableUserEmail;
4298 if ( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
4299 return false;
4300 }
4301 $canSend = $this->isEmailConfirmed();
4302 Hooks::run( 'UserCanSendEmail', array( &$this, &$canSend ) );
4303 return $canSend;
4304 }
4305
4306 /**
4307 * Is this user allowed to receive e-mails within limits of current
4308 * site configuration?
4309 * @return bool
4310 */
4311 public function canReceiveEmail() {
4312 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4313 }
4314
4315 /**
4316 * Is this user's e-mail address valid-looking and confirmed within
4317 * limits of the current site configuration?
4318 *
4319 * @note If $wgEmailAuthentication is on, this may require the user to have
4320 * confirmed their address by returning a code or using a password
4321 * sent to the address from the wiki.
4322 *
4323 * @return bool
4324 */
4325 public function isEmailConfirmed() {
4326 global $wgEmailAuthentication;
4327 $this->load();
4328 $confirmed = true;
4329 if ( Hooks::run( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
4330 if ( $this->isAnon() ) {
4331 return false;
4332 }
4333 if ( !Sanitizer::validateEmail( $this->mEmail ) ) {
4334 return false;
4335 }
4336 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4337 return false;
4338 }
4339 return true;
4340 } else {
4341 return $confirmed;
4342 }
4343 }
4344
4345 /**
4346 * Check whether there is an outstanding request for e-mail confirmation.
4347 * @return bool
4348 */
4349 public function isEmailConfirmationPending() {
4350 global $wgEmailAuthentication;
4351 return $wgEmailAuthentication &&
4352 !$this->isEmailConfirmed() &&
4353 $this->mEmailToken &&
4354 $this->mEmailTokenExpires > wfTimestamp();
4355 }
4356
4357 /**
4358 * Get the timestamp of account creation.
4359 *
4360 * @return string|bool|null Timestamp of account creation, false for
4361 * non-existent/anonymous user accounts, or null if existing account
4362 * but information is not in database.
4363 */
4364 public function getRegistration() {
4365 if ( $this->isAnon() ) {
4366 return false;
4367 }
4368 $this->load();
4369 return $this->mRegistration;
4370 }
4371
4372 /**
4373 * Get the timestamp of the first edit
4374 *
4375 * @return string|bool Timestamp of first edit, or false for
4376 * non-existent/anonymous user accounts.
4377 */
4378 public function getFirstEditTimestamp() {
4379 if ( $this->getId() == 0 ) {
4380 return false; // anons
4381 }
4382 $dbr = wfGetDB( DB_SLAVE );
4383 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4384 array( 'rev_user' => $this->getId() ),
4385 __METHOD__,
4386 array( 'ORDER BY' => 'rev_timestamp ASC' )
4387 );
4388 if ( !$time ) {
4389 return false; // no edits
4390 }
4391 return wfTimestamp( TS_MW, $time );
4392 }
4393
4394 /**
4395 * Get the permissions associated with a given list of groups
4396 *
4397 * @param array $groups Array of Strings List of internal group names
4398 * @return array Array of Strings List of permission key names for given groups combined
4399 */
4400 public static function getGroupPermissions( $groups ) {
4401 global $wgGroupPermissions, $wgRevokePermissions;
4402 $rights = array();
4403 // grant every granted permission first
4404 foreach ( $groups as $group ) {
4405 if ( isset( $wgGroupPermissions[$group] ) ) {
4406 $rights = array_merge( $rights,
4407 // array_filter removes empty items
4408 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4409 }
4410 }
4411 // now revoke the revoked permissions
4412 foreach ( $groups as $group ) {
4413 if ( isset( $wgRevokePermissions[$group] ) ) {
4414 $rights = array_diff( $rights,
4415 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4416 }
4417 }
4418 return array_unique( $rights );
4419 }
4420
4421 /**
4422 * Get all the groups who have a given permission
4423 *
4424 * @param string $role Role to check
4425 * @return array Array of Strings List of internal group names with the given permission
4426 */
4427 public static function getGroupsWithPermission( $role ) {
4428 global $wgGroupPermissions;
4429 $allowedGroups = array();
4430 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4431 if ( self::groupHasPermission( $group, $role ) ) {
4432 $allowedGroups[] = $group;
4433 }
4434 }
4435 return $allowedGroups;
4436 }
4437
4438 /**
4439 * Check, if the given group has the given permission
4440 *
4441 * If you're wanting to check whether all users have a permission, use
4442 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4443 * from anyone.
4444 *
4445 * @since 1.21
4446 * @param string $group Group to check
4447 * @param string $role Role to check
4448 * @return bool
4449 */
4450 public static function groupHasPermission( $group, $role ) {
4451 global $wgGroupPermissions, $wgRevokePermissions;
4452 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4453 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4454 }
4455
4456 /**
4457 * Check if all users have the given permission
4458 *
4459 * @since 1.22
4460 * @param string $right Right to check
4461 * @return bool
4462 */
4463 public static function isEveryoneAllowed( $right ) {
4464 global $wgGroupPermissions, $wgRevokePermissions;
4465 static $cache = array();
4466
4467 // Use the cached results, except in unit tests which rely on
4468 // being able change the permission mid-request
4469 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4470 return $cache[$right];
4471 }
4472
4473 if ( !isset( $wgGroupPermissions['*'][$right] ) || !$wgGroupPermissions['*'][$right] ) {
4474 $cache[$right] = false;
4475 return false;
4476 }
4477
4478 // If it's revoked anywhere, then everyone doesn't have it
4479 foreach ( $wgRevokePermissions as $rights ) {
4480 if ( isset( $rights[$right] ) && $rights[$right] ) {
4481 $cache[$right] = false;
4482 return false;
4483 }
4484 }
4485
4486 // Allow extensions (e.g. OAuth) to say false
4487 if ( !Hooks::run( 'UserIsEveryoneAllowed', array( $right ) ) ) {
4488 $cache[$right] = false;
4489 return false;
4490 }
4491
4492 $cache[$right] = true;
4493 return true;
4494 }
4495
4496 /**
4497 * Get the localized descriptive name for a group, if it exists
4498 *
4499 * @param string $group Internal group name
4500 * @return string Localized descriptive group name
4501 */
4502 public static function getGroupName( $group ) {
4503 $msg = wfMessage( "group-$group" );
4504 return $msg->isBlank() ? $group : $msg->text();
4505 }
4506
4507 /**
4508 * Get the localized descriptive name for a member of a group, if it exists
4509 *
4510 * @param string $group Internal group name
4511 * @param string $username Username for gender (since 1.19)
4512 * @return string Localized name for group member
4513 */
4514 public static function getGroupMember( $group, $username = '#' ) {
4515 $msg = wfMessage( "group-$group-member", $username );
4516 return $msg->isBlank() ? $group : $msg->text();
4517 }
4518
4519 /**
4520 * Return the set of defined explicit groups.
4521 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4522 * are not included, as they are defined automatically, not in the database.
4523 * @return array Array of internal group names
4524 */
4525 public static function getAllGroups() {
4526 global $wgGroupPermissions, $wgRevokePermissions;
4527 return array_diff(
4528 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4529 self::getImplicitGroups()
4530 );
4531 }
4532
4533 /**
4534 * Get a list of all available permissions.
4535 * @return string[] Array of permission names
4536 */
4537 public static function getAllRights() {
4538 if ( self::$mAllRights === false ) {
4539 global $wgAvailableRights;
4540 if ( count( $wgAvailableRights ) ) {
4541 self::$mAllRights = array_unique( array_merge( self::$mCoreRights, $wgAvailableRights ) );
4542 } else {
4543 self::$mAllRights = self::$mCoreRights;
4544 }
4545 Hooks::run( 'UserGetAllRights', array( &self::$mAllRights ) );
4546 }
4547 return self::$mAllRights;
4548 }
4549
4550 /**
4551 * Get a list of implicit groups
4552 * @return array Array of Strings Array of internal group names
4553 */
4554 public static function getImplicitGroups() {
4555 global $wgImplicitGroups;
4556
4557 $groups = $wgImplicitGroups;
4558 # Deprecated, use $wgImplicitGroups instead
4559 Hooks::run( 'UserGetImplicitGroups', array( &$groups ), '1.25' );
4560
4561 return $groups;
4562 }
4563
4564 /**
4565 * Get the title of a page describing a particular group
4566 *
4567 * @param string $group Internal group name
4568 * @return Title|bool Title of the page if it exists, false otherwise
4569 */
4570 public static function getGroupPage( $group ) {
4571 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4572 if ( $msg->exists() ) {
4573 $title = Title::newFromText( $msg->text() );
4574 if ( is_object( $title ) ) {
4575 return $title;
4576 }
4577 }
4578 return false;
4579 }
4580
4581 /**
4582 * Create a link to the group in HTML, if available;
4583 * else return the group name.
4584 *
4585 * @param string $group Internal name of the group
4586 * @param string $text The text of the link
4587 * @return string HTML link to the group
4588 */
4589 public static function makeGroupLinkHTML( $group, $text = '' ) {
4590 if ( $text == '' ) {
4591 $text = self::getGroupName( $group );
4592 }
4593 $title = self::getGroupPage( $group );
4594 if ( $title ) {
4595 return Linker::link( $title, htmlspecialchars( $text ) );
4596 } else {
4597 return htmlspecialchars( $text );
4598 }
4599 }
4600
4601 /**
4602 * Create a link to the group in Wikitext, if available;
4603 * else return the group name.
4604 *
4605 * @param string $group Internal name of the group
4606 * @param string $text The text of the link
4607 * @return string Wikilink to the group
4608 */
4609 public static function makeGroupLinkWiki( $group, $text = '' ) {
4610 if ( $text == '' ) {
4611 $text = self::getGroupName( $group );
4612 }
4613 $title = self::getGroupPage( $group );
4614 if ( $title ) {
4615 $page = $title->getFullText();
4616 return "[[$page|$text]]";
4617 } else {
4618 return $text;
4619 }
4620 }
4621
4622 /**
4623 * Returns an array of the groups that a particular group can add/remove.
4624 *
4625 * @param string $group The group to check for whether it can add/remove
4626 * @return array Array( 'add' => array( addablegroups ),
4627 * 'remove' => array( removablegroups ),
4628 * 'add-self' => array( addablegroups to self),
4629 * 'remove-self' => array( removable groups from self) )
4630 */
4631 public static function changeableByGroup( $group ) {
4632 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4633
4634 $groups = array(
4635 'add' => array(),
4636 'remove' => array(),
4637 'add-self' => array(),
4638 'remove-self' => array()
4639 );
4640
4641 if ( empty( $wgAddGroups[$group] ) ) {
4642 // Don't add anything to $groups
4643 } elseif ( $wgAddGroups[$group] === true ) {
4644 // You get everything
4645 $groups['add'] = self::getAllGroups();
4646 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4647 $groups['add'] = $wgAddGroups[$group];
4648 }
4649
4650 // Same thing for remove
4651 if ( empty( $wgRemoveGroups[$group] ) ) {
4652 // Do nothing
4653 } elseif ( $wgRemoveGroups[$group] === true ) {
4654 $groups['remove'] = self::getAllGroups();
4655 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4656 $groups['remove'] = $wgRemoveGroups[$group];
4657 }
4658
4659 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4660 if ( empty( $wgGroupsAddToSelf['user'] ) || $wgGroupsAddToSelf['user'] !== true ) {
4661 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4662 if ( is_int( $key ) ) {
4663 $wgGroupsAddToSelf['user'][] = $value;
4664 }
4665 }
4666 }
4667
4668 if ( empty( $wgGroupsRemoveFromSelf['user'] ) || $wgGroupsRemoveFromSelf['user'] !== true ) {
4669 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4670 if ( is_int( $key ) ) {
4671 $wgGroupsRemoveFromSelf['user'][] = $value;
4672 }
4673 }
4674 }
4675
4676 // Now figure out what groups the user can add to him/herself
4677 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4678 // Do nothing
4679 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4680 // No idea WHY this would be used, but it's there
4681 $groups['add-self'] = User::getAllGroups();
4682 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4683 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4684 }
4685
4686 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4687 // Do nothing
4688 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4689 $groups['remove-self'] = User::getAllGroups();
4690 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4691 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4692 }
4693
4694 return $groups;
4695 }
4696
4697 /**
4698 * Returns an array of groups that this user can add and remove
4699 * @return array Array( 'add' => array( addablegroups ),
4700 * 'remove' => array( removablegroups ),
4701 * 'add-self' => array( addablegroups to self),
4702 * 'remove-self' => array( removable groups from self) )
4703 */
4704 public function changeableGroups() {
4705 if ( $this->isAllowed( 'userrights' ) ) {
4706 // This group gives the right to modify everything (reverse-
4707 // compatibility with old "userrights lets you change
4708 // everything")
4709 // Using array_merge to make the groups reindexed
4710 $all = array_merge( User::getAllGroups() );
4711 return array(
4712 'add' => $all,
4713 'remove' => $all,
4714 'add-self' => array(),
4715 'remove-self' => array()
4716 );
4717 }
4718
4719 // Okay, it's not so simple, we will have to go through the arrays
4720 $groups = array(
4721 'add' => array(),
4722 'remove' => array(),
4723 'add-self' => array(),
4724 'remove-self' => array()
4725 );
4726 $addergroups = $this->getEffectiveGroups();
4727
4728 foreach ( $addergroups as $addergroup ) {
4729 $groups = array_merge_recursive(
4730 $groups, $this->changeableByGroup( $addergroup )
4731 );
4732 $groups['add'] = array_unique( $groups['add'] );
4733 $groups['remove'] = array_unique( $groups['remove'] );
4734 $groups['add-self'] = array_unique( $groups['add-self'] );
4735 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4736 }
4737 return $groups;
4738 }
4739
4740 /**
4741 * Deferred version of incEditCountImmediate()
4742 */
4743 public function incEditCount() {
4744 $that = $this;
4745 wfGetDB( DB_MASTER )->onTransactionPreCommitOrIdle( function() use ( $that ) {
4746 $that->incEditCountImmediate();
4747 } );
4748 }
4749
4750 /**
4751 * Increment the user's edit-count field.
4752 * Will have no effect for anonymous users.
4753 * @since 1.26
4754 */
4755 public function incEditCountImmediate() {
4756 if ( $this->isAnon() ) {
4757 return;
4758 }
4759
4760 $dbw = wfGetDB( DB_MASTER );
4761 // No rows will be "affected" if user_editcount is NULL
4762 $dbw->update(
4763 'user',
4764 array( 'user_editcount=user_editcount+1' ),
4765 array( 'user_id' => $this->getId() ),
4766 __METHOD__
4767 );
4768 // Lazy initialization check...
4769 if ( $dbw->affectedRows() == 0 ) {
4770 // Now here's a goddamn hack...
4771 $dbr = wfGetDB( DB_SLAVE );
4772 if ( $dbr !== $dbw ) {
4773 // If we actually have a slave server, the count is
4774 // at least one behind because the current transaction
4775 // has not been committed and replicated.
4776 $this->initEditCount( 1 );
4777 } else {
4778 // But if DB_SLAVE is selecting the master, then the
4779 // count we just read includes the revision that was
4780 // just added in the working transaction.
4781 $this->initEditCount();
4782 }
4783 }
4784 // Edit count in user cache too
4785 $this->invalidateCache();
4786 }
4787
4788 /**
4789 * Initialize user_editcount from data out of the revision table
4790 *
4791 * @param int $add Edits to add to the count from the revision table
4792 * @return int Number of edits
4793 */
4794 protected function initEditCount( $add = 0 ) {
4795 // Pull from a slave to be less cruel to servers
4796 // Accuracy isn't the point anyway here
4797 $dbr = wfGetDB( DB_SLAVE );
4798 $count = (int)$dbr->selectField(
4799 'revision',
4800 'COUNT(rev_user)',
4801 array( 'rev_user' => $this->getId() ),
4802 __METHOD__
4803 );
4804 $count = $count + $add;
4805
4806 $dbw = wfGetDB( DB_MASTER );
4807 $dbw->update(
4808 'user',
4809 array( 'user_editcount' => $count ),
4810 array( 'user_id' => $this->getId() ),
4811 __METHOD__
4812 );
4813
4814 return $count;
4815 }
4816
4817 /**
4818 * Get the description of a given right
4819 *
4820 * @param string $right Right to query
4821 * @return string Localized description of the right
4822 */
4823 public static function getRightDescription( $right ) {
4824 $key = "right-$right";
4825 $msg = wfMessage( $key );
4826 return $msg->isBlank() ? $right : $msg->text();
4827 }
4828
4829 /**
4830 * Make a new-style password hash
4831 *
4832 * @param string $password Plain-text password
4833 * @param bool|string $salt Optional salt, may be random or the user ID.
4834 * If unspecified or false, will generate one automatically
4835 * @return string Password hash
4836 * @deprecated since 1.24, use Password class
4837 */
4838 public static function crypt( $password, $salt = false ) {
4839 wfDeprecated( __METHOD__, '1.24' );
4840 $hash = self::getPasswordFactory()->newFromPlaintext( $password );
4841 return $hash->toString();
4842 }
4843
4844 /**
4845 * Compare a password hash with a plain-text password. Requires the user
4846 * ID if there's a chance that the hash is an old-style hash.
4847 *
4848 * @param string $hash Password hash
4849 * @param string $password Plain-text password to compare
4850 * @param string|bool $userId User ID for old-style password salt
4851 *
4852 * @return bool
4853 * @deprecated since 1.24, use Password class
4854 */
4855 public static function comparePasswords( $hash, $password, $userId = false ) {
4856 wfDeprecated( __METHOD__, '1.24' );
4857
4858 // Check for *really* old password hashes that don't even have a type
4859 // The old hash format was just an md5 hex hash, with no type information
4860 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
4861 global $wgPasswordSalt;
4862 if ( $wgPasswordSalt ) {
4863 $password = ":B:{$userId}:{$hash}";
4864 } else {
4865 $password = ":A:{$hash}";
4866 }
4867 }
4868
4869 $hash = self::getPasswordFactory()->newFromCiphertext( $hash );
4870 return $hash->equals( $password );
4871 }
4872
4873 /**
4874 * Add a newuser log entry for this user.
4875 * Before 1.19 the return value was always true.
4876 *
4877 * @param string|bool $action Account creation type.
4878 * - String, one of the following values:
4879 * - 'create' for an anonymous user creating an account for himself.
4880 * This will force the action's performer to be the created user itself,
4881 * no matter the value of $wgUser
4882 * - 'create2' for a logged in user creating an account for someone else
4883 * - 'byemail' when the created user will receive its password by e-mail
4884 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
4885 * - Boolean means whether the account was created by e-mail (deprecated):
4886 * - true will be converted to 'byemail'
4887 * - false will be converted to 'create' if this object is the same as
4888 * $wgUser and to 'create2' otherwise
4889 *
4890 * @param string $reason User supplied reason
4891 *
4892 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4893 */
4894 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4895 global $wgUser, $wgNewUserLog;
4896 if ( empty( $wgNewUserLog ) ) {
4897 return true; // disabled
4898 }
4899
4900 if ( $action === true ) {
4901 $action = 'byemail';
4902 } elseif ( $action === false ) {
4903 if ( $this->equals( $wgUser ) ) {
4904 $action = 'create';
4905 } else {
4906 $action = 'create2';
4907 }
4908 }
4909
4910 if ( $action === 'create' || $action === 'autocreate' ) {
4911 $performer = $this;
4912 } else {
4913 $performer = $wgUser;
4914 }
4915
4916 $logEntry = new ManualLogEntry( 'newusers', $action );
4917 $logEntry->setPerformer( $performer );
4918 $logEntry->setTarget( $this->getUserPage() );
4919 $logEntry->setComment( $reason );
4920 $logEntry->setParameters( array(
4921 '4::userid' => $this->getId(),
4922 ) );
4923 $logid = $logEntry->insert();
4924
4925 if ( $action !== 'autocreate' ) {
4926 $logEntry->publish( $logid );
4927 }
4928
4929 return (int)$logid;
4930 }
4931
4932 /**
4933 * Add an autocreate newuser log entry for this user
4934 * Used by things like CentralAuth and perhaps other authplugins.
4935 * Consider calling addNewUserLogEntry() directly instead.
4936 *
4937 * @return bool
4938 */
4939 public function addNewUserLogEntryAutoCreate() {
4940 $this->addNewUserLogEntry( 'autocreate' );
4941
4942 return true;
4943 }
4944
4945 /**
4946 * Load the user options either from cache, the database or an array
4947 *
4948 * @param array $data Rows for the current user out of the user_properties table
4949 */
4950 protected function loadOptions( $data = null ) {
4951 global $wgContLang;
4952
4953 $this->load();
4954
4955 if ( $this->mOptionsLoaded ) {
4956 return;
4957 }
4958
4959 $this->mOptions = self::getDefaultOptions();
4960
4961 if ( !$this->getId() ) {
4962 // For unlogged-in users, load language/variant options from request.
4963 // There's no need to do it for logged-in users: they can set preferences,
4964 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4965 // so don't override user's choice (especially when the user chooses site default).
4966 $variant = $wgContLang->getDefaultVariant();
4967 $this->mOptions['variant'] = $variant;
4968 $this->mOptions['language'] = $variant;
4969 $this->mOptionsLoaded = true;
4970 return;
4971 }
4972
4973 // Maybe load from the object
4974 if ( !is_null( $this->mOptionOverrides ) ) {
4975 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4976 foreach ( $this->mOptionOverrides as $key => $value ) {
4977 $this->mOptions[$key] = $value;
4978 }
4979 } else {
4980 if ( !is_array( $data ) ) {
4981 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4982 // Load from database
4983 $dbr = ( $this->queryFlagsUsed & self::READ_LATEST )
4984 ? wfGetDB( DB_MASTER )
4985 : wfGetDB( DB_SLAVE );
4986
4987 $res = $dbr->select(
4988 'user_properties',
4989 array( 'up_property', 'up_value' ),
4990 array( 'up_user' => $this->getId() ),
4991 __METHOD__
4992 );
4993
4994 $this->mOptionOverrides = array();
4995 $data = array();
4996 foreach ( $res as $row ) {
4997 $data[$row->up_property] = $row->up_value;
4998 }
4999 }
5000 foreach ( $data as $property => $value ) {
5001 $this->mOptionOverrides[$property] = $value;
5002 $this->mOptions[$property] = $value;
5003 }
5004 }
5005
5006 $this->mOptionsLoaded = true;
5007
5008 Hooks::run( 'UserLoadOptions', array( $this, &$this->mOptions ) );
5009 }
5010
5011 /**
5012 * Saves the non-default options for this user, as previously set e.g. via
5013 * setOption(), in the database's "user_properties" (preferences) table.
5014 * Usually used via saveSettings().
5015 */
5016 protected function saveOptions() {
5017 $this->loadOptions();
5018
5019 // Not using getOptions(), to keep hidden preferences in database
5020 $saveOptions = $this->mOptions;
5021
5022 // Allow hooks to abort, for instance to save to a global profile.
5023 // Reset options to default state before saving.
5024 if ( !Hooks::run( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
5025 return;
5026 }
5027
5028 $userId = $this->getId();
5029
5030 $insert_rows = array(); // all the new preference rows
5031 foreach ( $saveOptions as $key => $value ) {
5032 // Don't bother storing default values
5033 $defaultOption = self::getDefaultOption( $key );
5034 if ( ( $defaultOption === null && $value !== false && $value !== null )
5035 || $value != $defaultOption
5036 ) {
5037 $insert_rows[] = array(
5038 'up_user' => $userId,
5039 'up_property' => $key,
5040 'up_value' => $value,
5041 );
5042 }
5043 }
5044
5045 $dbw = wfGetDB( DB_MASTER );
5046
5047 $res = $dbw->select( 'user_properties',
5048 array( 'up_property', 'up_value' ), array( 'up_user' => $userId ), __METHOD__ );
5049
5050 // Find prior rows that need to be removed or updated. These rows will
5051 // all be deleted (the later so that INSERT IGNORE applies the new values).
5052 $keysDelete = array();
5053 foreach ( $res as $row ) {
5054 if ( !isset( $saveOptions[$row->up_property] )
5055 || strcmp( $saveOptions[$row->up_property], $row->up_value ) != 0
5056 ) {
5057 $keysDelete[] = $row->up_property;
5058 }
5059 }
5060
5061 if ( count( $keysDelete ) ) {
5062 // Do the DELETE by PRIMARY KEY for prior rows.
5063 // In the past a very large portion of calls to this function are for setting
5064 // 'rememberpassword' for new accounts (a preference that has since been removed).
5065 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5066 // caused gap locks on [max user ID,+infinity) which caused high contention since
5067 // updates would pile up on each other as they are for higher (newer) user IDs.
5068 // It might not be necessary these days, but it shouldn't hurt either.
5069 $dbw->delete( 'user_properties',
5070 array( 'up_user' => $userId, 'up_property' => $keysDelete ), __METHOD__ );
5071 }
5072 // Insert the new preference rows
5073 $dbw->insert( 'user_properties', $insert_rows, __METHOD__, array( 'IGNORE' ) );
5074 }
5075
5076 /**
5077 * Lazily instantiate and return a factory object for making passwords
5078 *
5079 * @return PasswordFactory
5080 */
5081 public static function getPasswordFactory() {
5082 if ( self::$mPasswordFactory === null ) {
5083 self::$mPasswordFactory = new PasswordFactory();
5084 self::$mPasswordFactory->init( RequestContext::getMain()->getConfig() );
5085 }
5086
5087 return self::$mPasswordFactory;
5088 }
5089
5090 /**
5091 * Provide an array of HTML5 attributes to put on an input element
5092 * intended for the user to enter a new password. This may include
5093 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5094 *
5095 * Do *not* use this when asking the user to enter his current password!
5096 * Regardless of configuration, users may have invalid passwords for whatever
5097 * reason (e.g., they were set before requirements were tightened up).
5098 * Only use it when asking for a new password, like on account creation or
5099 * ResetPass.
5100 *
5101 * Obviously, you still need to do server-side checking.
5102 *
5103 * NOTE: A combination of bugs in various browsers means that this function
5104 * actually just returns array() unconditionally at the moment. May as
5105 * well keep it around for when the browser bugs get fixed, though.
5106 *
5107 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5108 *
5109 * @return array Array of HTML attributes suitable for feeding to
5110 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5111 * That will get confused by the boolean attribute syntax used.)
5112 */
5113 public static function passwordChangeInputAttribs() {
5114 global $wgMinimalPasswordLength;
5115
5116 if ( $wgMinimalPasswordLength == 0 ) {
5117 return array();
5118 }
5119
5120 # Note that the pattern requirement will always be satisfied if the
5121 # input is empty, so we need required in all cases.
5122 #
5123 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5124 # if e-mail confirmation is being used. Since HTML5 input validation
5125 # is b0rked anyway in some browsers, just return nothing. When it's
5126 # re-enabled, fix this code to not output required for e-mail
5127 # registration.
5128 #$ret = array( 'required' );
5129 $ret = array();
5130
5131 # We can't actually do this right now, because Opera 9.6 will print out
5132 # the entered password visibly in its error message! When other
5133 # browsers add support for this attribute, or Opera fixes its support,
5134 # we can add support with a version check to avoid doing this on Opera
5135 # versions where it will be a problem. Reported to Opera as
5136 # DSK-262266, but they don't have a public bug tracker for us to follow.
5137 /*
5138 if ( $wgMinimalPasswordLength > 1 ) {
5139 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5140 $ret['title'] = wfMessage( 'passwordtooshort' )
5141 ->numParams( $wgMinimalPasswordLength )->text();
5142 }
5143 */
5144
5145 return $ret;
5146 }
5147
5148 /**
5149 * Return the list of user fields that should be selected to create
5150 * a new user object.
5151 * @return array
5152 */
5153 public static function selectFields() {
5154 return array(
5155 'user_id',
5156 'user_name',
5157 'user_real_name',
5158 'user_email',
5159 'user_touched',
5160 'user_token',
5161 'user_email_authenticated',
5162 'user_email_token',
5163 'user_email_token_expires',
5164 'user_registration',
5165 'user_editcount',
5166 );
5167 }
5168
5169 /**
5170 * Factory function for fatal permission-denied errors
5171 *
5172 * @since 1.22
5173 * @param string $permission User right required
5174 * @return Status
5175 */
5176 static function newFatalPermissionDeniedStatus( $permission ) {
5177 global $wgLang;
5178
5179 $groups = array_map(
5180 array( 'User', 'makeGroupLinkWiki' ),
5181 User::getGroupsWithPermission( $permission )
5182 );
5183
5184 if ( $groups ) {
5185 return Status::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5186 } else {
5187 return Status::newFatal( 'badaccess-group0' );
5188 }
5189 }
5190
5191 /**
5192 * Checks if two user objects point to the same user.
5193 *
5194 * @since 1.25
5195 * @param User $user
5196 * @return bool
5197 */
5198 public function equals( User $user ) {
5199 return $this->getName() === $user->getName();
5200 }
5201 }