11 require_once( 'WatchedItem.php' );
13 # Number of characters in user_token field
14 define( 'USER_TOKEN_LENGTH', 32 );
16 # Serialized record version
17 define( 'MW_USER_VERSION', 3 );
27 var $mId, $mName, $mPassword, $mEmail, $mNewtalk;
28 var $mEmailAuthenticated;
29 var $mRights, $mOptions;
30 var $mDataLoaded, $mNewpassword;
32 var $mBlockedby, $mBlockreason;
38 var $mVersion; // serialized version
41 /** Construct using User:loadDefaults() */
43 $this->loadDefaults();
44 $this->mVersion
= MW_USER_VERSION
;
48 * Static factory method
49 * @param string $name Username, validated by Title:newFromText()
53 function newFromName( $name ) {
54 # Force usernames to capital
56 $name = $wgContLang->ucfirst( $name );
58 # Clean up name according to title rules
59 $t = Title
::newFromText( $name );
64 # Reject various classes of invalid names
65 $canonicalName = $t->getText();
67 $canonicalName = $wgAuth->getCanonicalName( $t->getText() );
69 if( !User
::isValidUserName( $canonicalName ) ) {
74 $u->setName( $canonicalName );
75 $u->setId( $u->idFromName( $canonicalName ) );
80 * Factory method to fetch whichever use has a given email confirmation code.
81 * This code is generated when an account is created or its e-mail address
84 * If the code is invalid or has expired, returns NULL.
90 function newFromConfirmationCode( $code ) {
91 $dbr =& wfGetDB( DB_SLAVE
);
92 $name = $dbr->selectField( 'user', 'user_name', array(
93 'user_email_token' => md5( $code ),
94 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
96 if( is_string( $name ) ) {
97 return User
::newFromName( $name );
104 * Serialze sleep function, for better cache efficiency and avoidance of
105 * silly "incomplete type" errors when skins are cached
108 return array( 'mId', 'mName', 'mPassword', 'mEmail', 'mNewtalk',
109 'mEmailAuthenticated', 'mRights', 'mOptions', 'mDataLoaded',
110 'mNewpassword', 'mBlockedby', 'mBlockreason', 'mTouched',
111 'mToken', 'mRealName', 'mHash', 'mGroups', 'mRegistration' );
115 * Get username given an id.
116 * @param integer $id Database user id
117 * @return string Nickname of a user
120 function whoIs( $id ) {
121 $dbr =& wfGetDB( DB_SLAVE
);
122 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
126 * Get real username given an id.
127 * @param integer $id Database user id
128 * @return string Realname of a user
131 function whoIsReal( $id ) {
132 $dbr =& wfGetDB( DB_SLAVE
);
133 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), 'User::whoIsReal' );
137 * Get database id given a user name
138 * @param string $name Nickname of a user
139 * @return integer|null Database user id (null: if non existent
142 function idFromName( $name ) {
143 $fname = "User::idFromName";
145 $nt = Title
::newFromText( $name );
146 if( is_null( $nt ) ) {
150 $dbr =& wfGetDB( DB_SLAVE
);
151 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), $fname );
153 if ( $s === false ) {
161 * does the string match an anonymous IPv4 address?
163 * Note: We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
164 * address because the usemod software would "cloak" anonymous IP
165 * addresses like this, if we allowed accounts like this to be created
166 * new users could get the old edits of these anonymous users.
171 * @param string $name Nickname of a user
174 function isIP( $name ) {
175 return preg_match("/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/",$name);
176 /*return preg_match("/^
177 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
178 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
179 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
180 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))
185 * Is the input a valid username?
187 * Checks if the input is a valid username, we don't want an empty string,
188 * an IP address, anything that containins slashes (would mess up subpages),
189 * is longer than the maximum allowed username size or doesn't begin with
192 * @param string $name
196 function isValidUserName( $name ) {
197 global $wgContLang, $wgMaxNameChars;
200 || User
::isIP( $name )
201 ||
strpos( $name, '/' ) !== false
202 ||
strlen( $name ) > $wgMaxNameChars
203 ||
$name != $wgContLang->ucfirst( $name ) )
206 // Ensure that the name can't be misresolved as a different title,
207 // such as with extra namespace keys at the start.
208 $parsed = Title
::newFromText( $name );
209 if( is_null( $parsed )
210 ||
$parsed->getNamespace()
211 ||
strcmp( $name, $parsed->getPrefixedText() ) )
218 * Is the input a valid password?
220 * @param string $password
224 function isValidPassword( $password ) {
225 global $wgMinimalPasswordLength;
226 return strlen( $password ) >= $wgMinimalPasswordLength;
230 * Does the string match roughly an email address ?
232 * There used to be a regular expression here, it got removed because it
233 * rejected valid addresses. Actually just check if there is '@' somewhere
234 * in the given address.
236 * @todo Check for RFC 2822 compilance
239 * @param string $addr email address
243 function isValidEmailAddr ( $addr ) {
244 return ( trim( $addr ) != '' ) &&
245 (false !== strpos( $addr, '@' ) );
249 * Count the number of edits of a user
251 * @param int $uid The user ID to check
254 function edits( $uid ) {
255 $fname = 'User::edits';
257 $dbr =& wfGetDB( DB_SLAVE
);
258 return $dbr->selectField(
259 'revision', 'count(*)',
260 array( 'rev_user' => $uid ),
266 * probably return a random password
267 * @return string probably a random password
269 * @todo Check what is doing really [AV]
271 function randomPassword() {
272 global $wgMinimalPasswordLength;
273 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
274 $l = strlen( $pwchars ) - 1;
276 $pwlength = max( 7, $wgMinimalPasswordLength );
277 $digit = mt_rand(0, $pwlength - 1);
279 for ( $i = 0; $i < $pwlength; $i++
) {
280 $np .= $i == $digit ?
chr( mt_rand(48, 57) ) : $pwchars{ mt_rand(0, $l)};
286 * Set properties to default
287 * Used at construction. It will load per language default settings only
288 * if we have an available language object.
290 function loadDefaults() {
293 $fname = 'User::loadDefaults' . $n;
294 wfProfileIn( $fname );
296 global $wgContLang, $wgDBname;
297 global $wgNamespacesToBeSearchedDefault;
300 $this->mNewtalk
= -1;
301 $this->mName
= false;
302 $this->mRealName
= $this->mEmail
= '';
303 $this->mEmailAuthenticated
= null;
304 $this->mPassword
= $this->mNewpassword
= '';
305 $this->mRights
= array();
306 $this->mGroups
= array();
307 $this->mOptions
= User
::getDefaultOptions();
309 foreach( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
310 $this->mOptions
['searchNs'.$nsnum] = $val;
312 unset( $this->mSkin
);
313 $this->mDataLoaded
= false;
314 $this->mBlockedby
= -1; # Unset
315 $this->setToken(); # Random
316 $this->mHash
= false;
318 if ( isset( $_COOKIE[$wgDBname.'LoggedOut'] ) ) {
319 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgDBname.'LoggedOut'] );
322 $this->mTouched
= '0'; # Allow any pages to be cached
325 $this->mRegistration
= wfTimestamp( TS_MW
);
327 wfProfileOut( $fname );
331 * Combine the language default options with any site-specific options
332 * and add the default language variants.
338 function getDefaultOptions() {
340 * Site defaults will override the global/language defaults
342 global $wgContLang, $wgDefaultUserOptions;
343 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptions();
346 * default language setting
348 $variant = $wgContLang->getPreferredVariant();
349 $defOpt['variant'] = $variant;
350 $defOpt['language'] = $variant;
356 * Get a given default option value.
363 function getDefaultOption( $opt ) {
364 $defOpts = User
::getDefaultOptions();
365 if( isset( $defOpts[$opt] ) ) {
366 return $defOpts[$opt];
373 * Get blocking information
375 * @param bool $bFromSlave Specify whether to check slave or master. To improve performance,
376 * non-critical checks are done against slaves. Check when actually saving should be done against
379 function getBlockedStatus( $bFromSlave = true ) {
380 global $wgEnableSorbs, $wgProxyWhitelist;
382 if ( -1 != $this->mBlockedby
) {
383 wfDebug( "User::getBlockedStatus: already loaded.\n" );
387 $fname = 'User::getBlockedStatus';
388 wfProfileIn( $fname );
389 wfDebug( "$fname: checking...\n" );
391 $this->mBlockedby
= 0;
395 $block = new Block();
396 $block->fromMaster( !$bFromSlave );
397 if ( $block->load( $ip , $this->mId
) ) {
398 wfDebug( "$fname: Found block.\n" );
399 $this->mBlockedby
= $block->mBy
;
400 $this->mBlockreason
= $block->mReason
;
401 if ( $this->isLoggedIn() ) {
402 $this->spreadBlock();
405 wfDebug( "$fname: No block.\n" );
409 if ( !$this->isSysop() && !in_array( $ip, $wgProxyWhitelist ) ) {
412 if ( wfIsLocallyBlockedProxy( $ip ) ) {
413 $this->mBlockedby
= wfMsg( 'proxyblocker' );
414 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
418 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
419 if ( $this->inSorbsBlacklist( $ip ) ) {
420 $this->mBlockedby
= wfMsg( 'sorbs' );
421 $this->mBlockreason
= wfMsg( 'sorbsreason' );
427 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
429 wfProfileOut( $fname );
432 function inSorbsBlacklist( $ip ) {
433 global $wgEnableSorbs;
434 return $wgEnableSorbs &&
435 $this->inDnsBlacklist( $ip, 'http.dnsbl.sorbs.net.' );
438 function inOpmBlacklist( $ip ) {
440 return $wgEnableOpm &&
441 $this->inDnsBlacklist( $ip, 'opm.blitzed.org.' );
444 function inDnsBlacklist( $ip, $base ) {
445 $fname = 'User::inDnsBlacklist';
446 wfProfileIn( $fname );
451 if ( preg_match( '/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/', $ip, $m ) ) {
453 for ( $i=4; $i>=1; $i-- ) {
454 $host .= $m[$i] . '.';
459 $ipList = gethostbynamel( $host );
462 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
465 wfDebug( "Requested $host, not found in $base.\n" );
469 wfProfileOut( $fname );
474 * Primitive rate limits: enforce maximum actions per time period
475 * to put a brake on flooding.
477 * Note: when using a shared cache like memcached, IP-address
478 * last-hit counters will be shared across wikis.
480 * @return bool true if a rate limiter was tripped
483 function pingLimiter( $action='edit' ) {
484 global $wgRateLimits;
485 if( !isset( $wgRateLimits[$action] ) ) {
488 if( $this->isAllowed( 'delete' ) ) {
493 global $wgMemc, $wgDBname, $wgRateLimitLog;
494 $fname = 'User::pingLimiter';
495 wfProfileIn( $fname );
497 $limits = $wgRateLimits[$action];
499 $id = $this->getId();
502 if( isset( $limits['anon'] ) && $id == 0 ) {
503 $keys["$wgDBname:limiter:$action:anon"] = $limits['anon'];
506 if( isset( $limits['user'] ) && $id != 0 ) {
507 $keys["$wgDBname:limiter:$action:user:$id"] = $limits['user'];
509 if( $this->isNewbie() ) {
510 if( isset( $limits['newbie'] ) && $id != 0 ) {
511 $keys["$wgDBname:limiter:$action:user:$id"] = $limits['newbie'];
513 if( isset( $limits['ip'] ) ) {
514 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
516 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
517 $subnet = $matches[1];
518 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
523 foreach( $keys as $key => $limit ) {
524 list( $max, $period ) = $limit;
525 $summary = "(limit $max in {$period}s)";
526 $count = $wgMemc->get( $key );
528 if( $count > $max ) {
529 wfDebug( "$fname: tripped! $key at $count $summary\n" );
530 if( $wgRateLimitLog ) {
531 @error_log
( wfTimestamp( TS_MW
) . ' ' . $wgDBname . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
535 wfDebug( "$fname: ok. $key at $count $summary\n" );
538 wfDebug( "$fname: adding record for $key $summary\n" );
539 $wgMemc->add( $key, 1, intval( $period ) );
541 $wgMemc->incr( $key );
544 wfProfileOut( $fname );
549 * Check if user is blocked
550 * @return bool True if blocked, false otherwise
552 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
553 wfDebug( "User::isBlocked: enter\n" );
554 $this->getBlockedStatus( $bFromSlave );
555 return $this->mBlockedby
!== 0;
559 * Check if user is blocked from editing a particular article
561 function isBlockedFrom( $title, $bFromSlave = false ) {
562 global $wgBlockAllowsUTEdit;
563 $fname = 'User::isBlockedFrom';
564 wfProfileIn( $fname );
565 wfDebug( "$fname: enter\n" );
567 if ( $wgBlockAllowsUTEdit && $title->getText() === $this->getName() &&
568 $title->getNamespace() == NS_USER_TALK
)
571 wfDebug( "$fname: self-talk page, ignoring any blocks\n" );
573 wfDebug( "$fname: asking isBlocked()\n" );
574 $blocked = $this->isBlocked( $bFromSlave );
576 wfProfileOut( $fname );
581 * Get name of blocker
582 * @return string name of blocker
584 function blockedBy() {
585 $this->getBlockedStatus();
586 return $this->mBlockedby
;
590 * Get blocking reason
591 * @return string Blocking reason
593 function blockedFor() {
594 $this->getBlockedStatus();
595 return $this->mBlockreason
;
599 * Initialise php session
601 function SetupSession() {
602 global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain;
603 if( $wgSessionsInMemcached ) {
604 require_once( 'MemcachedSessions.php' );
605 } elseif( 'files' != ini_get( 'session.save_handler' ) ) {
606 # If it's left on 'user' or another setting from another
607 # application, it will end up failing. Try to recover.
608 ini_set ( 'session.save_handler', 'files' );
610 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain );
611 session_cache_limiter( 'private, must-revalidate' );
616 * Create a new user object using data from session
619 function loadFromSession() {
620 global $wgMemc, $wgDBname;
622 if ( isset( $_SESSION['wsUserID'] ) ) {
623 if ( 0 != $_SESSION['wsUserID'] ) {
624 $sId = $_SESSION['wsUserID'];
628 } else if ( isset( $_COOKIE["{$wgDBname}UserID"] ) ) {
629 $sId = intval( $_COOKIE["{$wgDBname}UserID"] );
630 $_SESSION['wsUserID'] = $sId;
634 if ( isset( $_SESSION['wsUserName'] ) ) {
635 $sName = $_SESSION['wsUserName'];
636 } else if ( isset( $_COOKIE["{$wgDBname}UserName"] ) ) {
637 $sName = $_COOKIE["{$wgDBname}UserName"];
638 $_SESSION['wsUserName'] = $sName;
643 $passwordCorrect = FALSE;
644 $user = $wgMemc->get( $key = "$wgDBname:user:id:$sId" );
645 if( !is_object( $user ) ||
$user->mVersion
< MW_USER_VERSION
) {
646 # Expire old serialized objects; they may be corrupt.
649 if($makenew = !$user) {
650 wfDebug( "User::loadFromSession() unable to load from memcached\n" );
653 $user->loadFromDatabase();
655 wfDebug( "User::loadFromSession() got from cache!\n" );
658 if ( isset( $_SESSION['wsToken'] ) ) {
659 $passwordCorrect = $_SESSION['wsToken'] == $user->mToken
;
660 } else if ( isset( $_COOKIE["{$wgDBname}Token"] ) ) {
661 $passwordCorrect = $user->mToken
== $_COOKIE["{$wgDBname}Token"];
663 return new User(); # Can't log in from session
666 if ( ( $sName == $user->mName
) && $passwordCorrect ) {
668 if($wgMemc->set( $key, $user ))
669 wfDebug( "User::loadFromSession() successfully saved user\n" );
671 wfDebug( "User::loadFromSession() unable to save to memcached\n" );
675 return new User(); # Can't log in from session
679 * Load a user from the database
681 function loadFromDatabase() {
682 $fname = "User::loadFromDatabase";
684 # Counter-intuitive, breaks various things, use User::setLoaded() if you want to suppress
685 # loading in a command line script, don't assume all command line scripts need it like this
686 #if ( $this->mDataLoaded || $wgCommandLineMode ) {
687 if ( $this->mDataLoaded
) {
692 $this->mId
= intval( $this->mId
);
694 /** Anonymous user */
697 $this->mRights
= $this->getGroupPermissions( array( '*' ) );
698 $this->mDataLoaded
= true;
700 } # the following stuff is for non-anonymous users only
702 $dbr =& wfGetDB( DB_SLAVE
);
703 $s = $dbr->selectRow( 'user', array( 'user_name','user_password','user_newpassword','user_email',
704 'user_email_authenticated',
705 'user_real_name','user_options','user_touched', 'user_token', 'user_registration' ),
706 array( 'user_id' => $this->mId
), $fname );
708 if ( $s !== false ) {
709 $this->mName
= $s->user_name
;
710 $this->mEmail
= $s->user_email
;
711 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $s->user_email_authenticated
);
712 $this->mRealName
= $s->user_real_name
;
713 $this->mPassword
= $s->user_password
;
714 $this->mNewpassword
= $s->user_newpassword
;
715 $this->decodeOptions( $s->user_options
);
716 $this->mTouched
= wfTimestamp(TS_MW
,$s->user_touched
);
717 $this->mToken
= $s->user_token
;
718 $this->mRegistration
= wfTimestamp( TS_MW
, $s->user_registration
);
720 $res = $dbr->select( 'user_groups',
722 array( 'ug_user' => $this->mId
),
724 $this->mGroups
= array();
725 while( $row = $dbr->fetchObject( $res ) ) {
726 $this->mGroups
[] = $row->ug_group
;
728 $implicitGroups = array( '*', 'user' );
730 global $wgAutoConfirmAge;
731 $accountAge = time() - wfTimestampOrNull( TS_UNIX
, $this->mRegistration
);
732 if( $accountAge >= $wgAutoConfirmAge ) {
733 $implicitGroups[] = 'autoconfirmed';
736 $effectiveGroups = array_merge( $implicitGroups, $this->mGroups
);
737 $this->mRights
= $this->getGroupPermissions( $effectiveGroups );
740 $this->mDataLoaded
= true;
743 function getID() { return $this->mId
; }
744 function setID( $v ) {
746 $this->mDataLoaded
= false;
750 $this->loadFromDatabase();
751 if ( $this->mName
=== false ) {
752 $this->mName
= wfGetIP();
757 function setName( $str ) {
758 $this->loadFromDatabase();
764 * Return the title dbkey form of the name, for eg user pages.
768 function getTitleKey() {
769 return str_replace( ' ', '_', $this->getName() );
772 function getNewtalk() {
773 $this->loadFromDatabase();
775 # Load the newtalk status if it is unloaded (mNewtalk=-1)
776 if( $this->mNewtalk
=== -1 ) {
777 $this->mNewtalk
= false; # reset talk page status
779 # Check memcached separately for anons, who have no
780 # entire User object stored in there.
782 global $wgDBname, $wgMemc;
783 $key = "$wgDBname:newtalk:ip:" . $this->getName();
784 $newtalk = $wgMemc->get( $key );
785 if( is_integer( $newtalk ) ) {
786 $this->mNewtalk
= (bool)$newtalk;
788 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
789 $wgMemc->set( $key, $this->mNewtalk
, time() ); // + 1800 );
792 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
796 return (bool)$this->mNewtalk
;
800 * Perform a user_newtalk check on current slaves; if the memcached data
801 * is funky we don't want newtalk state to get stuck on save, as that's
804 * @param string $field
809 function checkNewtalk( $field, $id ) {
810 $fname = 'User::checkNewtalk';
811 $dbr =& wfGetDB( DB_SLAVE
);
812 $ok = $dbr->selectField( 'user_newtalk', $field,
813 array( $field => $id ), $fname );
814 return $ok !== false;
819 * @param string $field
823 function updateNewtalk( $field, $id ) {
824 $fname = 'User::updateNewtalk';
825 if( $this->checkNewtalk( $field, $id ) ) {
826 wfDebug( "$fname already set ($field, $id), ignoring\n" );
829 $dbw =& wfGetDB( DB_MASTER
);
830 $dbw->insert( 'user_newtalk',
831 array( $field => $id ),
834 wfDebug( "$fname: set on ($field, $id)\n" );
839 * @param string $field
843 function deleteNewtalk( $field, $id ) {
844 $fname = 'User::deleteNewtalk';
845 if( !$this->checkNewtalk( $field, $id ) ) {
846 wfDebug( "$fname: already gone ($field, $id), ignoring\n" );
849 $dbw =& wfGetDB( DB_MASTER
);
850 $dbw->delete( 'user_newtalk',
851 array( $field => $id ),
853 wfDebug( "$fname: killed on ($field, $id)\n" );
858 * Update the 'You have new messages!' status.
861 function setNewtalk( $val ) {
866 $this->loadFromDatabase();
867 $this->mNewtalk
= $val;
869 $fname = 'User::setNewtalk';
871 if( $this->isAnon() ) {
873 $id = $this->getName();
876 $id = $this->getId();
880 $changed = $this->updateNewtalk( $field, $id );
882 $changed = $this->deleteNewtalk( $field, $id );
886 if( $this->isAnon() ) {
887 // Anons have a separate memcached space, since
888 // user records aren't kept for them.
889 global $wgDBname, $wgMemc;
890 $key = "$wgDBname:newtalk:ip:$value";
891 $wgMemc->set( $key, $val ?
1 : 0 );
894 // Make sure the user page is watched, so a notification
895 // will be sent out if enabled.
896 $this->addWatch( $this->getTalkPage() );
899 $this->invalidateCache();
900 $this->saveSettings();
904 function invalidateCache() {
905 global $wgClockSkewFudge;
906 $this->loadFromDatabase();
907 $this->mTouched
= wfTimestamp(TS_MW
, time() +
$wgClockSkewFudge );
908 # Don't forget to save the options after this or
909 # it won't take effect!
912 function validateCache( $timestamp ) {
913 $this->loadFromDatabase();
914 return ($timestamp >= $this->mTouched
);
918 * Encrypt a password.
919 * It can eventuall salt a password @see User::addSalt()
920 * @param string $p clear Password.
921 * @return string Encrypted password.
923 function encryptPassword( $p ) {
924 return wfEncryptPassword( $this->mId
, $p );
927 # Set the password and reset the random token
928 function setPassword( $str ) {
929 $this->loadFromDatabase();
931 $this->mPassword
= $this->encryptPassword( $str );
932 $this->mNewpassword
= '';
935 # Set the random token (used for persistent authentication)
936 function setToken( $token = false ) {
937 global $wgSecretKey, $wgProxyKey, $wgDBname;
939 if ( $wgSecretKey ) {
941 } elseif ( $wgProxyKey ) {
946 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . $wgDBname . $this->mId
);
948 $this->mToken
= $token;
953 function setCookiePassword( $str ) {
954 $this->loadFromDatabase();
955 $this->mCookiePassword
= md5( $str );
958 function setNewpassword( $str ) {
959 $this->loadFromDatabase();
960 $this->mNewpassword
= $this->encryptPassword( $str );
963 function getEmail() {
964 $this->loadFromDatabase();
965 return $this->mEmail
;
968 function getEmailAuthenticationTimestamp() {
969 $this->loadFromDatabase();
970 return $this->mEmailAuthenticated
;
973 function setEmail( $str ) {
974 $this->loadFromDatabase();
975 $this->mEmail
= $str;
978 function getRealName() {
979 $this->loadFromDatabase();
980 return $this->mRealName
;
983 function setRealName( $str ) {
984 $this->loadFromDatabase();
985 $this->mRealName
= $str;
988 function getOption( $oname ) {
989 $this->loadFromDatabase();
990 if ( array_key_exists( $oname, $this->mOptions
) ) {
991 return trim( $this->mOptions
[$oname] );
997 function setOption( $oname, $val ) {
998 $this->loadFromDatabase();
999 if ( $oname == 'skin' ) {
1000 # Clear cached skin, so the new one displays immediately in Special:Preferences
1001 unset( $this->mSkin
);
1003 $this->mOptions
[$oname] = $val;
1004 $this->invalidateCache();
1007 function getRights() {
1008 $this->loadFromDatabase();
1009 return $this->mRights
;
1013 * Get the list of explicit group memberships this user has.
1014 * The implicit * and user groups are not included.
1015 * @return array of strings
1017 function getGroups() {
1018 $this->loadFromDatabase();
1019 return $this->mGroups
;
1023 * Get the list of implicit group memberships this user has.
1024 * This includes all explicit groups, plus 'user' if logged in
1025 * and '*' for all accounts.
1026 * @return array of strings
1028 function getEffectiveGroups() {
1029 $base = array( '*' );
1030 if( $this->isLoggedIn() ) {
1033 return array_merge( $base, $this->getGroups() );
1037 * Remove the user from the given group.
1038 * This takes immediate effect.
1041 function addGroup( $group ) {
1042 $dbw =& wfGetDB( DB_MASTER
);
1043 $dbw->insert( 'user_groups',
1045 'ug_user' => $this->getID(),
1046 'ug_group' => $group,
1049 array( 'IGNORE' ) );
1051 $this->mGroups
= array_merge( $this->mGroups
, array( $group ) );
1052 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups() );
1054 $this->invalidateCache();
1055 $this->saveSettings();
1059 * Remove the user from the given group.
1060 * This takes immediate effect.
1063 function removeGroup( $group ) {
1064 $dbw =& wfGetDB( DB_MASTER
);
1065 $dbw->delete( 'user_groups',
1067 'ug_user' => $this->getID(),
1068 'ug_group' => $group,
1070 'User::removeGroup' );
1072 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
1073 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups() );
1075 $this->invalidateCache();
1076 $this->saveSettings();
1081 * A more legible check for non-anonymousness.
1082 * Returns true if the user is not an anonymous visitor.
1086 function isLoggedIn() {
1087 return( $this->getID() != 0 );
1091 * A more legible check for anonymousness.
1092 * Returns true if the user is an anonymous visitor.
1097 return !$this->isLoggedIn();
1101 * Check if a user is sysop
1104 function isSysop() {
1105 return $this->isAllowed( 'protect' );
1109 function isDeveloper() {
1110 return $this->isAllowed( 'siteadmin' );
1114 function isBureaucrat() {
1115 return $this->isAllowed( 'makesysop' );
1119 * Whether the user is a bot
1120 * @todo need to be migrated to the new user level management sytem
1123 $this->loadFromDatabase();
1124 return in_array( 'bot', $this->mRights
);
1128 * Check if user is allowed to access a feature / make an action
1129 * @param string $action Action to be checked (see $wgAvailableRights in Defines.php for possible actions).
1130 * @return boolean True: action is allowed, False: action should not be allowed
1132 function isAllowed($action='') {
1133 if ( $action === '' )
1134 // In the spirit of DWIM
1137 $this->loadFromDatabase();
1138 return in_array( $action , $this->mRights
);
1142 * Load a skin if it doesn't exist or return it
1143 * @todo FIXME : need to check the old failback system [AV]
1145 function &getSkin() {
1146 global $IP, $wgRequest;
1147 if ( ! isset( $this->mSkin
) ) {
1148 $fname = 'User::getSkin';
1149 wfProfileIn( $fname );
1151 # get all skin names available
1152 $skinNames = Skin
::getSkinNames();
1155 $userSkin = $this->getOption( 'skin' );
1156 $userSkin = $wgRequest->getVal('useskin', $userSkin);
1158 $this->mSkin
=& Skin
::newFromKey( $userSkin );
1159 wfProfileOut( $fname );
1161 return $this->mSkin
;
1165 * @param string $title Article title to look at
1169 * Check watched status of an article
1170 * @return bool True if article is watched
1172 function isWatched( $title ) {
1173 $wl = WatchedItem
::fromUserTitle( $this, $title );
1174 return $wl->isWatched();
1180 function addWatch( $title ) {
1181 $wl = WatchedItem
::fromUserTitle( $this, $title );
1183 $this->invalidateCache();
1187 * Stop watching an article
1189 function removeWatch( $title ) {
1190 $wl = WatchedItem
::fromUserTitle( $this, $title );
1192 $this->invalidateCache();
1196 * Clear the user's notification timestamp for the given title.
1197 * If e-notif e-mails are on, they will receive notification mails on
1198 * the next change of the page if it's watched etc.
1200 function clearNotification( &$title ) {
1201 global $wgUser, $wgUseEnotif;
1203 if ($title->getNamespace() == NS_USER_TALK
&&
1204 $title->getText() == $this->getName() ) {
1205 $this->setNewtalk( false );
1208 if( !$wgUseEnotif ) {
1212 if( $this->isAnon() ) {
1213 // Nothing else to do...
1217 // Only update the timestamp if the page is being watched.
1218 // The query to find out if it is watched is cached both in memcached and per-invocation,
1219 // and when it does have to be executed, it can be on a slave
1220 // If this is the user's newtalk page, we always update the timestamp
1221 if ($title->getNamespace() == NS_USER_TALK
&&
1222 $title->getText() == $wgUser->getName())
1225 } elseif ( $this->getID() == $wgUser->getID() ) {
1226 $watched = $title->userIsWatching();
1231 // If the page is watched by the user (or may be watched), update the timestamp on any
1232 // any matching rows
1234 $dbw =& wfGetDB( DB_MASTER
);
1235 $success = $dbw->update( 'watchlist',
1237 'wl_notificationtimestamp' => NULL
1238 ), array( /* WHERE */
1239 'wl_title' => $title->getDBkey(),
1240 'wl_namespace' => $title->getNamespace(),
1241 'wl_user' => $this->getID()
1242 ), 'User::clearLastVisited'
1250 * Resets all of the given user's page-change notification timestamps.
1251 * If e-notif e-mails are on, they will receive notification mails on
1252 * the next change of any watched page.
1254 * @param int $currentUser user ID number
1257 function clearAllNotifications( $currentUser ) {
1258 global $wgUseEnotif;
1259 if ( !$wgUseEnotif ) {
1260 $this->setNewtalk( false );
1263 if( $currentUser != 0 ) {
1265 $dbw =& wfGetDB( DB_MASTER
);
1266 $success = $dbw->update( 'watchlist',
1268 'wl_notificationtimestamp' => 0
1269 ), array( /* WHERE */
1270 'wl_user' => $currentUser
1271 ), 'UserMailer::clearAll'
1274 # we also need to clear here the "you have new message" notification for the own user_talk page
1275 # This is cleared one page view later in Article::viewUpdates();
1281 * @return string Encoding options
1283 function encodeOptions() {
1285 foreach ( $this->mOptions
as $oname => $oval ) {
1286 array_push( $a, $oname.'='.$oval );
1288 $s = implode( "\n", $a );
1295 function decodeOptions( $str ) {
1296 $a = explode( "\n", $str );
1297 foreach ( $a as $s ) {
1298 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
1299 $this->mOptions
[$m[1]] = $m[2];
1304 function setCookies() {
1305 global $wgCookieExpiration, $wgCookiePath, $wgCookieDomain, $wgDBname;
1306 if ( 0 == $this->mId
) return;
1307 $this->loadFromDatabase();
1308 $exp = time() +
$wgCookieExpiration;
1310 $_SESSION['wsUserID'] = $this->mId
;
1311 setcookie( $wgDBname.'UserID', $this->mId
, $exp, $wgCookiePath, $wgCookieDomain );
1313 $_SESSION['wsUserName'] = $this->getName();
1314 setcookie( $wgDBname.'UserName', $this->getName(), $exp, $wgCookiePath, $wgCookieDomain );
1316 $_SESSION['wsToken'] = $this->mToken
;
1317 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
1318 setcookie( $wgDBname.'Token', $this->mToken
, $exp, $wgCookiePath, $wgCookieDomain );
1320 setcookie( $wgDBname.'Token', '', time() - 3600 );
1326 * It will clean the session cookie
1329 global $wgCookiePath, $wgCookieDomain, $wgDBname;
1330 $this->loadDefaults();
1331 $this->setLoaded( true );
1333 $_SESSION['wsUserID'] = 0;
1335 setcookie( $wgDBname.'UserID', '', time() - 3600, $wgCookiePath, $wgCookieDomain );
1336 setcookie( $wgDBname.'Token', '', time() - 3600, $wgCookiePath, $wgCookieDomain );
1338 # Remember when user logged out, to prevent seeing cached pages
1339 setcookie( $wgDBname.'LoggedOut', wfTimestampNow(), time() +
86400, $wgCookiePath, $wgCookieDomain );
1343 * Save object settings into database
1345 function saveSettings() {
1346 global $wgMemc, $wgDBname, $wgUseEnotif;
1347 $fname = 'User::saveSettings';
1349 if ( wfReadOnly() ) { return; }
1350 if ( 0 == $this->mId
) { return; }
1352 $dbw =& wfGetDB( DB_MASTER
);
1353 $dbw->update( 'user',
1355 'user_name' => $this->mName
,
1356 'user_password' => $this->mPassword
,
1357 'user_newpassword' => $this->mNewpassword
,
1358 'user_real_name' => $this->mRealName
,
1359 'user_email' => $this->mEmail
,
1360 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
1361 'user_options' => $this->encodeOptions(),
1362 'user_touched' => $dbw->timestamp($this->mTouched
),
1363 'user_token' => $this->mToken
1364 ), array( /* WHERE */
1365 'user_id' => $this->mId
1368 $wgMemc->delete( "$wgDBname:user:id:$this->mId" );
1373 * Checks if a user with the given name exists, returns the ID
1375 function idForName() {
1376 $fname = 'User::idForName';
1379 $s = trim( $this->getName() );
1380 if ( 0 == strcmp( '', $s ) ) return 0;
1382 $dbr =& wfGetDB( DB_SLAVE
);
1383 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), $fname );
1384 if ( $id === false ) {
1391 * Add user object to the database
1393 function addToDatabase() {
1394 $fname = 'User::addToDatabase';
1395 $dbw =& wfGetDB( DB_MASTER
);
1396 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
1397 $dbw->insert( 'user',
1399 'user_id' => $seqVal,
1400 'user_name' => $this->mName
,
1401 'user_password' => $this->mPassword
,
1402 'user_newpassword' => $this->mNewpassword
,
1403 'user_email' => $this->mEmail
,
1404 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
1405 'user_real_name' => $this->mRealName
,
1406 'user_options' => $this->encodeOptions(),
1407 'user_token' => $this->mToken
,
1408 'user_registration' => $dbw->timestamp( $this->mRegistration
),
1411 $this->mId
= $dbw->insertId();
1414 function spreadBlock() {
1415 # If the (non-anonymous) user is blocked, this function will block any IP address
1416 # that they successfully log on from.
1417 $fname = 'User::spreadBlock';
1419 wfDebug( "User:spreadBlock()\n" );
1420 if ( $this->mId
== 0 ) {
1424 $userblock = Block
::newFromDB( '', $this->mId
);
1425 if ( !$userblock->isValid() ) {
1429 # Check if this IP address is already blocked
1430 $ipblock = Block
::newFromDB( wfGetIP() );
1431 if ( $ipblock->isValid() ) {
1432 # If the user is already blocked. Then check if the autoblock would
1433 # excede the user block. If it would excede, then do nothing, else
1434 # prolong block time
1435 if ($userblock->mExpiry
&&
1436 ($userblock->mExpiry
< Block
::getAutoblockExpiry($ipblock->mTimestamp
))) {
1439 # Just update the timestamp
1440 $ipblock->updateTimestamp();
1444 # Make a new block object with the desired properties
1445 wfDebug( "Autoblocking {$this->mName}@" . wfGetIP() . "\n" );
1446 $ipblock->mAddress
= wfGetIP();
1447 $ipblock->mUser
= 0;
1448 $ipblock->mBy
= $userblock->mBy
;
1449 $ipblock->mReason
= wfMsg( 'autoblocker', $this->getName(), $userblock->mReason
);
1450 $ipblock->mTimestamp
= wfTimestampNow();
1451 $ipblock->mAuto
= 1;
1452 # If the user is already blocked with an expiry date, we don't
1453 # want to pile on top of that!
1454 if($userblock->mExpiry
) {
1455 $ipblock->mExpiry
= min ( $userblock->mExpiry
, Block
::getAutoblockExpiry( $ipblock->mTimestamp
));
1457 $ipblock->mExpiry
= Block
::getAutoblockExpiry( $ipblock->mTimestamp
);
1465 function getPageRenderingHash() {
1468 return $this->mHash
;
1471 // stubthreshold is only included below for completeness,
1472 // it will always be 0 when this function is called by parsercache.
1474 $confstr = $this->getOption( 'math' );
1475 $confstr .= '!' . $this->getOption( 'stubthreshold' );
1476 $confstr .= '!' . $this->getOption( 'date' );
1477 $confstr .= '!' . ($this->getOption( 'numberheadings' ) ?
'1' : '');
1478 $confstr .= '!' . $this->getOption( 'language' );
1479 $confstr .= '!' . $this->getOption( 'thumbsize' );
1480 // add in language specific options, if any
1481 $extra = $wgContLang->getExtraHashOptions();
1484 $this->mHash
= $confstr;
1488 function isAllowedToCreateAccount() {
1489 return $this->isAllowed( 'createaccount' ) && !$this->isBlocked();
1493 * Set mDataLoaded, return previous value
1494 * Use this to prevent DB access in command-line scripts or similar situations
1496 function setLoaded( $loaded ) {
1497 return wfSetVar( $this->mDataLoaded
, $loaded );
1501 * Get this user's personal page title.
1506 function getUserPage() {
1507 return Title
::makeTitle( NS_USER
, $this->getName() );
1511 * Get this user's talk page title.
1516 function getTalkPage() {
1517 $title = $this->getUserPage();
1518 return $title->getTalkPage();
1524 function getMaxID() {
1525 static $res; // cache
1527 if ( isset( $res ) )
1530 $dbr =& wfGetDB( DB_SLAVE
);
1531 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
1536 * Determine whether the user is a newbie. Newbies are either
1537 * anonymous IPs, or the 1% most recently created accounts.
1538 * Bots and sysops are excluded.
1539 * @return bool True if it is a newbie.
1541 function isNewbie() {
1542 return !$this->isAllowed( 'autoconfirmed' );
1543 //return $this->isAnon() || $this->mId > User::getMaxID() * 0.99 && !$this->isAllowed( 'delete' ) && !$this->isBot();
1547 * Check to see if the given clear-text password is one of the accepted passwords
1548 * @param string $password User password.
1549 * @return bool True if the given password is correct otherwise False.
1551 function checkPassword( $password ) {
1552 global $wgAuth, $wgMinimalPasswordLength;
1553 $this->loadFromDatabase();
1555 // Even though we stop people from creating passwords that
1556 // are shorter than this, doesn't mean people wont be able
1557 // to. Certain authentication plugins do NOT want to save
1558 // domain passwords in a mysql database, so we should
1559 // check this (incase $wgAuth->strict() is false).
1560 if( strlen( $password ) < $wgMinimalPasswordLength ) {
1564 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
1566 } elseif( $wgAuth->strict() ) {
1567 /* Auth plugin doesn't allow local authentication */
1570 $ep = $this->encryptPassword( $password );
1571 if ( 0 == strcmp( $ep, $this->mPassword
) ) {
1573 } elseif ( ($this->mNewpassword
!= '') && (0 == strcmp( $ep, $this->mNewpassword
)) ) {
1575 } elseif ( function_exists( 'iconv' ) ) {
1576 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
1577 # Check for this with iconv
1578 $cp1252hash = $this->encryptPassword( iconv( 'UTF-8', 'WINDOWS-1252', $password ) );
1579 if ( 0 == strcmp( $cp1252hash, $this->mPassword
) ) {
1587 * Initialize (if necessary) and return a session token value
1588 * which can be used in edit forms to show that the user's
1589 * login credentials aren't being hijacked with a foreign form
1592 * @param mixed $salt - Optional function-specific data for hash.
1593 * Use a string or an array of strings.
1597 function editToken( $salt = '' ) {
1598 if( !isset( $_SESSION['wsEditToken'] ) ) {
1599 $token = $this->generateToken();
1600 $_SESSION['wsEditToken'] = $token;
1602 $token = $_SESSION['wsEditToken'];
1604 if( is_array( $salt ) ) {
1605 $salt = implode( '|', $salt );
1607 return md5( $token . $salt );
1611 * Generate a hex-y looking random token for various uses.
1612 * Could be made more cryptographically sure if someone cares.
1615 function generateToken( $salt = '' ) {
1616 $token = dechex( mt_rand() ) . dechex( mt_rand() );
1617 return md5( $token . $salt );
1621 * Check given value against the token value stored in the session.
1622 * A match should confirm that the form was submitted from the
1623 * user's own login session, not a form submission from a third-party
1626 * @param string $val - the input value to compare
1627 * @param string $salt - Optional function-specific data for hash
1631 function matchEditToken( $val, $salt = '' ) {
1635 if ( !isset( $_SESSION['wsEditToken'] ) ) {
1636 $logfile = '/home/wikipedia/logs/session_debug/session.log';
1637 $mckey = memsess_key( session_id() );
1638 $uname = @posix_uname();
1639 $msg = "wsEditToken not set!\n" .
1640 'apache server=' . $uname['nodename'] . "\n" .
1641 'session_id = ' . session_id() . "\n" .
1642 '$_SESSION=' . var_export( $_SESSION, true ) . "\n" .
1643 '$_COOKIE=' . var_export( $_COOKIE, true ) . "\n" .
1644 "mc get($mckey) = " . var_export( $wgMemc->get( $mckey ), true ) . "\n\n\n";
1646 @error_log( $msg, 3, $logfile );
1649 return ( $val == $this->editToken( $salt ) );
1653 * Generate a new e-mail confirmation token and send a confirmation
1654 * mail to the user's given address.
1656 * @return mixed True on success, a WikiError object on failure.
1658 function sendConfirmationMail() {
1660 $url = $this->confirmationTokenUrl( $expiration );
1661 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
1662 wfMsg( 'confirmemail_body',
1666 $wgContLang->timeanddate( $expiration, false ) ) );
1670 * Send an e-mail to this user's account. Does not check for
1671 * confirmed status or validity.
1673 * @param string $subject
1674 * @param string $body
1675 * @param strong $from Optional from address; default $wgPasswordSender will be used otherwise.
1676 * @return mixed True on success, a WikiError object on failure.
1678 function sendMail( $subject, $body, $from = null ) {
1679 if( is_null( $from ) ) {
1680 global $wgPasswordSender;
1681 $from = $wgPasswordSender;
1684 require_once( 'UserMailer.php' );
1685 $to = new MailAddress( $this );
1686 $sender = new MailAddress( $from );
1687 $error = userMailer( $to, $sender, $subject, $body );
1689 if( $error == '' ) {
1692 return new WikiError( $error );
1697 * Generate, store, and return a new e-mail confirmation code.
1698 * A hash (unsalted since it's used as a key) is stored.
1699 * @param &$expiration mixed output: accepts the expiration time
1703 function confirmationToken( &$expiration ) {
1704 $fname = 'User::confirmationToken';
1707 $expires = $now +
7 * 24 * 60 * 60;
1708 $expiration = wfTimestamp( TS_MW
, $expires );
1710 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
1711 $hash = md5( $token );
1713 $dbw =& wfGetDB( DB_MASTER
);
1714 $dbw->update( 'user',
1715 array( 'user_email_token' => $hash,
1716 'user_email_token_expires' => $dbw->timestamp( $expires ) ),
1717 array( 'user_id' => $this->mId
),
1724 * Generate and store a new e-mail confirmation token, and return
1725 * the URL the user can use to confirm.
1726 * @param &$expiration mixed output: accepts the expiration time
1730 function confirmationTokenUrl( &$expiration ) {
1731 $token = $this->confirmationToken( $expiration );
1732 $title = Title
::makeTitle( NS_SPECIAL
, 'Confirmemail/' . $token );
1733 return $title->getFullUrl();
1737 * Mark the e-mail address confirmed and save.
1739 function confirmEmail() {
1740 $this->loadFromDatabase();
1741 $this->mEmailAuthenticated
= wfTimestampNow();
1742 $this->saveSettings();
1747 * Is this user allowed to send e-mails within limits of current
1748 * site configuration?
1751 function canSendEmail() {
1752 return $this->isEmailConfirmed();
1756 * Is this user allowed to receive e-mails within limits of current
1757 * site configuration?
1760 function canReceiveEmail() {
1761 return $this->canSendEmail() && !$this->getOption( 'disablemail' );
1765 * Is this user's e-mail address valid-looking and confirmed within
1766 * limits of the current site configuration?
1768 * If $wgEmailAuthentication is on, this may require the user to have
1769 * confirmed their address by returning a code or using a password
1770 * sent to the address from the wiki.
1774 function isEmailConfirmed() {
1775 global $wgEmailAuthentication;
1776 $this->loadFromDatabase();
1777 if( $this->isAnon() )
1779 if( !$this->isValidEmailAddr( $this->mEmail
) )
1781 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
1787 * @param array $groups list of groups
1788 * @return array list of permission key names for given groups combined
1791 function getGroupPermissions( $groups ) {
1792 global $wgGroupPermissions;
1794 foreach( $groups as $group ) {
1795 if( isset( $wgGroupPermissions[$group] ) ) {
1796 $rights = array_merge( $rights,
1797 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
1804 * @param string $group key name
1805 * @return string localized descriptive name, if provided
1808 function getGroupName( $group ) {
1809 $key = "group-$group-name";
1810 $name = wfMsg( $key );
1811 if( $name == '' ||
$name == "<$key>" ) {
1819 * Return the set of defined explicit groups.
1820 * The * and 'user' groups are not included.
1824 function getAllGroups() {
1825 global $wgGroupPermissions;
1827 array_keys( $wgGroupPermissions ),
1828 array( '*', 'user', 'autoconfirmed' ) );