includes/User.php

   1 <?php
   2 /**
   3  * See user.doc
   4  *
   5  * @package MediaWiki
   6  */
   7
   8 /**
   9  *
  10  */
  11 require_once( 'WatchedItem.php' );
  12 require_once( 'Group.php' );
  13
  14 # Number of characters in user_token field
  15 define( 'USER_TOKEN_LENGTH', 32 );
  16
  17 /**
  18  *
  19  * @package MediaWiki
  20  */
  21 class User {
  22         /**#@+
  23          * @access private
  24          */
  25         var $mId, $mName, $mPassword, $mEmail, $mNewtalk;
  26         var $mEmailAuthenticationtimestamp;
  27         var $mRights, $mOptions;
  28         var $mDataLoaded, $mNewpassword;
  29         var $mSkin;
  30         var $mBlockedby, $mBlockreason;
  31         var $mTouched;
  32         var $mToken;
  33         var $mRealName;
  34         var $mHash;
  35         /** Array of group id the user belong to */
  36         var $mGroups;
  37         /**#@-*/
  38
  39         /** Construct using User:loadDefaults() */
  40         function User() {
  41                 $this->loadDefaults();
  42         }
  43
  44         /**
  45          * Static factory method
  46          * @static
  47          * @param string $name Username, validated by Title:newFromText()
  48          */
  49         function newFromName( $name ) {
  50                 $u = new User();
  51
  52                 # Clean up name according to title rules
  53
  54                 $t = Title::newFromText( $name );
  55                 if( is_null( $t ) ) {
  56                         return NULL;
  57                 } else {
  58                         $u->setName( $t->getText() );
  59                         $u->setId( $u->idFromName( $t->getText() ) );
  60                         return $u;
  61                 }
  62         }
  63
  64         /**
  65          * Get username given an id.
  66          * @param integer $id Database user id
  67          * @return string Nickname of a user
  68          * @static
  69          */
  70         function whoIs( $id )   {
  71                 $dbr =& wfGetDB( DB_SLAVE );
  72                 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ) );
  73         }
  74
  75         /**
  76          * Get real username given an id.
  77          * @param integer $id Database user id
  78          * @return string Realname of a user
  79          * @static
  80          */
  81         function whoIsReal( $id )       {
  82                 $dbr =& wfGetDB( DB_SLAVE );
  83                 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ) );
  84         }
  85
  86         /**
  87          * Get database id given a user name
  88          * @param string $name Nickname of a user
  89          * @return integer|null Database user id (null: if non existent
  90          * @static
  91          */
  92         function idFromName( $name ) {
  93                 $fname = "User::idFromName";
  94
  95                 $nt = Title::newFromText( $name );
  96                 if( is_null( $nt ) ) {
  97                         # Illegal name
  98                         return null;
  99                 }
 100                 $dbr =& wfGetDB( DB_SLAVE );
 101                 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), $fname );
 102
 103                 if ( $s === false ) {
 104                         return 0;
 105                 } else {
 106                         return $s->user_id;
 107                 }
 108         }
 109
 110         /**
 111          * does the string match an anonymous user IP address?
 112          * @param string $name Nickname of a user
 113          * @static
 114          */
 115         function isIP( $name ) {
 116                 return preg_match("/^\d{1,3}\.\d{1,3}.\d{1,3}\.\d{1,3}$/",$name);
 117         }
 118
 119         /**
 120          * does the string match roughly an email address ?
 121          * @param string $addr email address
 122          * @static
 123          */
 124         function isValidEmailAddr ( $addr ) {
 125                 return preg_match( '/^([a-z0-9_.-]+([a-z0-9_.-]+)*\@[a-z0-9_-]+([a-z0-9_.-]+)*([a-z.]{2,})+)$/', strtolower($addr));
 126         }
 127
 128         /**
 129          * probably return a random password
 130          * @return string probably a random password
 131          * @static
 132          * @todo Check what is doing really [AV]
 133          */
 134         function randomPassword() {
 135                 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
 136                 $l = strlen( $pwchars ) - 1;
 137
 138                 $np = $pwchars{mt_rand( 0, $l )} . $pwchars{mt_rand( 0, $l )} .
 139                   $pwchars{mt_rand( 0, $l )} . chr( mt_rand(48, 57) ) .
 140                   $pwchars{mt_rand( 0, $l )} . $pwchars{mt_rand( 0, $l )} .
 141                   $pwchars{mt_rand( 0, $l )};
 142                 return $np;
 143         }
 144
 145         /**
 146          * Set properties to default
 147          * Used at construction. It will load per language default settings only
 148          * if we have an available language object.
 149          */
 150         function loadDefaults() {
 151                 static $n=0;
 152                 $n++;
 153                 $fname = 'User::loadDefaults' . $n;
 154                 wfProfileIn( $fname );
 155
 156                 global $wgContLang, $wgIP, $wgDBname;
 157                 global $wgNamespacesToBeSearchedDefault;
 158
 159                 $this->mId = 0;
 160                 $this->mNewtalk = -1;
 161                 $this->mName = $wgIP;
 162                 $this->mRealName = $this->mEmail = '';
 163                 $this->mEmailAuthenticationtimestamp = 0;
 164                 $this->mPassword = $this->mNewpassword = '';
 165                 $this->mRights = array();
 166                 $this->mGroups = array();
 167                 // Getting user defaults only if we have an available language
 168                 if( isset( $wgContLang ) ) {
 169                         $this->loadDefaultFromLanguage();
 170                 }
 171
 172                 foreach( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
 173                         $this->mOptions['searchNs'.$nsnum] = $val;
 174                 }
 175                 unset( $this->mSkin );
 176                 $this->mDataLoaded = false;
 177                 $this->mBlockedby = -1; # Unset
 178                 $this->setToken(); # Random
 179                 $this->mHash = false;
 180
 181                 if ( isset( $_COOKIE[$wgDBname.'LoggedOut'] ) ) {
 182                         $this->mTouched = wfTimestamp( TS_MW, $_COOKIE[$wgDBname.'LoggedOut'] );
 183                 }
 184                 else {
 185                         $this->mTouched = '0'; # Allow any pages to be cached
 186                 }
 187
 188                 wfProfileOut( $fname );
 189         }
 190
 191         /**
 192          * Used to load user options from a language.
 193          * This is not in loadDefault() cause we sometime create user before having
 194          * a language object.
 195          */
 196         function loadDefaultFromLanguage(){
 197                 $this->mOptions = User::getDefaultOptions();
 198         }
 199
 200         /**
 201          * Combine the language default options with any site-specific options
 202          * and add the default language variants.
 203          *
 204          * @return array
 205          * @static
 206          * @access private
 207          */
 208         function getDefaultOptions() {
 209                 /**
 210                  * Site defaults will override the global/language defaults
 211                  */
 212                 global $wgContLang, $wgDefaultUserOptions;
 213                 $defOpt = $wgDefaultUserOptions + $wgContLang->getDefaultUserOptions();
 214
 215                 /**
 216                  * default language setting
 217                  */
 218                 $variant = $wgContLang->getPreferredVariant();
 219                 $defOpt['variant'] = $variant;
 220                 $defOpt['language'] = $variant;
 221
 222                 return $defOpt;
 223         }
 224
 225         /**
 226          * Get a given default option value.
 227          *
 228          * @param string $opt
 229          * @return string
 230          * @static
 231          * @access public
 232          */
 233         function getDefaultOption( $opt ) {
 234                 $defOpts = User::getDefaultOptions();
 235                 if( isset( $defOpts[$opt] ) ) {
 236                         return $defOpts[$opt];
 237                 } else {
 238                         return '';
 239                 }
 240         }
 241
 242         /**
 243          * Get blocking information
 244          * @access private
 245          * @param bool $bFromSlave Specify whether to check slave or master. To improve performance,
 246          *  non-critical checks are done against slaves. Check when actually saving should be done against
 247          *  master.
 248          *
 249          * Note that even if $bFromSlave is false, the check is done first against slave, then master.
 250          * The logic is that if blocked on slave, we'll assume it's either blocked on master or
 251          * just slightly outta sync and soon corrected - safer to block slightly more that less.
 252          * And it's cheaper to check slave first, then master if needed, than master always.
 253          */
 254         function getBlockedStatus( $bFromSlave = false ) {
 255                 global $wgIP, $wgBlockCache, $wgProxyList;
 256
 257                 if ( -1 != $this->mBlockedby ) { return; }
 258
 259                 $this->mBlockedby = 0;
 260
 261                 # User blocking
 262                 if ( $this->mId ) {
 263                         $block = new Block();
 264                         $block->forUpdate( $bFromSlave );
 265                         if ( $block->load( $wgIP , $this->mId ) ) {
 266                                 $this->mBlockedby = $block->mBy;
 267                                 $this->mBlockreason = $block->mReason;
 268                         }
 269                 }
 270
 271                 # IP/range blocking
 272                 if ( !$this->mBlockedby ) {
 273                         # Check first against slave, and optionally from master.
 274                         $block = $wgBlockCache->get( $wgIP, true );
 275                         if ( !$block && !$bFromSlave )
 276                                 {
 277                                 # Not blocked: check against master, to make sure.
 278                                 $wgBlockCache->clearLocal( );
 279                                 $block = $wgBlockCache->get( $wgIP, false );
 280                                 }
 281                         if ( $block !== false ) {
 282                                 $this->mBlockedby = $block->mBy;
 283                                 $this->mBlockreason = $block->mReason;
 284                         }
 285                 }
 286
 287                 # Proxy blocking
 288                 if ( !$this->mBlockedby ) {
 289                         if ( array_key_exists( $wgIP, $wgProxyList ) ) {
 290                                 $this->mBlockedby = wfMsg( 'proxyblocker' );
 291                                 $this->mBlockreason = wfMsg( 'proxyblockreason' );
 292                         }
 293                 }
 294         }
 295
 296         /**
 297          * Check if user is blocked
 298          * @return bool True if blocked, false otherwise
 299          */
 300         function isBlocked( $bFromSlave = false ) {
 301                 $this->getBlockedStatus( $bFromSlave );
 302                 if ( 0 === $this->mBlockedby ) { return false; }
 303                 return true;
 304         }
 305
 306         /**
 307          * Get name of blocker
 308          * @return string name of blocker
 309          */
 310         function blockedBy() {
 311                 $this->getBlockedStatus();
 312                 return $this->mBlockedby;
 313         }
 314
 315         /**
 316          * Get blocking reason
 317          * @return string Blocking reason
 318          */
 319         function blockedFor() {
 320                 $this->getBlockedStatus();
 321                 return $this->mBlockreason;
 322         }
 323
 324         /**
 325          * Initialise php session
 326          */
 327         function SetupSession() {
 328                 global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain;
 329                 if( $wgSessionsInMemcached ) {
 330                         require_once( 'MemcachedSessions.php' );
 331                 } elseif( 'files' != ini_get( 'session.save_handler' ) ) {
 332                         # If it's left on 'user' or another setting from another
 333                         # application, it will end up failing. Try to recover.
 334                         ini_set ( 'session.save_handler', 'files' );
 335                 }
 336                 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain );
 337                 session_cache_limiter( 'private, must-revalidate' );
 338                 @session_start();
 339         }
 340
 341         /**
 342          * Read datas from session
 343          * @static
 344          */
 345         function loadFromSession() {
 346                 global $wgMemc, $wgDBname;
 347
 348                 if ( isset( $_SESSION['wsUserID'] ) ) {
 349                         if ( 0 != $_SESSION['wsUserID'] ) {
 350                                 $sId = $_SESSION['wsUserID'];
 351                         } else {
 352                                 return new User();
 353                         }
 354                 } else if ( isset( $_COOKIE["{$wgDBname}UserID"] ) ) {
 355                         $sId = IntVal( $_COOKIE["{$wgDBname}UserID"] );
 356                         $_SESSION['wsUserID'] = $sId;
 357                 } else {
 358                         return new User();
 359                 }
 360                 if ( isset( $_SESSION['wsUserName'] ) ) {
 361                         $sName = $_SESSION['wsUserName'];
 362                 } else if ( isset( $_COOKIE["{$wgDBname}UserName"] ) ) {
 363                         $sName = $_COOKIE["{$wgDBname}UserName"];
 364                         $_SESSION['wsUserName'] = $sName;
 365                 } else {
 366                         return new User();
 367                 }
 368
 369                 $passwordCorrect = FALSE;
 370                 $user = $wgMemc->get( $key = "$wgDBname:user:id:$sId" );
 371                 if($makenew = !$user) {
 372                         wfDebug( "User::loadFromSession() unable to load from memcached\n" );
 373                         $user = new User();
 374                         $user->mId = $sId;
 375                         $user->loadFromDatabase();
 376                 } else {
 377                         wfDebug( "User::loadFromSession() got from cache!\n" );
 378                 }
 379
 380                 if ( isset( $_SESSION['wsToken'] ) ) {
 381                         $passwordCorrect = $_SESSION['wsToken'] == $user->mToken;
 382                 } else if ( isset( $_COOKIE["{$wgDBname}Token"] ) ) {
 383                         $passwordCorrect = $user->mToken == $_COOKIE["{$wgDBname}Token"];
 384                 } else {
 385                         return new User(); # Can't log in from session
 386                 }
 387
 388                 if ( ( $sName == $user->mName ) && $passwordCorrect ) {
 389                         if($makenew) {
 390                                 if($wgMemc->set( $key, $user ))
 391                                         wfDebug( "User::loadFromSession() successfully saved user\n" );
 392                                 else
 393                                         wfDebug( "User::loadFromSession() unable to save to memcached\n" );
 394                         }
 395                         $user->spreadBlock();
 396                         return $user;
 397                 }
 398                 return new User(); # Can't log in from session
 399         }
 400
 401         /**
 402          * Load a user from the database
 403          */
 404         function loadFromDatabase() {
 405                 global $wgCommandLineMode, $wgAnonGroupId, $wgLoggedInGroupId;
 406                 $fname = "User::loadFromDatabase";
 407
 408                 # Counter-intuitive, breaks various things, use User::setLoaded() if you want to suppress
 409                 # loading in a command line script, don't assume all command line scripts need it like this
 410                 #if ( $this->mDataLoaded || $wgCommandLineMode ) {
 411                 if ( $this->mDataLoaded ) {
 412                         return;
 413                 }
 414
 415                 # Paranoia
 416                 $this->mId = IntVal( $this->mId );
 417
 418                 /** Anonymous user */
 419                 if(!$this->mId) {
 420                         /** Get rights */
 421                         $anong = Group::newFromId($wgAnonGroupId);
 422                         if (!$anong)
 423                                 wfDebugDieBacktrace("Please update your database schema "
 424                                         ."and populate initial group data from "
 425                                         ."maintenance/archives patches");
 426                         $anong->loadFromDatabase();
 427                         $this->mRights = explode(',', $anong->getRights());
 428                         $this->mDataLoaded = true;
 429                         return;
 430                 } # the following stuff is for non-anonymous users only
 431
 432                 $dbr =& wfGetDB( DB_SLAVE );
 433                 $s = $dbr->selectRow( 'user', array( 'user_name','user_password','user_newpassword','user_email',
 434                   'user_emailauthenticationtimestamp',
 435                   'user_real_name','user_options','user_touched', 'user_token' ),
 436                   array( 'user_id' => $this->mId ), $fname );
 437
 438                 if ( $s !== false ) {
 439                         $this->mName = $s->user_name;
 440                         $this->mEmail = $s->user_email;
 441                         $this->mEmailAuthenticationtimestamp = wfTimestamp(TS_MW,$s->user_emailauthenticationtimestamp);
 442                         $this->mRealName = $s->user_real_name;
 443                         $this->mPassword = $s->user_password;
 444                         $this->mNewpassword = $s->user_newpassword;
 445                         $this->decodeOptions( $s->user_options );
 446                         $this->mTouched = wfTimestamp(TS_MW,$s->user_touched);
 447                         $this->mToken = $s->user_token;
 448
 449                         // Get groups id
 450                         $res = $dbr->select( 'user_groups', array( 'ug_group' ), array( 'ug_user' => $this->mId ) );
 451
 452                         while($group = $dbr->fetchRow($res)) {
 453                                 $this->mGroups[] = $group[0];
 454                         }
 455
 456                         // add the default group for logged in user
 457                         $this->mGroups[] = $wgLoggedInGroupId;
 458
 459                         $this->mRights = array();
 460                         // now we merge groups rights to get this user rights
 461                         foreach($this->mGroups as $aGroupId) {
 462                                 $g = Group::newFromId($aGroupId);
 463                                 $g->loadFromDatabase();
 464                                 $this->mRights = array_merge($this->mRights, explode(',', $g->getRights()));
 465                         }
 466
 467                         // array merge duplicate rights which are part of several groups
 468                         $this->mRights = array_unique($this->mRights);
 469
 470                         $dbr->freeResult($res);
 471                 }
 472
 473                 $this->mDataLoaded = true;
 474         }
 475
 476         function getID() { return $this->mId; }
 477         function setID( $v ) {
 478                 $this->mId = $v;
 479                 $this->mDataLoaded = false;
 480         }
 481
 482         function getName() {
 483                 $this->loadFromDatabase();
 484                 return $this->mName;
 485         }
 486
 487         function setName( $str ) {
 488                 $this->loadFromDatabase();
 489                 $this->mName = $str;
 490         }
 491
 492
 493         /**
 494          * Return the title dbkey form of the name, for eg user pages.
 495          * @return string
 496          * @access public
 497          */
 498         function getTitleKey() {
 499                 return str_replace( ' ', '_', $this->getName() );
 500         }
 501
 502         function getNewtalk() {
 503                 $fname = 'User::getNewtalk';
 504                 $this->loadFromDatabase();
 505
 506                 # Load the newtalk status if it is unloaded (mNewtalk=-1)
 507                 if( $this->mNewtalk == -1 ) {
 508                         $this->mNewtalk = 0; # reset talk page status
 509
 510                         # Check memcached separately for anons, who have no
 511                         # entire User object stored in there.
 512                         if( !$this->mId ) {
 513                                 global $wgDBname, $wgMemc;
 514                                 $key = "$wgDBname:newtalk:ip:{$this->mName}";
 515                                 $newtalk = $wgMemc->get( $key );
 516                                 if( is_integer( $newtalk ) ) {
 517                                         $this->mNewtalk = $newtalk ? 1 : 0;
 518                                         return (bool)$this->mNewtalk;
 519                                 }
 520                         }
 521
 522                         $dbr =& wfGetDB( DB_SLAVE );
 523                         $res = $dbr->select( 'watchlist',
 524                                 array( 'wl_user' ),
 525                                 array( 'wl_title'     => $this->getTitleKey(),
 526                                            'wl_namespace' => NS_USER_TALK,
 527                                            'wl_user'      => $this->mId,
 528                                            'wl_notificationtimestamp != 0' ),
 529                                 'User::getNewtalk' );
 530                         if( $dbr->numRows($res) > 0 ) {
 531                                 $this->mNewtalk = 1;
 532                         }
 533                         $dbr->freeResult( $res );
 534
 535                         if( !$this->mId ) {
 536                                 $wgMemc->set( $key, $this->mNewtalk, time() ); // + 1800 );
 537                         }
 538                 }
 539
 540                 return ( 0 != $this->mNewtalk );
 541         }
 542
 543         function setNewtalk( $val ) {
 544                 $this->loadFromDatabase();
 545                 $this->mNewtalk = $val;
 546                 $this->invalidateCache();
 547         }
 548
 549         function invalidateCache() {
 550                 $this->loadFromDatabase();
 551                 $this->mTouched = wfTimestampNow();
 552                 # Don't forget to save the options after this or
 553                 # it won't take effect!
 554         }
 555
 556         function validateCache( $timestamp ) {
 557                 $this->loadFromDatabase();
 558                 return ($timestamp >= $this->mTouched);
 559         }
 560
 561         /**
 562          * Salt a password.
 563          * Will only be salted if $wgPasswordSalt is true
 564          * @param string Password.
 565          * @return string Salted password or clear password.
 566          */
 567         function addSalt( $p ) {
 568                 global $wgPasswordSalt;
 569                 if($wgPasswordSalt)
 570                         return md5( "{$this->mId}-{$p}" );
 571                 else
 572                         return $p;
 573         }
 574
 575         /**
 576          * Encrypt a password.
 577          * It can eventuall salt a password @see User::addSalt()
 578          * @param string $p clear Password.
 579          * @param string Encrypted password.
 580          */
 581         function encryptPassword( $p ) {
 582                 return $this->addSalt( md5( $p ) );
 583         }
 584
 585         # Set the password and reset the random token
 586         function setPassword( $str ) {
 587                 $this->loadFromDatabase();
 588                 $this->setToken();
 589                 $this->mPassword = $this->encryptPassword( $str );
 590                 $this->mNewpassword = '';
 591         }
 592
 593         # Set the random token (used for persistent authentication)
 594         function setToken( $token = false ) {
 595                 global $wgSecretKey, $wgProxyKey, $wgDBname;
 596                 if ( !$token ) {
 597                         if ( $wgSecretKey ) {
 598                                 $key = $wgSecretKey;
 599                         } elseif ( $wgProxyKey ) {
 600                                 $key = $wgProxyKey;
 601                         } else {
 602                                 $key = microtime();
 603                         }
 604                         $this->mToken = md5( $wgSecretKey . mt_rand( 0, 0x7fffffff ) . $wgDBname . $this->mId );
 605                 } else {
 606                         $this->mToken = $token;
 607                 }
 608         }
 609
 610
 611         function setCookiePassword( $str ) {
 612                 $this->loadFromDatabase();
 613                 $this->mCookiePassword = md5( $str );
 614         }
 615
 616         function setNewpassword( $str ) {
 617                 $this->loadFromDatabase();
 618                 $this->mNewpassword = $this->encryptPassword( $str );
 619         }
 620
 621         function getEmail() {
 622                 $this->loadFromDatabase();
 623                 return $this->mEmail;
 624         }
 625
 626         function getEmailAuthenticationtimestamp() {
 627                 $this->loadFromDatabase();
 628                 return $this->mEmailAuthenticationtimestamp;
 629         }
 630
 631         function setEmail( $str ) {
 632                 $this->loadFromDatabase();
 633                 $this->mEmail = $str;
 634         }
 635
 636         function getRealName() {
 637                 $this->loadFromDatabase();
 638                 return $this->mRealName;
 639         }
 640
 641         function setRealName( $str ) {
 642                 $this->loadFromDatabase();
 643                 $this->mRealName = $str;
 644         }
 645
 646         function getOption( $oname ) {
 647                 $this->loadFromDatabase();
 648                 if ( array_key_exists( $oname, $this->mOptions ) ) {
 649                         return $this->mOptions[$oname];
 650                 } else {
 651                         return '';
 652                 }
 653         }
 654
 655         function setOption( $oname, $val ) {
 656                 $this->loadFromDatabase();
 657                 if ( $oname == 'skin' ) {
 658                         # Clear cached skin, so the new one displays immediately in Special:Preferences
 659                         unset( $this->mSkin );
 660                 }
 661                 $this->mOptions[$oname] = $val;
 662                 $this->invalidateCache();
 663         }
 664
 665         function getRights() {
 666                 $this->loadFromDatabase();
 667                 return $this->mRights;
 668         }
 669
 670         function addRight( $rname )     {
 671                 $this->loadFromDatabase();
 672                 array_push( $this->mRights, $rname );
 673                 $this->invalidateCache();
 674         }
 675
 676         function getGroups() {
 677                 $this->loadFromDatabase();
 678                 return $this->mGroups;
 679         }
 680
 681         function setGroups($groups) {
 682                 $this->loadFromDatabase();
 683                 $this->mGroups = $groups;
 684                 $this->invalidateCache();
 685         }
 686
 687         /**
 688          * A more legible check for non-anonymousness.
 689          * Returns true if the user is not an anonymous visitor.
 690          *
 691          * @return bool
 692          */
 693         function isLoggedIn() {
 694                 return( $this->getID() != 0 );
 695         }
 696
 697         /**
 698          * A more legible check for anonymousness.
 699          * Returns true if the user is an anonymous visitor.
 700          *
 701          * @return bool
 702          */
 703         function isAnon() {
 704                 return !$this->isLoggedIn();
 705         }
 706
 707         /**
 708          * Check if a user is sysop
 709          * Die with backtrace. Use User:isAllowed() instead.
 710          * @deprecated
 711          */
 712         function isSysop() {
 713                 wfDebugDieBacktrace("User::isSysop() is deprecated. Use User::isAllowed() instead");
 714         }
 715
 716         /** @deprecated */
 717         function isDeveloper() {
 718                 wfDebugDieBacktrace("User::isDeveloper() is deprecated. Use User::isAllowed() instead");
 719         }
 720
 721         /** @deprecated */
 722         function isBureaucrat() {
 723                 wfDebugDieBacktrace("User::isBureaucrat() is deprecated. Use User::isAllowed() instead");
 724         }
 725
 726         /**
 727          * Whether the user is a bot
 728          * @todo need to be migrated to the new user level management sytem
 729          */
 730         function isBot() {
 731                 $this->loadFromDatabase();
 732
 733                 # Why was this here? I need a UID=0 conversion script [TS]
 734                 # if ( 0 == $this->mId ) { return false; }
 735
 736                 return in_array( 'bot', $this->mRights );
 737         }
 738
 739         /**
 740          * Check if user is allowed to access a feature / make an action
 741          * @param string $action Action to be checked (see $wgAvailableRights in Defines.php for possible actions).
 742          * @return boolean True: action is allowed, False: action should not be allowed
 743          */
 744         function isAllowed($action='') {
 745                 $this->loadFromDatabase();
 746                 return in_array( $action , $this->mRights );
 747         }
 748
 749         /**
 750          * Load a skin if it doesn't exist or return it
 751          * @todo FIXME : need to check the old failback system [AV]
 752          */
 753         function &getSkin() {
 754                 global $IP;
 755                 if ( ! isset( $this->mSkin ) ) {
 756                         $fname = 'User::getSkin';
 757                         wfProfileIn( $fname );
 758
 759                         # get all skin names available
 760                         $skinNames = Skin::getSkinNames();
 761
 762                         # get the user skin
 763                         $userSkin = $this->getOption( 'skin' );
 764                         if ( $userSkin == '' ) { $userSkin = 'standard'; }
 765
 766                         if ( !isset( $skinNames[$userSkin] ) ) {
 767                                 # in case the user skin could not be found find a replacement
 768                                 $fallback = array(
 769                                         0 => 'Standard',
 770                                         1 => 'Nostalgia',
 771                                         2 => 'CologneBlue');
 772                                 # if phptal is enabled we should have monobook skin that
 773                                 # superseed the good old SkinStandard.
 774                                 if ( isset( $skinNames['monobook'] ) ) {
 775                                         $fallback[0] = 'MonoBook';
 776                                 }
 777
 778                                 if(is_numeric($userSkin) && isset( $fallback[$userSkin]) ){
 779                                         $sn = $fallback[$userSkin];
 780                                 } else {
 781                                         $sn = 'Standard';
 782                                 }
 783                         } else {
 784                                 # The user skin is available
 785                                 $sn = $skinNames[$userSkin];
 786                         }
 787
 788                         # Grab the skin class and initialise it. Each skin checks for PHPTal
 789                         # and will not load if it's not enabled.
 790                         require_once( $IP.'/skins/'.$sn.'.php' );
 791
 792                         # Check if we got if not failback to default skin
 793                         $className = 'Skin'.$sn;
 794                         if( !class_exists( $className ) ) {
 795                                 # DO NOT die if the class isn't found. This breaks maintenance
 796                                 # scripts and can cause a user account to be unrecoverable
 797                                 # except by SQL manipulation if a previously valid skin name
 798                                 # is no longer valid.
 799                                 $className = 'SkinStandard';
 800                                 require_once( $IP.'/skins/Standard.php' );
 801                         }
 802                         $this->mSkin =& new $className;
 803                         wfProfileOut( $fname );
 804                 }
 805                 return $this->mSkin;
 806         }
 807
 808         /**#@+
 809          * @param string $title Article title to look at
 810          */
 811
 812         /**
 813          * Check watched status of an article
 814          * @return bool True if article is watched
 815          */
 816         function isWatched( $title ) {
 817                 $wl = WatchedItem::fromUserTitle( $this, $title );
 818                 return $wl->isWatched();
 819         }
 820
 821         /**
 822          * Watch an article
 823          */
 824         function addWatch( $title ) {
 825                 $wl = WatchedItem::fromUserTitle( $this, $title );
 826                 $wl->addWatch();
 827                 $this->invalidateCache();
 828         }
 829
 830         /**
 831          * Stop watching an article
 832          */
 833         function removeWatch( $title ) {
 834                 $wl = WatchedItem::fromUserTitle( $this, $title );
 835                 $wl->removeWatch();
 836                 $this->invalidateCache();
 837         }
 838
 839         /**
 840          * Clear the user's notification timestamp for the given title.
 841          * If e-notif e-mails are on, they will receive notification mails on
 842          * the next change of the page if it's watched etc.
 843          */
 844         function clearNotification( $title ) {
 845                 $userid = $this->getId();
 846                 if ($userid==0)
 847                         return;
 848                 $dbw =& wfGetDB( DB_MASTER );
 849                 $success = $dbw->update( 'watchlist',
 850                                 array( /* SET */
 851                                         'wl_notificationtimestamp' => 0
 852                                 ), array( /* WHERE */
 853                                         'wl_title' => $title->getDBkey(),
 854                                         'wl_namespace' => $title->getNamespace(),
 855                                         'wl_user' => $this->getId()
 856                                 ), 'User::clearLastVisited'
 857                 );
 858         }
 859
 860         /**#@-*/
 861
 862         /**
 863          * Resets all of the given user's page-change notification timestamps.
 864          * If e-notif e-mails are on, they will receive notification mails on
 865          * the next change of any watched page.
 866          *
 867          * @param int $currentUser user ID number
 868          * @access public
 869          */
 870         function clearAllNotifications( $currentUser ) {
 871                 if( $currentUser != 0 )  {
 872
 873                         $dbw =& wfGetDB( DB_MASTER );
 874                         $success = $dbw->update( 'watchlist',
 875                                 array( /* SET */
 876                                         'wl_notificationtimestamp' => 0
 877                                 ), array( /* WHERE */
 878                                         'wl_user' => $currentUser
 879                                 ), 'UserMailer::clearAll'
 880                         );
 881
 882                 #       we also need to clear here the "you have new message" notification for the own user_talk page
 883                 #       This is cleared one page view later in Article::viewUpdates();
 884                 }
 885         }
 886
 887         /**
 888          * @access private
 889          * @return string Encoding options
 890          */
 891         function encodeOptions() {
 892                 $a = array();
 893                 foreach ( $this->mOptions as $oname => $oval ) {
 894                         array_push( $a, $oname.'='.$oval );
 895                 }
 896                 $s = implode( "\n", $a );
 897                 return $s;
 898         }
 899
 900         /**
 901          * @access private
 902          */
 903         function decodeOptions( $str ) {
 904                 $a = explode( "\n", $str );
 905                 foreach ( $a as $s ) {
 906                         if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
 907                                 $this->mOptions[$m[1]] = $m[2];
 908                         }
 909                 }
 910         }
 911
 912         function setCookies() {
 913                 global $wgCookieExpiration, $wgCookiePath, $wgCookieDomain, $wgDBname;
 914                 if ( 0 == $this->mId ) return;
 915                 $this->loadFromDatabase();
 916                 $exp = time() + $wgCookieExpiration;
 917
 918                 $_SESSION['wsUserID'] = $this->mId;
 919                 setcookie( $wgDBname.'UserID', $this->mId, $exp, $wgCookiePath, $wgCookieDomain );
 920
 921                 $_SESSION['wsUserName'] = $this->mName;
 922                 setcookie( $wgDBname.'UserName', $this->mName, $exp, $wgCookiePath, $wgCookieDomain );
 923
 924                 $_SESSION['wsToken'] = $this->mToken;
 925                 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
 926                         setcookie( $wgDBname.'Token', $this->mToken, $exp, $wgCookiePath, $wgCookieDomain );
 927                 } else {
 928                         setcookie( $wgDBname.'Token', '', time() - 3600 );
 929                 }
 930         }
 931
 932         /**
 933          * Logout user
 934          * It will clean the session cookie
 935          */
 936         function logout() {
 937                 global $wgCookiePath, $wgCookieDomain, $wgDBname, $wgIP;
 938                 $this->loadDefaults();
 939                 $this->setLoaded( true );
 940
 941                 $_SESSION['wsUserID'] = 0;
 942
 943                 setcookie( $wgDBname.'UserID', '', time() - 3600, $wgCookiePath, $wgCookieDomain );
 944                 setcookie( $wgDBname.'Token', '', time() - 3600, $wgCookiePath, $wgCookieDomain );
 945
 946                 # Remember when user logged out, to prevent seeing cached pages
 947                 setcookie( $wgDBname.'LoggedOut', wfTimestampNow(), time() + 86400, $wgCookiePath, $wgCookieDomain );
 948         }
 949
 950         /**
 951          * Save object settings into database
 952          */
 953         function saveSettings() {
 954                 global $wgMemc, $wgDBname;
 955                 $fname = 'User::saveSettings';
 956
 957                 $dbw =& wfGetDB( DB_MASTER );
 958                 if ( ! $this->getNewtalk() ) {
 959                         # Delete the watchlist entry for user_talk page X watched by user X
 960                         $dbw->delete( 'watchlist',
 961                                 array( 'wl_user'      => $this->mId,
 962                                            'wl_title'     => $this->getTitleKey(),
 963                                            'wl_namespace' => NS_USER_TALK ),
 964                                 $fname );
 965                         if( !$this->mId ) {
 966                                 # Anon users have a separate memcache space for newtalk
 967                                 # since they don't store their own info. Trim...
 968                                 $wgMemc->delete( "$wgDBname:newtalk:ip:{$this->mName}" );
 969                         }
 970                 }
 971
 972                 if ( 0 == $this->mId ) { return; }
 973
 974                 $dbw->update( 'user',
 975                         array( /* SET */
 976                                 'user_name' => $this->mName,
 977                                 'user_password' => $this->mPassword,
 978                                 'user_newpassword' => $this->mNewpassword,
 979                                 'user_real_name' => $this->mRealName,
 980                                 'user_email' => $this->mEmail,
 981                                 'user_emailauthenticationtimestamp' => $dbw->timestamp($this->mEmailAuthenticationtimestamp),
 982                                 'user_options' => $this->encodeOptions(),
 983                                 'user_touched' => $dbw->timestamp($this->mTouched),
 984                                 'user_token' => $this->mToken
 985                         ), array( /* WHERE */
 986                                 'user_id' => $this->mId
 987                         ), $fname
 988                 );
 989                 $dbw->set( 'user_rights', 'ur_rights', implode( ',', $this->mRights ),
 990                         'ur_user='. $this->mId, $fname );
 991                 $wgMemc->delete( "$wgDBname:user:id:$this->mId" );
 992
 993                 // delete old groups
 994                 $dbw->delete( 'user_groups', array( 'ug_user' => $this->mId), $fname);
 995
 996                 // save new ones
 997                 foreach ($this->mGroups as $group) {
 998                         $dbw->replace( 'user_groups',
 999                                 array(array('ug_user','ug_group')),
1000                                 array(
1001                                         'ug_user' => $this->mId,
1002                                         'ug_group' => $group
1003                                 ), $fname
1004                         );
1005                 }
1006         }
1007
1008
1009         /**
1010          * Checks if a user with the given name exists, returns the ID
1011          */
1012         function idForName() {
1013                 $fname = 'User::idForName';
1014
1015                 $gotid = 0;
1016                 $s = trim( $this->mName );
1017                 if ( 0 == strcmp( '', $s ) ) return 0;
1018
1019                 $dbr =& wfGetDB( DB_SLAVE );
1020                 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), $fname );
1021                 if ( $id === false ) {
1022                         $id = 0;
1023                 }
1024                 return $id;
1025         }
1026
1027         /**
1028          * Add user object to the database
1029          */
1030         function addToDatabase() {
1031                 $fname = 'User::addToDatabase';
1032                 $dbw =& wfGetDB( DB_MASTER );
1033                 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
1034                 $dbw->insert( 'user',
1035                         array(
1036                                 'user_id' => $seqVal,
1037                                 'user_name' => $this->mName,
1038                                 'user_password' => $this->mPassword,
1039                                 'user_newpassword' => $this->mNewpassword,
1040                                 'user_email' => $this->mEmail,
1041                                 'user_emailauthenticationtimestamp' => $dbw->timestamp($this->mEmailAuthenticationtimestamp),
1042                                 'user_real_name' => $this->mRealName,
1043                                 'user_options' => $this->encodeOptions(),
1044                                 'user_token' => $this->mToken
1045                         ), $fname
1046                 );
1047                 $this->mId = $dbw->insertId();
1048                 $dbw->insert( 'user_rights',
1049                         array(
1050                                 'ur_user' => $this->mId,
1051                                 'ur_rights' => implode( ',', $this->mRights )
1052                         ), $fname
1053                 );
1054
1055                 foreach ($this->mGroups as $group) {
1056                         $dbw->insert( 'user_groups',
1057                                 array(
1058                                         'ug_user' => $this->mId,
1059                                         'ug_group' => $group
1060                                 ), $fname
1061                         );
1062                 }
1063         }
1064
1065         function spreadBlock() {
1066                 global $wgIP;
1067                 # If the (non-anonymous) user is blocked, this function will block any IP address
1068                 # that they successfully log on from.
1069                 $fname = 'User::spreadBlock';
1070
1071                 wfDebug( "User:spreadBlock()\n" );
1072                 if ( $this->mId == 0 ) {
1073                         return;
1074                 }
1075
1076                 $userblock = Block::newFromDB( '', $this->mId );
1077                 if ( !$userblock->isValid() ) {
1078                         return;
1079                 }
1080
1081                 # Check if this IP address is already blocked
1082                 $ipblock = Block::newFromDB( $wgIP );
1083                 if ( $ipblock->isValid() ) {
1084                         # Just update the timestamp
1085                         $ipblock->updateTimestamp();
1086                         return;
1087                 }
1088
1089                 # Make a new block object with the desired properties
1090                 wfDebug( "Autoblocking {$this->mName}@{$wgIP}\n" );
1091                 $ipblock->mAddress = $wgIP;
1092                 $ipblock->mUser = 0;
1093                 $ipblock->mBy = $userblock->mBy;
1094                 $ipblock->mReason = wfMsg( 'autoblocker', $this->getName(), $userblock->mReason );
1095                 $ipblock->mTimestamp = wfTimestampNow();
1096                 $ipblock->mAuto = 1;
1097                 # If the user is already blocked with an expiry date, we don't
1098                 # want to pile on top of that!
1099                 if($userblock->mExpiry) {
1100                         $ipblock->mExpiry = min ( $userblock->mExpiry, Block::getAutoblockExpiry( $ipblock->mTimestamp ));
1101                 } else {
1102                         $ipblock->mExpiry = Block::getAutoblockExpiry( $ipblock->mTimestamp );
1103                 }
1104
1105                 # Insert it
1106                 $ipblock->insert();
1107
1108         }
1109
1110         function getPageRenderingHash() {
1111                 global $wgContLang;
1112                 if( $this->mHash ){
1113                         return $this->mHash;
1114                 }
1115
1116                 // stubthreshold is only included below for completeness,
1117                 // it will always be 0 when this function is called by parsercache.
1118
1119                 $confstr =        $this->getOption( 'math' );
1120                 $confstr .= '!' . $this->getOption( 'stubthreshold' );
1121                 $confstr .= '!' . $this->getOption( 'editsection' );
1122                 $confstr .= '!' . $this->getOption( 'date' );
1123                 $confstr .= '!' . $this->getOption( 'numberheadings' );
1124                 $confstr .= '!' . $this->getOption( 'language' );
1125                 // add in language specific options, if any
1126                 $extra = $wgContLang->getExtraHashOptions();
1127                 $confstr .= $extra;
1128
1129                 $this->mHash = $confstr;
1130                 return $confstr ;
1131         }
1132
1133         function isAllowedToCreateAccount() {
1134                 global $wgWhitelistAccount;
1135                 $allowed = false;
1136
1137                 if (!$wgWhitelistAccount) { return 1; }; // default behaviour
1138                 foreach ($wgWhitelistAccount as $right => $ok) {
1139                         $userHasRight = (!strcmp($right, 'user') || in_array($right, $this->getRights()));
1140                         $allowed |= ($ok && $userHasRight);
1141                 }
1142                 return $allowed;
1143         }
1144
1145         /**
1146          * Set mDataLoaded, return previous value
1147          * Use this to prevent DB access in command-line scripts or similar situations
1148          */
1149         function setLoaded( $loaded ) {
1150                 return wfSetVar( $this->mDataLoaded, $loaded );
1151         }
1152
1153         /**
1154          * Get this user's personal page title.
1155          *
1156          * @return Title
1157          * @access public
1158          */
1159         function getUserPage() {
1160                 return Title::makeTitle( NS_USER, $this->mName );
1161         }
1162
1163         /**
1164          * Get this user's talk page title.
1165          *
1166          * @return Title
1167          * @access public
1168          */
1169         function getTalkPage() {
1170                 $title = $this->getUserPage();
1171                 return $title->getTalkPage();
1172         }
1173
1174         /**
1175          * @static
1176          */
1177         function getMaxID() {
1178                 $dbr =& wfGetDB( DB_SLAVE );
1179                 return $dbr->selectField( 'user', 'max(user_id)', false );
1180         }
1181
1182         /**
1183          * Determine whether the user is a newbie. Newbies are either
1184          * anonymous IPs, or the 1% most recently created accounts.
1185          * Bots and sysops are excluded.
1186          * @return bool True if it is a newbie.
1187          */
1188         function isNewbie() {
1189                 return $this->mId > User::getMaxID() * 0.99 && !$this->isSysop() && !$this->isBot() || $this->getID() == 0;
1190         }
1191
1192         /**
1193          * Check to see if the given clear-text password is one of the accepted passwords
1194          * @param string $password User password.
1195          * @return bool True if the given password is correct otherwise False.
1196          */
1197         function checkPassword( $password ) {
1198                 global $wgAuth;
1199                 $this->loadFromDatabase();
1200
1201                 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
1202                         return true;
1203                 } elseif( $wgAuth->strict() ) {
1204                         /* Auth plugin doesn't allow local authentication */
1205                         return false;
1206                 }
1207                 $ep = $this->encryptPassword( $password );
1208                 if ( 0 == strcmp( $ep, $this->mPassword ) ) {
1209                         return true;
1210                 } elseif ( ($this->mNewpassword != '') && (0 == strcmp( $ep, $this->mNewpassword )) ) {
1211                         $this->mEmailAuthenticationtimestamp = wfTimestampNow();
1212                         $this->mNewpassword = ''; # use the temporary one-time password only once: clear it now !
1213                         $this->saveSettings();
1214                         return true;
1215                 } elseif ( function_exists( 'iconv' ) ) {
1216                         # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
1217                         # Check for this with iconv
1218                         $cp1252hash = $this->encryptPassword( iconv( 'UTF-8', 'WINDOWS-1252', $password ) );
1219                         if ( 0 == strcmp( $cp1252hash, $this->mPassword ) ) {
1220                                 return true;
1221                         }
1222                 }
1223                 return false;
1224         }
1225
1226         /**
1227          * Initialize (if necessary) and return a session token value
1228          * which can be used in edit forms to show that the user's
1229          * login credentials aren't being hijacked with a foreign form
1230          * submission.
1231          *
1232          * @param mixed $salt - Optional function-specific data for hash.
1233          *                      Use a string or an array of strings.
1234          * @return string
1235          * @access public
1236          */
1237         function editToken( $salt = '' ) {
1238                 if( !isset( $_SESSION['wsEditToken'] ) ) {
1239                         $token = dechex( mt_rand() ) . dechex( mt_rand() );
1240                         $_SESSION['wsEditToken'] = $token;
1241                 } else {
1242                         $token = $_SESSION['wsEditToken'];
1243                 }
1244                 if( is_array( $salt ) ) {
1245                         $salt = implode( '|', $salt );
1246                 }
1247                 return md5( $token . $salt );
1248         }
1249
1250         /**
1251          * Check given value against the token value stored in the session.
1252          * A match should confirm that the form was submitted from the
1253          * user's own login session, not a form submission from a third-party
1254          * site.
1255          *
1256          * @param string $val - the input value to compare
1257          * @param string $salt - Optional function-specific data for hash
1258          * @return bool
1259          * @access public
1260          */
1261         function matchEditToken( $val, $salt = '' ) {
1262                 return ( $val == $this->editToken( $salt ) );
1263         }
1264 }
1265
1266 ?>