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