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