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