Commenting and doc fixes around the spam regexes
[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'] = $wgContLang->getCode();
1244 foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
1245 $defOpt[$langCode == $wgContLang->getCode() ? 'variant' : "variant-$langCode"] = $langCode;
1246 }
1247 foreach ( SearchEngine::searchableNamespaces() as $nsnum => $nsname ) {
1248 $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1249 }
1250 $defOpt['skin'] = $wgDefaultSkin;
1251
1252 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1253
1254 return $defOpt;
1255 }
1256
1257 /**
1258 * Get a given default option value.
1259 *
1260 * @param string $opt Name of option to retrieve
1261 * @return string Default option value
1262 */
1263 public static function getDefaultOption( $opt ) {
1264 $defOpts = self::getDefaultOptions();
1265 if ( isset( $defOpts[$opt] ) ) {
1266 return $defOpts[$opt];
1267 } else {
1268 return null;
1269 }
1270 }
1271
1272 /**
1273 * Get blocking information
1274 * @param bool $bFromSlave Whether to check the slave database first. To
1275 * improve performance, non-critical checks are done
1276 * against slaves. Check when actually saving should be
1277 * done against master.
1278 */
1279 private function getBlockedStatus( $bFromSlave = true ) {
1280 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1281
1282 if ( -1 != $this->mBlockedby ) {
1283 return;
1284 }
1285
1286 wfProfileIn( __METHOD__ );
1287 wfDebug( __METHOD__ . ": checking...\n" );
1288
1289 // Initialize data...
1290 // Otherwise something ends up stomping on $this->mBlockedby when
1291 // things get lazy-loaded later, causing false positive block hits
1292 // due to -1 !== 0. Probably session-related... Nothing should be
1293 // overwriting mBlockedby, surely?
1294 $this->load();
1295
1296 # We only need to worry about passing the IP address to the Block generator if the
1297 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1298 # know which IP address they're actually coming from
1299 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1300 $ip = $this->getRequest()->getIP();
1301 } else {
1302 $ip = null;
1303 }
1304
1305 // User/IP blocking
1306 $block = Block::newFromTarget( $this, $ip, !$bFromSlave );
1307
1308 // Proxy blocking
1309 if ( !$block instanceof Block && $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1310 && !in_array( $ip, $wgProxyWhitelist ) )
1311 {
1312 // Local list
1313 if ( self::isLocallyBlockedProxy( $ip ) ) {
1314 $block = new Block;
1315 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1316 $block->mReason = wfMessage( 'proxyblockreason' )->text();
1317 $block->setTarget( $ip );
1318 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1319 $block = new Block;
1320 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1321 $block->mReason = wfMessage( 'sorbsreason' )->text();
1322 $block->setTarget( $ip );
1323 }
1324 }
1325
1326 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1327 if ( !$block instanceof Block
1328 && $wgApplyIpBlocksToXff
1329 && $ip !== null
1330 && !$this->isAllowed( 'proxyunbannable' )
1331 && !in_array( $ip, $wgProxyWhitelist )
1332 ) {
1333 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1334 $xff = array_map( 'trim', explode( ',', $xff ) );
1335 $xff = array_diff( $xff, array( $ip ) );
1336 $xffblocks = Block::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1337 $block = Block::chooseBlock( $xffblocks, $xff );
1338 if ( $block instanceof Block ) {
1339 # Mangle the reason to alert the user that the block
1340 # originated from matching the X-Forwarded-For header.
1341 $block->mReason = wfMessage( 'xffblockreason', $block->mReason )->text();
1342 }
1343 }
1344
1345 if ( $block instanceof Block ) {
1346 wfDebug( __METHOD__ . ": Found block.\n" );
1347 $this->mBlock = $block;
1348 $this->mBlockedby = $block->getByName();
1349 $this->mBlockreason = $block->mReason;
1350 $this->mHideName = $block->mHideName;
1351 $this->mAllowUsertalk = !$block->prevents( 'editownusertalk' );
1352 } else {
1353 $this->mBlockedby = '';
1354 $this->mHideName = 0;
1355 $this->mAllowUsertalk = false;
1356 }
1357
1358 // Extensions
1359 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1360
1361 wfProfileOut( __METHOD__ );
1362 }
1363
1364 /**
1365 * Whether the given IP is in a DNS blacklist.
1366 *
1367 * @param string $ip IP to check
1368 * @param bool $checkWhitelist whether to check the whitelist first
1369 * @return bool True if blacklisted.
1370 */
1371 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1372 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1373 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1374
1375 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs ) {
1376 return false;
1377 }
1378
1379 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1380 return false;
1381 }
1382
1383 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1384 return $this->inDnsBlacklist( $ip, $urls );
1385 }
1386
1387 /**
1388 * Whether the given IP is in a given DNS blacklist.
1389 *
1390 * @param string $ip IP to check
1391 * @param string|array $bases of Strings: URL of the DNS blacklist
1392 * @return bool True if blacklisted.
1393 */
1394 public function inDnsBlacklist( $ip, $bases ) {
1395 wfProfileIn( __METHOD__ );
1396
1397 $found = false;
1398 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1399 if ( IP::isIPv4( $ip ) ) {
1400 // Reverse IP, bug 21255
1401 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1402
1403 foreach ( (array)$bases as $base ) {
1404 // Make hostname
1405 // If we have an access key, use that too (ProjectHoneypot, etc.)
1406 if ( is_array( $base ) ) {
1407 if ( count( $base ) >= 2 ) {
1408 // Access key is 1, base URL is 0
1409 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1410 } else {
1411 $host = "$ipReversed.{$base[0]}";
1412 }
1413 } else {
1414 $host = "$ipReversed.$base";
1415 }
1416
1417 // Send query
1418 $ipList = gethostbynamel( $host );
1419
1420 if ( $ipList ) {
1421 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1422 $found = true;
1423 break;
1424 } else {
1425 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1426 }
1427 }
1428 }
1429
1430 wfProfileOut( __METHOD__ );
1431 return $found;
1432 }
1433
1434 /**
1435 * Check if an IP address is in the local proxy list
1436 *
1437 * @param $ip string
1438 *
1439 * @return bool
1440 */
1441 public static function isLocallyBlockedProxy( $ip ) {
1442 global $wgProxyList;
1443
1444 if ( !$wgProxyList ) {
1445 return false;
1446 }
1447 wfProfileIn( __METHOD__ );
1448
1449 if ( !is_array( $wgProxyList ) ) {
1450 // Load from the specified file
1451 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1452 }
1453
1454 if ( !is_array( $wgProxyList ) ) {
1455 $ret = false;
1456 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1457 $ret = true;
1458 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1459 // Old-style flipped proxy list
1460 $ret = true;
1461 } else {
1462 $ret = false;
1463 }
1464 wfProfileOut( __METHOD__ );
1465 return $ret;
1466 }
1467
1468 /**
1469 * Is this user subject to rate limiting?
1470 *
1471 * @return bool True if rate limited
1472 */
1473 public function isPingLimitable() {
1474 global $wgRateLimitsExcludedIPs;
1475 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1476 // No other good way currently to disable rate limits
1477 // for specific IPs. :P
1478 // But this is a crappy hack and should die.
1479 return false;
1480 }
1481 return !$this->isAllowed( 'noratelimit' );
1482 }
1483
1484 /**
1485 * Primitive rate limits: enforce maximum actions per time period
1486 * to put a brake on flooding.
1487 *
1488 * @note When using a shared cache like memcached, IP-address
1489 * last-hit counters will be shared across wikis.
1490 *
1491 * @param string $action Action to enforce; 'edit' if unspecified
1492 * @return bool True if a rate limiter was tripped
1493 */
1494 public function pingLimiter( $action = 'edit' ) {
1495 // Call the 'PingLimiter' hook
1496 $result = false;
1497 if ( !wfRunHooks( 'PingLimiter', array( &$this, $action, &$result ) ) ) {
1498 return $result;
1499 }
1500
1501 global $wgRateLimits;
1502 if ( !isset( $wgRateLimits[$action] ) ) {
1503 return false;
1504 }
1505
1506 // Some groups shouldn't trigger the ping limiter, ever
1507 if ( !$this->isPingLimitable() ) {
1508 return false;
1509 }
1510
1511 global $wgMemc, $wgRateLimitLog;
1512 wfProfileIn( __METHOD__ );
1513
1514 $limits = $wgRateLimits[$action];
1515 $keys = array();
1516 $id = $this->getId();
1517 $userLimit = false;
1518
1519 if ( isset( $limits['anon'] ) && $id == 0 ) {
1520 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1521 }
1522
1523 if ( isset( $limits['user'] ) && $id != 0 ) {
1524 $userLimit = $limits['user'];
1525 }
1526 if ( $this->isNewbie() ) {
1527 if ( isset( $limits['newbie'] ) && $id != 0 ) {
1528 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1529 }
1530 if ( isset( $limits['ip'] ) ) {
1531 $ip = $this->getRequest()->getIP();
1532 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1533 }
1534 if ( isset( $limits['subnet'] ) ) {
1535 $ip = $this->getRequest()->getIP();
1536 $matches = array();
1537 $subnet = false;
1538 if ( IP::isIPv6( $ip ) ) {
1539 $parts = IP::parseRange( "$ip/64" );
1540 $subnet = $parts[0];
1541 } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1542 // IPv4
1543 $subnet = $matches[1];
1544 }
1545 if ( $subnet !== false ) {
1546 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1547 }
1548 }
1549 }
1550 // Check for group-specific permissions
1551 // If more than one group applies, use the group with the highest limit
1552 foreach ( $this->getGroups() as $group ) {
1553 if ( isset( $limits[$group] ) ) {
1554 if ( $userLimit === false || $limits[$group] > $userLimit ) {
1555 $userLimit = $limits[$group];
1556 }
1557 }
1558 }
1559 // Set the user limit key
1560 if ( $userLimit !== false ) {
1561 list( $max, $period ) = $userLimit;
1562 wfDebug( __METHOD__ . ": effective user limit: $max in {$period}s\n" );
1563 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1564 }
1565
1566 $triggered = false;
1567 foreach ( $keys as $key => $limit ) {
1568 list( $max, $period ) = $limit;
1569 $summary = "(limit $max in {$period}s)";
1570 $count = $wgMemc->get( $key );
1571 // Already pinged?
1572 if ( $count ) {
1573 if ( $count >= $max ) {
1574 wfDebug( __METHOD__ . ": tripped! $key at $count $summary\n" );
1575 if ( $wgRateLimitLog ) {
1576 wfSuppressWarnings();
1577 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW ) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND );
1578 wfRestoreWarnings();
1579 }
1580 $triggered = true;
1581 } else {
1582 wfDebug( __METHOD__ . ": ok. $key at $count $summary\n" );
1583 }
1584 } else {
1585 wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
1586 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1587 }
1588 $wgMemc->incr( $key );
1589 }
1590
1591 wfProfileOut( __METHOD__ );
1592 return $triggered;
1593 }
1594
1595 /**
1596 * Check if user is blocked
1597 *
1598 * @param bool $bFromSlave Whether to check the slave database instead of the master
1599 * @return bool True if blocked, false otherwise
1600 */
1601 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1602 return $this->getBlock( $bFromSlave ) instanceof Block && $this->getBlock()->prevents( 'edit' );
1603 }
1604
1605 /**
1606 * Get the block affecting the user, or null if the user is not blocked
1607 *
1608 * @param bool $bFromSlave Whether to check the slave database instead of the master
1609 * @return Block|null
1610 */
1611 public function getBlock( $bFromSlave = true ) {
1612 $this->getBlockedStatus( $bFromSlave );
1613 return $this->mBlock instanceof Block ? $this->mBlock : null;
1614 }
1615
1616 /**
1617 * Check if user is blocked from editing a particular article
1618 *
1619 * @param Title $title Title to check
1620 * @param bool $bFromSlave whether to check the slave database instead of the master
1621 * @return bool
1622 */
1623 function isBlockedFrom( $title, $bFromSlave = false ) {
1624 global $wgBlockAllowsUTEdit;
1625 wfProfileIn( __METHOD__ );
1626
1627 $blocked = $this->isBlocked( $bFromSlave );
1628 $allowUsertalk = ( $wgBlockAllowsUTEdit ? $this->mAllowUsertalk : false );
1629 // If a user's name is suppressed, they cannot make edits anywhere
1630 if ( !$this->mHideName && $allowUsertalk && $title->getText() === $this->getName() &&
1631 $title->getNamespace() == NS_USER_TALK ) {
1632 $blocked = false;
1633 wfDebug( __METHOD__ . ": self-talk page, ignoring any blocks\n" );
1634 }
1635
1636 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1637
1638 wfProfileOut( __METHOD__ );
1639 return $blocked;
1640 }
1641
1642 /**
1643 * If user is blocked, return the name of the user who placed the block
1644 * @return string Name of blocker
1645 */
1646 public function blockedBy() {
1647 $this->getBlockedStatus();
1648 return $this->mBlockedby;
1649 }
1650
1651 /**
1652 * If user is blocked, return the specified reason for the block
1653 * @return string Blocking reason
1654 */
1655 public function blockedFor() {
1656 $this->getBlockedStatus();
1657 return $this->mBlockreason;
1658 }
1659
1660 /**
1661 * If user is blocked, return the ID for the block
1662 * @return int Block ID
1663 */
1664 public function getBlockId() {
1665 $this->getBlockedStatus();
1666 return ( $this->mBlock ? $this->mBlock->getId() : false );
1667 }
1668
1669 /**
1670 * Check if user is blocked on all wikis.
1671 * Do not use for actual edit permission checks!
1672 * This is intended for quick UI checks.
1673 *
1674 * @param string $ip IP address, uses current client if none given
1675 * @return bool True if blocked, false otherwise
1676 */
1677 public function isBlockedGlobally( $ip = '' ) {
1678 if ( $this->mBlockedGlobally !== null ) {
1679 return $this->mBlockedGlobally;
1680 }
1681 // User is already an IP?
1682 if ( IP::isIPAddress( $this->getName() ) ) {
1683 $ip = $this->getName();
1684 } elseif ( !$ip ) {
1685 $ip = $this->getRequest()->getIP();
1686 }
1687 $blocked = false;
1688 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1689 $this->mBlockedGlobally = (bool)$blocked;
1690 return $this->mBlockedGlobally;
1691 }
1692
1693 /**
1694 * Check if user account is locked
1695 *
1696 * @return bool True if locked, false otherwise
1697 */
1698 public function isLocked() {
1699 if ( $this->mLocked !== null ) {
1700 return $this->mLocked;
1701 }
1702 global $wgAuth;
1703 $authUser = $wgAuth->getUserInstance( $this );
1704 $this->mLocked = (bool)$authUser->isLocked();
1705 return $this->mLocked;
1706 }
1707
1708 /**
1709 * Check if user account is hidden
1710 *
1711 * @return bool True if hidden, false otherwise
1712 */
1713 public function isHidden() {
1714 if ( $this->mHideName !== null ) {
1715 return $this->mHideName;
1716 }
1717 $this->getBlockedStatus();
1718 if ( !$this->mHideName ) {
1719 global $wgAuth;
1720 $authUser = $wgAuth->getUserInstance( $this );
1721 $this->mHideName = (bool)$authUser->isHidden();
1722 }
1723 return $this->mHideName;
1724 }
1725
1726 /**
1727 * Get the user's ID.
1728 * @return int The user's ID; 0 if the user is anonymous or nonexistent
1729 */
1730 public function getId() {
1731 if ( $this->mId === null && $this->mName !== null && User::isIP( $this->mName ) ) {
1732 // Special case, we know the user is anonymous
1733 return 0;
1734 } elseif ( !$this->isItemLoaded( 'id' ) ) {
1735 // Don't load if this was initialized from an ID
1736 $this->load();
1737 }
1738 return $this->mId;
1739 }
1740
1741 /**
1742 * Set the user and reload all fields according to a given ID
1743 * @param int $v User ID to reload
1744 */
1745 public function setId( $v ) {
1746 $this->mId = $v;
1747 $this->clearInstanceCache( 'id' );
1748 }
1749
1750 /**
1751 * Get the user name, or the IP of an anonymous user
1752 * @return string User's name or IP address
1753 */
1754 public function getName() {
1755 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1756 // Special case optimisation
1757 return $this->mName;
1758 } else {
1759 $this->load();
1760 if ( $this->mName === false ) {
1761 // Clean up IPs
1762 $this->mName = IP::sanitizeIP( $this->getRequest()->getIP() );
1763 }
1764 return $this->mName;
1765 }
1766 }
1767
1768 /**
1769 * Set the user name.
1770 *
1771 * This does not reload fields from the database according to the given
1772 * name. Rather, it is used to create a temporary "nonexistent user" for
1773 * later addition to the database. It can also be used to set the IP
1774 * address for an anonymous user to something other than the current
1775 * remote IP.
1776 *
1777 * @note User::newFromName() has roughly the same function, when the named user
1778 * does not exist.
1779 * @param string $str New user name to set
1780 */
1781 public function setName( $str ) {
1782 $this->load();
1783 $this->mName = $str;
1784 }
1785
1786 /**
1787 * Get the user's name escaped by underscores.
1788 * @return string Username escaped by underscores.
1789 */
1790 public function getTitleKey() {
1791 return str_replace( ' ', '_', $this->getName() );
1792 }
1793
1794 /**
1795 * Check if the user has new messages.
1796 * @return bool True if the user has new messages
1797 */
1798 public function getNewtalk() {
1799 $this->load();
1800
1801 // Load the newtalk status if it is unloaded (mNewtalk=-1)
1802 if ( $this->mNewtalk === -1 ) {
1803 $this->mNewtalk = false; # reset talk page status
1804
1805 // Check memcached separately for anons, who have no
1806 // entire User object stored in there.
1807 if ( !$this->mId ) {
1808 global $wgDisableAnonTalk;
1809 if ( $wgDisableAnonTalk ) {
1810 // Anon newtalk disabled by configuration.
1811 $this->mNewtalk = false;
1812 } else {
1813 global $wgMemc;
1814 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1815 $newtalk = $wgMemc->get( $key );
1816 if ( strval( $newtalk ) !== '' ) {
1817 $this->mNewtalk = (bool)$newtalk;
1818 } else {
1819 // Since we are caching this, make sure it is up to date by getting it
1820 // from the master
1821 $this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName(), true );
1822 $wgMemc->set( $key, (int)$this->mNewtalk, 1800 );
1823 }
1824 }
1825 } else {
1826 $this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
1827 }
1828 }
1829
1830 return (bool)$this->mNewtalk;
1831 }
1832
1833 /**
1834 * Return the data needed to construct links for new talk page message
1835 * alerts. If there are new messages, this will return an associative array
1836 * with the following data:
1837 * wiki: The database name of the wiki
1838 * link: Root-relative link to the user's talk page
1839 * rev: The last talk page revision that the user has seen or null. This
1840 * is useful for building diff links.
1841 * If there are no new messages, it returns an empty array.
1842 * @note This function was designed to accomodate multiple talk pages, but
1843 * currently only returns a single link and revision.
1844 * @return Array
1845 */
1846 public function getNewMessageLinks() {
1847 $talks = array();
1848 if ( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1849 return $talks;
1850 } elseif ( !$this->getNewtalk() ) {
1851 return array();
1852 }
1853 $utp = $this->getTalkPage();
1854 $dbr = wfGetDB( DB_SLAVE );
1855 // Get the "last viewed rev" timestamp from the oldest message notification
1856 $timestamp = $dbr->selectField( 'user_newtalk',
1857 'MIN(user_last_timestamp)',
1858 $this->isAnon() ? array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1859 __METHOD__ );
1860 $rev = $timestamp ? Revision::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1861 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1862 }
1863
1864 /**
1865 * Get the revision ID for the last talk page revision viewed by the talk
1866 * page owner.
1867 * @return int|null Revision ID or null
1868 */
1869 public function getNewMessageRevisionId() {
1870 $newMessageRevisionId = null;
1871 $newMessageLinks = $this->getNewMessageLinks();
1872 if ( $newMessageLinks ) {
1873 // Note: getNewMessageLinks() never returns more than a single link
1874 // and it is always for the same wiki, but we double-check here in
1875 // case that changes some time in the future.
1876 if ( count( $newMessageLinks ) === 1
1877 && $newMessageLinks[0]['wiki'] === wfWikiID()
1878 && $newMessageLinks[0]['rev']
1879 ) {
1880 $newMessageRevision = $newMessageLinks[0]['rev'];
1881 $newMessageRevisionId = $newMessageRevision->getId();
1882 }
1883 }
1884 return $newMessageRevisionId;
1885 }
1886
1887 /**
1888 * Internal uncached check for new messages
1889 *
1890 * @see getNewtalk()
1891 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
1892 * @param string|int $id User's IP address for anonymous users, User ID otherwise
1893 * @param bool $fromMaster true to fetch from the master, false for a slave
1894 * @return bool True if the user has new messages
1895 */
1896 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1897 if ( $fromMaster ) {
1898 $db = wfGetDB( DB_MASTER );
1899 } else {
1900 $db = wfGetDB( DB_SLAVE );
1901 }
1902 $ok = $db->selectField( 'user_newtalk', $field,
1903 array( $field => $id ), __METHOD__ );
1904 return $ok !== false;
1905 }
1906
1907 /**
1908 * Add or update the new messages flag
1909 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
1910 * @param string|int $id User's IP address for anonymous users, User ID otherwise
1911 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1912 * @return bool True if successful, false otherwise
1913 */
1914 protected function updateNewtalk( $field, $id, $curRev = null ) {
1915 // Get timestamp of the talk page revision prior to the current one
1916 $prevRev = $curRev ? $curRev->getPrevious() : false;
1917 $ts = $prevRev ? $prevRev->getTimestamp() : null;
1918 // Mark the user as having new messages since this revision
1919 $dbw = wfGetDB( DB_MASTER );
1920 $dbw->insert( 'user_newtalk',
1921 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1922 __METHOD__,
1923 'IGNORE' );
1924 if ( $dbw->affectedRows() ) {
1925 wfDebug( __METHOD__ . ": set on ($field, $id)\n" );
1926 return true;
1927 } else {
1928 wfDebug( __METHOD__ . " already set ($field, $id)\n" );
1929 return false;
1930 }
1931 }
1932
1933 /**
1934 * Clear the new messages flag for the given user
1935 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
1936 * @param string|int $id User's IP address for anonymous users, User ID otherwise
1937 * @return bool True if successful, false otherwise
1938 */
1939 protected function deleteNewtalk( $field, $id ) {
1940 $dbw = wfGetDB( DB_MASTER );
1941 $dbw->delete( 'user_newtalk',
1942 array( $field => $id ),
1943 __METHOD__ );
1944 if ( $dbw->affectedRows() ) {
1945 wfDebug( __METHOD__ . ": killed on ($field, $id)\n" );
1946 return true;
1947 } else {
1948 wfDebug( __METHOD__ . ": already gone ($field, $id)\n" );
1949 return false;
1950 }
1951 }
1952
1953 /**
1954 * Update the 'You have new messages!' status.
1955 * @param bool $val Whether the user has new messages
1956 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1957 */
1958 public function setNewtalk( $val, $curRev = null ) {
1959 if ( wfReadOnly() ) {
1960 return;
1961 }
1962
1963 $this->load();
1964 $this->mNewtalk = $val;
1965
1966 if ( $this->isAnon() ) {
1967 $field = 'user_ip';
1968 $id = $this->getName();
1969 } else {
1970 $field = 'user_id';
1971 $id = $this->getId();
1972 }
1973 global $wgMemc;
1974
1975 if ( $val ) {
1976 $changed = $this->updateNewtalk( $field, $id, $curRev );
1977 } else {
1978 $changed = $this->deleteNewtalk( $field, $id );
1979 }
1980
1981 if ( $this->isAnon() ) {
1982 // Anons have a separate memcached space, since
1983 // user records aren't kept for them.
1984 $key = wfMemcKey( 'newtalk', 'ip', $id );
1985 $wgMemc->set( $key, $val ? 1 : 0, 1800 );
1986 }
1987 if ( $changed ) {
1988 $this->invalidateCache();
1989 }
1990 }
1991
1992 /**
1993 * Generate a current or new-future timestamp to be stored in the
1994 * user_touched field when we update things.
1995 * @return string Timestamp in TS_MW format
1996 */
1997 private static function newTouchedTimestamp() {
1998 global $wgClockSkewFudge;
1999 return wfTimestamp( TS_MW, time() + $wgClockSkewFudge );
2000 }
2001
2002 /**
2003 * Clear user data from memcached.
2004 * Use after applying fun updates to the database; caller's
2005 * responsibility to update user_touched if appropriate.
2006 *
2007 * Called implicitly from invalidateCache() and saveSettings().
2008 */
2009 private function clearSharedCache() {
2010 $this->load();
2011 if ( $this->mId ) {
2012 global $wgMemc;
2013 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId ) );
2014 }
2015 }
2016
2017 /**
2018 * Immediately touch the user data cache for this account.
2019 * Updates user_touched field, and removes account data from memcached
2020 * for reload on the next hit.
2021 */
2022 public function invalidateCache() {
2023 if ( wfReadOnly() ) {
2024 return;
2025 }
2026 $this->load();
2027 if ( $this->mId ) {
2028 $this->mTouched = self::newTouchedTimestamp();
2029
2030 $dbw = wfGetDB( DB_MASTER );
2031 $userid = $this->mId;
2032 $touched = $this->mTouched;
2033 $method = __METHOD__;
2034 $dbw->onTransactionIdle( function() use ( $dbw, $userid, $touched, $method ) {
2035 // Prevent contention slams by checking user_touched first
2036 $encTouched = $dbw->addQuotes( $dbw->timestamp( $touched ) );
2037 $needsPurge = $dbw->selectField( 'user', '1',
2038 array( 'user_id' => $userid, 'user_touched < ' . $encTouched ) );
2039 if ( $needsPurge ) {
2040 $dbw->update( 'user',
2041 array( 'user_touched' => $dbw->timestamp( $touched ) ),
2042 array( 'user_id' => $userid, 'user_touched < ' . $encTouched ),
2043 $method
2044 );
2045 }
2046 } );
2047 $this->clearSharedCache();
2048 }
2049 }
2050
2051 /**
2052 * Validate the cache for this account.
2053 * @param string $timestamp A timestamp in TS_MW format
2054 * @return bool
2055 */
2056 public function validateCache( $timestamp ) {
2057 $this->load();
2058 return ( $timestamp >= $this->mTouched );
2059 }
2060
2061 /**
2062 * Get the user touched timestamp
2063 * @return string timestamp
2064 */
2065 public function getTouched() {
2066 $this->load();
2067 return $this->mTouched;
2068 }
2069
2070 /**
2071 * Set the password and reset the random token.
2072 * Calls through to authentication plugin if necessary;
2073 * will have no effect if the auth plugin refuses to
2074 * pass the change through or if the legal password
2075 * checks fail.
2076 *
2077 * As a special case, setting the password to null
2078 * wipes it, so the account cannot be logged in until
2079 * a new password is set, for instance via e-mail.
2080 *
2081 * @param string $str New password to set
2082 * @throws PasswordError on failure
2083 *
2084 * @return bool
2085 */
2086 public function setPassword( $str ) {
2087 global $wgAuth;
2088
2089 if ( $str !== null ) {
2090 if ( !$wgAuth->allowPasswordChange() ) {
2091 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2092 }
2093
2094 if ( !$this->isValidPassword( $str ) ) {
2095 global $wgMinimalPasswordLength;
2096 $valid = $this->getPasswordValidity( $str );
2097 if ( is_array( $valid ) ) {
2098 $message = array_shift( $valid );
2099 $params = $valid;
2100 } else {
2101 $message = $valid;
2102 $params = array( $wgMinimalPasswordLength );
2103 }
2104 throw new PasswordError( wfMessage( $message, $params )->text() );
2105 }
2106 }
2107
2108 if ( !$wgAuth->setPassword( $this, $str ) ) {
2109 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2110 }
2111
2112 $this->setInternalPassword( $str );
2113
2114 return true;
2115 }
2116
2117 /**
2118 * Set the password and reset the random token unconditionally.
2119 *
2120 * @param string|null $str New password to set or null to set an invalid
2121 * password hash meaning that the user will not be able to log in
2122 * through the web interface.
2123 */
2124 public function setInternalPassword( $str ) {
2125 $this->load();
2126 $this->setToken();
2127
2128 if ( $str === null ) {
2129 // Save an invalid hash...
2130 $this->mPassword = '';
2131 } else {
2132 $this->mPassword = self::crypt( $str );
2133 }
2134 $this->mNewpassword = '';
2135 $this->mNewpassTime = null;
2136 }
2137
2138 /**
2139 * Get the user's current token.
2140 * @param bool $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2141 * @return string Token
2142 */
2143 public function getToken( $forceCreation = true ) {
2144 $this->load();
2145 if ( !$this->mToken && $forceCreation ) {
2146 $this->setToken();
2147 }
2148 return $this->mToken;
2149 }
2150
2151 /**
2152 * Set the random token (used for persistent authentication)
2153 * Called from loadDefaults() among other places.
2154 *
2155 * @param string|bool $token If specified, set the token to this value
2156 */
2157 public function setToken( $token = false ) {
2158 $this->load();
2159 if ( !$token ) {
2160 $this->mToken = MWCryptRand::generateHex( USER_TOKEN_LENGTH );
2161 } else {
2162 $this->mToken = $token;
2163 }
2164 }
2165
2166 /**
2167 * Set the password for a password reminder or new account email
2168 *
2169 * @param string $str New password to set
2170 * @param bool $throttle If true, reset the throttle timestamp to the present
2171 */
2172 public function setNewpassword( $str, $throttle = true ) {
2173 $this->load();
2174 $this->mNewpassword = self::crypt( $str );
2175 if ( $throttle ) {
2176 $this->mNewpassTime = wfTimestampNow();
2177 }
2178 }
2179
2180 /**
2181 * Has password reminder email been sent within the last
2182 * $wgPasswordReminderResendTime hours?
2183 * @return bool
2184 */
2185 public function isPasswordReminderThrottled() {
2186 global $wgPasswordReminderResendTime;
2187 $this->load();
2188 if ( !$this->mNewpassTime || !$wgPasswordReminderResendTime ) {
2189 return false;
2190 }
2191 $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgPasswordReminderResendTime * 3600;
2192 return time() < $expiry;
2193 }
2194
2195 /**
2196 * Get the user's e-mail address
2197 * @return string User's email address
2198 */
2199 public function getEmail() {
2200 $this->load();
2201 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail ) );
2202 return $this->mEmail;
2203 }
2204
2205 /**
2206 * Get the timestamp of the user's e-mail authentication
2207 * @return string TS_MW timestamp
2208 */
2209 public function getEmailAuthenticationTimestamp() {
2210 $this->load();
2211 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
2212 return $this->mEmailAuthenticated;
2213 }
2214
2215 /**
2216 * Set the user's e-mail address
2217 * @param string $str New e-mail address
2218 */
2219 public function setEmail( $str ) {
2220 $this->load();
2221 if ( $str == $this->mEmail ) {
2222 return;
2223 }
2224 $this->mEmail = $str;
2225 $this->invalidateEmail();
2226 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail ) );
2227 }
2228
2229 /**
2230 * Set the user's e-mail address and a confirmation mail if needed.
2231 *
2232 * @since 1.20
2233 * @param string $str New e-mail address
2234 * @return Status
2235 */
2236 public function setEmailWithConfirmation( $str ) {
2237 global $wgEnableEmail, $wgEmailAuthentication;
2238
2239 if ( !$wgEnableEmail ) {
2240 return Status::newFatal( 'emaildisabled' );
2241 }
2242
2243 $oldaddr = $this->getEmail();
2244 if ( $str === $oldaddr ) {
2245 return Status::newGood( true );
2246 }
2247
2248 $this->setEmail( $str );
2249
2250 if ( $str !== '' && $wgEmailAuthentication ) {
2251 // Send a confirmation request to the new address if needed
2252 $type = $oldaddr != '' ? 'changed' : 'set';
2253 $result = $this->sendConfirmationMail( $type );
2254 if ( $result->isGood() ) {
2255 // Say the the caller that a confirmation mail has been sent
2256 $result->value = 'eauth';
2257 }
2258 } else {
2259 $result = Status::newGood( true );
2260 }
2261
2262 return $result;
2263 }
2264
2265 /**
2266 * Get the user's real name
2267 * @return string User's real name
2268 */
2269 public function getRealName() {
2270 if ( !$this->isItemLoaded( 'realname' ) ) {
2271 $this->load();
2272 }
2273
2274 return $this->mRealName;
2275 }
2276
2277 /**
2278 * Set the user's real name
2279 * @param string $str New real name
2280 */
2281 public function setRealName( $str ) {
2282 $this->load();
2283 $this->mRealName = $str;
2284 }
2285
2286 /**
2287 * Get the user's current setting for a given option.
2288 *
2289 * @param string $oname The option to check
2290 * @param string $defaultOverride A default value returned if the option does not exist
2291 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2292 * @return string User's current value for the option
2293 * @see getBoolOption()
2294 * @see getIntOption()
2295 */
2296 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2297 global $wgHiddenPrefs;
2298 $this->loadOptions();
2299
2300 # We want 'disabled' preferences to always behave as the default value for
2301 # users, even if they have set the option explicitly in their settings (ie they
2302 # set it, and then it was disabled removing their ability to change it). But
2303 # we don't want to erase the preferences in the database in case the preference
2304 # is re-enabled again. So don't touch $mOptions, just override the returned value
2305 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2306 return self::getDefaultOption( $oname );
2307 }
2308
2309 if ( array_key_exists( $oname, $this->mOptions ) ) {
2310 return $this->mOptions[$oname];
2311 } else {
2312 return $defaultOverride;
2313 }
2314 }
2315
2316 /**
2317 * Get all user's options
2318 *
2319 * @return array
2320 */
2321 public function getOptions() {
2322 global $wgHiddenPrefs;
2323 $this->loadOptions();
2324 $options = $this->mOptions;
2325
2326 # We want 'disabled' preferences to always behave as the default value for
2327 # users, even if they have set the option explicitly in their settings (ie they
2328 # set it, and then it was disabled removing their ability to change it). But
2329 # we don't want to erase the preferences in the database in case the preference
2330 # is re-enabled again. So don't touch $mOptions, just override the returned value
2331 foreach ( $wgHiddenPrefs as $pref ) {
2332 $default = self::getDefaultOption( $pref );
2333 if ( $default !== null ) {
2334 $options[$pref] = $default;
2335 }
2336 }
2337
2338 return $options;
2339 }
2340
2341 /**
2342 * Get the user's current setting for a given option, as a boolean value.
2343 *
2344 * @param string $oname The option to check
2345 * @return bool User's current value for the option
2346 * @see getOption()
2347 */
2348 public function getBoolOption( $oname ) {
2349 return (bool)$this->getOption( $oname );
2350 }
2351
2352 /**
2353 * Get the user's current setting for a given option, as an integer value.
2354 *
2355 * @param string $oname The option to check
2356 * @param int $defaultOverride A default value returned if the option does not exist
2357 * @return int User's current value for the option
2358 * @see getOption()
2359 */
2360 public function getIntOption( $oname, $defaultOverride = 0 ) {
2361 $val = $this->getOption( $oname );
2362 if ( $val == '' ) {
2363 $val = $defaultOverride;
2364 }
2365 return intval( $val );
2366 }
2367
2368 /**
2369 * Set the given option for a user.
2370 *
2371 * @param string $oname The option to set
2372 * @param mixed $val New value to set
2373 */
2374 public function setOption( $oname, $val ) {
2375 $this->loadOptions();
2376
2377 // Explicitly NULL values should refer to defaults
2378 if ( is_null( $val ) ) {
2379 $val = self::getDefaultOption( $oname );
2380 }
2381
2382 $this->mOptions[$oname] = $val;
2383 }
2384
2385 /**
2386 * Get a token stored in the preferences (like the watchlist one),
2387 * resetting it if it's empty (and saving changes).
2388 *
2389 * @param string $oname The option name to retrieve the token from
2390 * @return string|bool User's current value for the option, or false if this option is disabled.
2391 * @see resetTokenFromOption()
2392 * @see getOption()
2393 */
2394 public function getTokenFromOption( $oname ) {
2395 global $wgHiddenPrefs;
2396 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2397 return false;
2398 }
2399
2400 $token = $this->getOption( $oname );
2401 if ( !$token ) {
2402 $token = $this->resetTokenFromOption( $oname );
2403 $this->saveSettings();
2404 }
2405 return $token;
2406 }
2407
2408 /**
2409 * Reset a token stored in the preferences (like the watchlist one).
2410 * *Does not* save user's preferences (similarly to setOption()).
2411 *
2412 * @param string $oname The option name to reset the token in
2413 * @return string|bool New token value, or false if this option is disabled.
2414 * @see getTokenFromOption()
2415 * @see setOption()
2416 */
2417 public function resetTokenFromOption( $oname ) {
2418 global $wgHiddenPrefs;
2419 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2420 return false;
2421 }
2422
2423 $token = MWCryptRand::generateHex( 40 );
2424 $this->setOption( $oname, $token );
2425 return $token;
2426 }
2427
2428 /**
2429 * Return a list of the types of user options currently returned by
2430 * User::getOptionKinds().
2431 *
2432 * Currently, the option kinds are:
2433 * - 'registered' - preferences which are registered in core MediaWiki or
2434 * by extensions using the UserGetDefaultOptions hook.
2435 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2436 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2437 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2438 * be used by user scripts.
2439 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2440 * These are usually legacy options, removed in newer versions.
2441 *
2442 * The API (and possibly others) use this function to determine the possible
2443 * option types for validation purposes, so make sure to update this when a
2444 * new option kind is added.
2445 *
2446 * @see User::getOptionKinds
2447 * @return array Option kinds
2448 */
2449 public static function listOptionKinds() {
2450 return array(
2451 'registered',
2452 'registered-multiselect',
2453 'registered-checkmatrix',
2454 'userjs',
2455 'unused'
2456 );
2457 }
2458
2459 /**
2460 * Return an associative array mapping preferences keys to the kind of a preference they're
2461 * used for. Different kinds are handled differently when setting or reading preferences.
2462 *
2463 * See User::listOptionKinds for the list of valid option types that can be provided.
2464 *
2465 * @see User::listOptionKinds
2466 * @param $context IContextSource
2467 * @param array $options assoc. array with options keys to check as keys. Defaults to $this->mOptions.
2468 * @return array the key => kind mapping data
2469 */
2470 public function getOptionKinds( IContextSource $context, $options = null ) {
2471 $this->loadOptions();
2472 if ( $options === null ) {
2473 $options = $this->mOptions;
2474 }
2475
2476 $prefs = Preferences::getPreferences( $this, $context );
2477 $mapping = array();
2478
2479 // Multiselect and checkmatrix options are stored in the database with
2480 // one key per option, each having a boolean value. Extract those keys.
2481 $multiselectOptions = array();
2482 foreach ( $prefs as $name => $info ) {
2483 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2484 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2485 $opts = HTMLFormField::flattenOptions( $info['options'] );
2486 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
2487
2488 foreach ( $opts as $value ) {
2489 $multiselectOptions["$prefix$value"] = true;
2490 }
2491
2492 unset( $prefs[$name] );
2493 }
2494 }
2495 $checkmatrixOptions = array();
2496 foreach ( $prefs as $name => $info ) {
2497 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2498 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2499 $columns = HTMLFormField::flattenOptions( $info['columns'] );
2500 $rows = HTMLFormField::flattenOptions( $info['rows'] );
2501 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
2502
2503 foreach ( $columns as $column ) {
2504 foreach ( $rows as $row ) {
2505 $checkmatrixOptions["$prefix-$column-$row"] = true;
2506 }
2507 }
2508
2509 unset( $prefs[$name] );
2510 }
2511 }
2512
2513 // $value is ignored
2514 foreach ( $options as $key => $value ) {
2515 if ( isset( $prefs[$key] ) ) {
2516 $mapping[$key] = 'registered';
2517 } elseif ( isset( $multiselectOptions[$key] ) ) {
2518 $mapping[$key] = 'registered-multiselect';
2519 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
2520 $mapping[$key] = 'registered-checkmatrix';
2521 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2522 $mapping[$key] = 'userjs';
2523 } else {
2524 $mapping[$key] = 'unused';
2525 }
2526 }
2527
2528 return $mapping;
2529 }
2530
2531 /**
2532 * Reset certain (or all) options to the site defaults
2533 *
2534 * The optional parameter determines which kinds of preferences will be reset.
2535 * Supported values are everything that can be reported by getOptionKinds()
2536 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2537 *
2538 * @param array|string $resetKinds which kinds of preferences to reset. Defaults to
2539 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
2540 * for backwards-compatibility.
2541 * @param $context IContextSource|null context source used when $resetKinds
2542 * does not contain 'all', passed to getOptionKinds().
2543 * Defaults to RequestContext::getMain() when null.
2544 */
2545 public function resetOptions(
2546 $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ),
2547 IContextSource $context = null
2548 ) {
2549 $this->load();
2550 $defaultOptions = self::getDefaultOptions();
2551
2552 if ( !is_array( $resetKinds ) ) {
2553 $resetKinds = array( $resetKinds );
2554 }
2555
2556 if ( in_array( 'all', $resetKinds ) ) {
2557 $newOptions = $defaultOptions;
2558 } else {
2559 if ( $context === null ) {
2560 $context = RequestContext::getMain();
2561 }
2562
2563 $optionKinds = $this->getOptionKinds( $context );
2564 $resetKinds = array_intersect( $resetKinds, self::listOptionKinds() );
2565 $newOptions = array();
2566
2567 // Use default values for the options that should be deleted, and
2568 // copy old values for the ones that shouldn't.
2569 foreach ( $this->mOptions as $key => $value ) {
2570 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2571 if ( array_key_exists( $key, $defaultOptions ) ) {
2572 $newOptions[$key] = $defaultOptions[$key];
2573 }
2574 } else {
2575 $newOptions[$key] = $value;
2576 }
2577 }
2578 }
2579
2580 $this->mOptions = $newOptions;
2581 $this->mOptionsLoaded = true;
2582 }
2583
2584 /**
2585 * Get the user's preferred date format.
2586 * @return string User's preferred date format
2587 */
2588 public function getDatePreference() {
2589 // Important migration for old data rows
2590 if ( is_null( $this->mDatePreference ) ) {
2591 global $wgLang;
2592 $value = $this->getOption( 'date' );
2593 $map = $wgLang->getDatePreferenceMigrationMap();
2594 if ( isset( $map[$value] ) ) {
2595 $value = $map[$value];
2596 }
2597 $this->mDatePreference = $value;
2598 }
2599 return $this->mDatePreference;
2600 }
2601
2602 /**
2603 * Get the user preferred stub threshold
2604 *
2605 * @return int
2606 */
2607 public function getStubThreshold() {
2608 global $wgMaxArticleSize; # Maximum article size, in Kb
2609 $threshold = $this->getIntOption( 'stubthreshold' );
2610 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2611 // If they have set an impossible value, disable the preference
2612 // so we can use the parser cache again.
2613 $threshold = 0;
2614 }
2615 return $threshold;
2616 }
2617
2618 /**
2619 * Get the permissions this user has.
2620 * @return Array of String permission names
2621 */
2622 public function getRights() {
2623 if ( is_null( $this->mRights ) ) {
2624 $this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() );
2625 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights ) );
2626 // Force reindexation of rights when a hook has unset one of them
2627 $this->mRights = array_values( array_unique( $this->mRights ) );
2628 }
2629 return $this->mRights;
2630 }
2631
2632 /**
2633 * Get the list of explicit group memberships this user has.
2634 * The implicit * and user groups are not included.
2635 * @return Array of String internal group names
2636 */
2637 public function getGroups() {
2638 $this->load();
2639 $this->loadGroups();
2640 return $this->mGroups;
2641 }
2642
2643 /**
2644 * Get the list of implicit group memberships this user has.
2645 * This includes all explicit groups, plus 'user' if logged in,
2646 * '*' for all accounts, and autopromoted groups
2647 * @param bool $recache Whether to avoid the cache
2648 * @return Array of String internal group names
2649 */
2650 public function getEffectiveGroups( $recache = false ) {
2651 if ( $recache || is_null( $this->mEffectiveGroups ) ) {
2652 wfProfileIn( __METHOD__ );
2653 $this->mEffectiveGroups = array_unique( array_merge(
2654 $this->getGroups(), // explicit groups
2655 $this->getAutomaticGroups( $recache ) // implicit groups
2656 ) );
2657 // Hook for additional groups
2658 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups ) );
2659 // Force reindexation of groups when a hook has unset one of them
2660 $this->mEffectiveGroups = array_values( array_unique( $this->mEffectiveGroups ) );
2661 wfProfileOut( __METHOD__ );
2662 }
2663 return $this->mEffectiveGroups;
2664 }
2665
2666 /**
2667 * Get the list of implicit group memberships this user has.
2668 * This includes 'user' if logged in, '*' for all accounts,
2669 * and autopromoted groups
2670 * @param bool $recache Whether to avoid the cache
2671 * @return Array of String internal group names
2672 */
2673 public function getAutomaticGroups( $recache = false ) {
2674 if ( $recache || is_null( $this->mImplicitGroups ) ) {
2675 wfProfileIn( __METHOD__ );
2676 $this->mImplicitGroups = array( '*' );
2677 if ( $this->getId() ) {
2678 $this->mImplicitGroups[] = 'user';
2679
2680 $this->mImplicitGroups = array_unique( array_merge(
2681 $this->mImplicitGroups,
2682 Autopromote::getAutopromoteGroups( $this )
2683 ) );
2684 }
2685 if ( $recache ) {
2686 // Assure data consistency with rights/groups,
2687 // as getEffectiveGroups() depends on this function
2688 $this->mEffectiveGroups = null;
2689 }
2690 wfProfileOut( __METHOD__ );
2691 }
2692 return $this->mImplicitGroups;
2693 }
2694
2695 /**
2696 * Returns the groups the user has belonged to.
2697 *
2698 * The user may still belong to the returned groups. Compare with getGroups().
2699 *
2700 * The function will not return groups the user had belonged to before MW 1.17
2701 *
2702 * @return array Names of the groups the user has belonged to.
2703 */
2704 public function getFormerGroups() {
2705 if ( is_null( $this->mFormerGroups ) ) {
2706 $dbr = wfGetDB( DB_MASTER );
2707 $res = $dbr->select( 'user_former_groups',
2708 array( 'ufg_group' ),
2709 array( 'ufg_user' => $this->mId ),
2710 __METHOD__ );
2711 $this->mFormerGroups = array();
2712 foreach ( $res as $row ) {
2713 $this->mFormerGroups[] = $row->ufg_group;
2714 }
2715 }
2716 return $this->mFormerGroups;
2717 }
2718
2719 /**
2720 * Get the user's edit count.
2721 * @return int, null for anonymous users
2722 */
2723 public function getEditCount() {
2724 if ( !$this->getId() ) {
2725 return null;
2726 }
2727
2728 if ( !isset( $this->mEditCount ) ) {
2729 /* Populate the count, if it has not been populated yet */
2730 wfProfileIn( __METHOD__ );
2731 $dbr = wfGetDB( DB_SLAVE );
2732 // check if the user_editcount field has been initialized
2733 $count = $dbr->selectField(
2734 'user', 'user_editcount',
2735 array( 'user_id' => $this->mId ),
2736 __METHOD__
2737 );
2738
2739 if ( $count === null ) {
2740 // it has not been initialized. do so.
2741 $count = $this->initEditCount();
2742 }
2743 $this->mEditCount = $count;
2744 wfProfileOut( __METHOD__ );
2745 }
2746 return (int) $this->mEditCount;
2747 }
2748
2749 /**
2750 * Add the user to the given group.
2751 * This takes immediate effect.
2752 * @param string $group Name of the group to add
2753 */
2754 public function addGroup( $group ) {
2755 if ( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2756 $dbw = wfGetDB( DB_MASTER );
2757 if ( $this->getId() ) {
2758 $dbw->insert( 'user_groups',
2759 array(
2760 'ug_user' => $this->getID(),
2761 'ug_group' => $group,
2762 ),
2763 __METHOD__,
2764 array( 'IGNORE' ) );
2765 }
2766 }
2767 $this->loadGroups();
2768 $this->mGroups[] = $group;
2769 // In case loadGroups was not called before, we now have the right twice.
2770 // Get rid of the duplicate.
2771 $this->mGroups = array_unique( $this->mGroups );
2772
2773 // Refresh the groups caches, and clear the rights cache so it will be
2774 // refreshed on the next call to $this->getRights().
2775 $this->getEffectiveGroups( true );
2776 $this->mRights = null;
2777
2778 $this->invalidateCache();
2779 }
2780
2781 /**
2782 * Remove the user from the given group.
2783 * This takes immediate effect.
2784 * @param string $group Name of the group to remove
2785 */
2786 public function removeGroup( $group ) {
2787 $this->load();
2788 if ( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2789 $dbw = wfGetDB( DB_MASTER );
2790 $dbw->delete( 'user_groups',
2791 array(
2792 'ug_user' => $this->getID(),
2793 'ug_group' => $group,
2794 ), __METHOD__ );
2795 // Remember that the user was in this group
2796 $dbw->insert( 'user_former_groups',
2797 array(
2798 'ufg_user' => $this->getID(),
2799 'ufg_group' => $group,
2800 ),
2801 __METHOD__,
2802 array( 'IGNORE' ) );
2803 }
2804 $this->loadGroups();
2805 $this->mGroups = array_diff( $this->mGroups, array( $group ) );
2806
2807 // Refresh the groups caches, and clear the rights cache so it will be
2808 // refreshed on the next call to $this->getRights().
2809 $this->getEffectiveGroups( true );
2810 $this->mRights = null;
2811
2812 $this->invalidateCache();
2813 }
2814
2815 /**
2816 * Get whether the user is logged in
2817 * @return bool
2818 */
2819 public function isLoggedIn() {
2820 return $this->getID() != 0;
2821 }
2822
2823 /**
2824 * Get whether the user is anonymous
2825 * @return bool
2826 */
2827 public function isAnon() {
2828 return !$this->isLoggedIn();
2829 }
2830
2831 /**
2832 * Check if user is allowed to access a feature / make an action
2833 *
2834 * @internal param \String $varargs permissions to test
2835 * @return boolean: True if user is allowed to perform *any* of the given actions
2836 *
2837 * @return bool
2838 */
2839 public function isAllowedAny( /*...*/ ) {
2840 $permissions = func_get_args();
2841 foreach ( $permissions as $permission ) {
2842 if ( $this->isAllowed( $permission ) ) {
2843 return true;
2844 }
2845 }
2846 return false;
2847 }
2848
2849 /**
2850 *
2851 * @internal param $varargs string
2852 * @return bool True if the user is allowed to perform *all* of the given actions
2853 */
2854 public function isAllowedAll( /*...*/ ) {
2855 $permissions = func_get_args();
2856 foreach ( $permissions as $permission ) {
2857 if ( !$this->isAllowed( $permission ) ) {
2858 return false;
2859 }
2860 }
2861 return true;
2862 }
2863
2864 /**
2865 * Internal mechanics of testing a permission
2866 * @param string $action
2867 * @return bool
2868 */
2869 public function isAllowed( $action = '' ) {
2870 if ( $action === '' ) {
2871 return true; // In the spirit of DWIM
2872 }
2873 // Patrolling may not be enabled
2874 if ( $action === 'patrol' || $action === 'autopatrol' ) {
2875 global $wgUseRCPatrol, $wgUseNPPatrol;
2876 if ( !$wgUseRCPatrol && !$wgUseNPPatrol ) {
2877 return false;
2878 }
2879 }
2880 // Use strict parameter to avoid matching numeric 0 accidentally inserted
2881 // by misconfiguration: 0 == 'foo'
2882 return in_array( $action, $this->getRights(), true );
2883 }
2884
2885 /**
2886 * Check whether to enable recent changes patrol features for this user
2887 * @return boolean: True or false
2888 */
2889 public function useRCPatrol() {
2890 global $wgUseRCPatrol;
2891 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2892 }
2893
2894 /**
2895 * Check whether to enable new pages patrol features for this user
2896 * @return bool True or false
2897 */
2898 public function useNPPatrol() {
2899 global $wgUseRCPatrol, $wgUseNPPatrol;
2900 return (
2901 ( $wgUseRCPatrol || $wgUseNPPatrol )
2902 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
2903 );
2904 }
2905
2906 /**
2907 * Get the WebRequest object to use with this object
2908 *
2909 * @return WebRequest
2910 */
2911 public function getRequest() {
2912 if ( $this->mRequest ) {
2913 return $this->mRequest;
2914 } else {
2915 global $wgRequest;
2916 return $wgRequest;
2917 }
2918 }
2919
2920 /**
2921 * Get the current skin, loading it if required
2922 * @return Skin The current skin
2923 * @todo FIXME: Need to check the old failback system [AV]
2924 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2925 */
2926 public function getSkin() {
2927 wfDeprecated( __METHOD__, '1.18' );
2928 return RequestContext::getMain()->getSkin();
2929 }
2930
2931 /**
2932 * Get a WatchedItem for this user and $title.
2933 *
2934 * @since 1.22 $checkRights parameter added
2935 * @param $title Title
2936 * @param $checkRights int Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
2937 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
2938 * @return WatchedItem
2939 */
2940 public function getWatchedItem( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
2941 $key = $checkRights . ':' . $title->getNamespace() . ':' . $title->getDBkey();
2942
2943 if ( isset( $this->mWatchedItems[$key] ) ) {
2944 return $this->mWatchedItems[$key];
2945 }
2946
2947 if ( count( $this->mWatchedItems ) >= self::MAX_WATCHED_ITEMS_CACHE ) {
2948 $this->mWatchedItems = array();
2949 }
2950
2951 $this->mWatchedItems[$key] = WatchedItem::fromUserTitle( $this, $title, $checkRights );
2952 return $this->mWatchedItems[$key];
2953 }
2954
2955 /**
2956 * Check the watched status of an article.
2957 * @since 1.22 $checkRights parameter added
2958 * @param $title Title of the article to look at
2959 * @param $checkRights int Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
2960 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
2961 * @return bool
2962 */
2963 public function isWatched( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
2964 return $this->getWatchedItem( $title, $checkRights )->isWatched();
2965 }
2966
2967 /**
2968 * Watch an article.
2969 * @since 1.22 $checkRights parameter added
2970 * @param $title Title of the article to look at
2971 * @param $checkRights int Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
2972 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
2973 */
2974 public function addWatch( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
2975 $this->getWatchedItem( $title, $checkRights )->addWatch();
2976 $this->invalidateCache();
2977 }
2978
2979 /**
2980 * Stop watching an article.
2981 * @since 1.22 $checkRights parameter added
2982 * @param $title Title of the article to look at
2983 * @param $checkRights int Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
2984 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
2985 */
2986 public function removeWatch( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
2987 $this->getWatchedItem( $title, $checkRights )->removeWatch();
2988 $this->invalidateCache();
2989 }
2990
2991 /**
2992 * Clear the user's notification timestamp for the given title.
2993 * If e-notif e-mails are on, they will receive notification mails on
2994 * the next change of the page if it's watched etc.
2995 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
2996 * @param $title Title of the article to look at
2997 */
2998 public function clearNotification( &$title ) {
2999 global $wgUseEnotif, $wgShowUpdatedMarker;
3000
3001 // Do nothing if the database is locked to writes
3002 if ( wfReadOnly() ) {
3003 return;
3004 }
3005
3006 // Do nothing if not allowed to edit the watchlist
3007 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3008 return;
3009 }
3010
3011 if ( $title->getNamespace() == NS_USER_TALK &&
3012 $title->getText() == $this->getName() ) {
3013 if ( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) ) {
3014 return;
3015 }
3016 $this->setNewtalk( false );
3017 }
3018
3019 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3020 return;
3021 }
3022
3023 if ( $this->isAnon() ) {
3024 // Nothing else to do...
3025 return;
3026 }
3027
3028 // Only update the timestamp if the page is being watched.
3029 // The query to find out if it is watched is cached both in memcached and per-invocation,
3030 // and when it does have to be executed, it can be on a slave
3031 // If this is the user's newtalk page, we always update the timestamp
3032 $force = '';
3033 if ( $title->getNamespace() == NS_USER_TALK &&
3034 $title->getText() == $this->getName() )
3035 {
3036 $force = 'force';
3037 }
3038
3039 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
3040 }
3041
3042 /**
3043 * Resets all of the given user's page-change notification timestamps.
3044 * If e-notif e-mails are on, they will receive notification mails on
3045 * the next change of any watched page.
3046 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3047 */
3048 public function clearAllNotifications() {
3049 if ( wfReadOnly() ) {
3050 return;
3051 }
3052
3053 // Do nothing if not allowed to edit the watchlist
3054 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3055 return;
3056 }
3057
3058 global $wgUseEnotif, $wgShowUpdatedMarker;
3059 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3060 $this->setNewtalk( false );
3061 return;
3062 }
3063 $id = $this->getId();
3064 if ( $id != 0 ) {
3065 $dbw = wfGetDB( DB_MASTER );
3066 $dbw->update( 'watchlist',
3067 array( /* SET */
3068 'wl_notificationtimestamp' => null
3069 ), array( /* WHERE */
3070 'wl_user' => $id
3071 ), __METHOD__
3072 );
3073 # We also need to clear here the "you have new message" notification for the own user_talk page
3074 # This is cleared one page view later in Article::viewUpdates();
3075 }
3076 }
3077
3078 /**
3079 * Set this user's options from an encoded string
3080 * @param string $str Encoded options to import
3081 *
3082 * @deprecated in 1.19 due to removal of user_options from the user table
3083 */
3084 private function decodeOptions( $str ) {
3085 wfDeprecated( __METHOD__, '1.19' );
3086 if ( !$str ) {
3087 return;
3088 }
3089
3090 $this->mOptionsLoaded = true;
3091 $this->mOptionOverrides = array();
3092
3093 // If an option is not set in $str, use the default value
3094 $this->mOptions = self::getDefaultOptions();
3095
3096 $a = explode( "\n", $str );
3097 foreach ( $a as $s ) {
3098 $m = array();
3099 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
3100 $this->mOptions[$m[1]] = $m[2];
3101 $this->mOptionOverrides[$m[1]] = $m[2];
3102 }
3103 }
3104 }
3105
3106 /**
3107 * Set a cookie on the user's client. Wrapper for
3108 * WebResponse::setCookie
3109 * @param string $name Name of the cookie to set
3110 * @param string $value Value to set
3111 * @param int $exp Expiration time, as a UNIX time value;
3112 * if 0 or not specified, use the default $wgCookieExpiration
3113 * @param bool $secure
3114 * true: Force setting the secure attribute when setting the cookie
3115 * false: Force NOT setting the secure attribute when setting the cookie
3116 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3117 */
3118 protected function setCookie( $name, $value, $exp = 0, $secure = null ) {
3119 $this->getRequest()->response()->setcookie( $name, $value, $exp, array(
3120 'secure' => $secure,
3121 ) );
3122 }
3123
3124 /**
3125 * Clear a cookie on the user's client
3126 * @param string $name Name of the cookie to clear
3127 */
3128 protected function clearCookie( $name ) {
3129 $this->setCookie( $name, '', time() - 86400 );
3130 }
3131
3132 /**
3133 * Set the default cookies for this session on the user's client.
3134 *
3135 * @param $request WebRequest object to use; $wgRequest will be used if null
3136 * is passed.
3137 * @param bool $secure Whether to force secure/insecure cookies or use default
3138 */
3139 public function setCookies( $request = null, $secure = null ) {
3140 if ( $request === null ) {
3141 $request = $this->getRequest();
3142 }
3143
3144 $this->load();
3145 if ( 0 == $this->mId ) {
3146 return;
3147 }
3148 if ( !$this->mToken ) {
3149 // When token is empty or NULL generate a new one and then save it to the database
3150 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
3151 // Simply by setting every cell in the user_token column to NULL and letting them be
3152 // regenerated as users log back into the wiki.
3153 $this->setToken();
3154 $this->saveSettings();
3155 }
3156 $session = array(
3157 'wsUserID' => $this->mId,
3158 'wsToken' => $this->mToken,
3159 'wsUserName' => $this->getName()
3160 );
3161 $cookies = array(
3162 'UserID' => $this->mId,
3163 'UserName' => $this->getName(),
3164 );
3165 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
3166 $cookies['Token'] = $this->mToken;
3167 } else {
3168 $cookies['Token'] = false;
3169 }
3170
3171 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
3172
3173 foreach ( $session as $name => $value ) {
3174 $request->setSessionData( $name, $value );
3175 }
3176 foreach ( $cookies as $name => $value ) {
3177 if ( $value === false ) {
3178 $this->clearCookie( $name );
3179 } else {
3180 $this->setCookie( $name, $value, 0, $secure );
3181 }
3182 }
3183
3184 /**
3185 * If wpStickHTTPS was selected, also set an insecure cookie that
3186 * will cause the site to redirect the user to HTTPS, if they access
3187 * it over HTTP. Bug 29898.
3188 */
3189 if ( $request->getCheck( 'wpStickHTTPS' ) ) {
3190 $this->setCookie( 'forceHTTPS', 'true', time() + 2592000, false ); //30 days
3191 }
3192 }
3193
3194 /**
3195 * Log this user out.
3196 */
3197 public function logout() {
3198 if ( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
3199 $this->doLogout();
3200 }
3201 }
3202
3203 /**
3204 * Clear the user's cookies and session, and reset the instance cache.
3205 * @see logout()
3206 */
3207 public function doLogout() {
3208 $this->clearInstanceCache( 'defaults' );
3209
3210 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3211
3212 $this->clearCookie( 'UserID' );
3213 $this->clearCookie( 'Token' );
3214 $this->clearCookie( 'forceHTTPS' );
3215
3216 // Remember when user logged out, to prevent seeing cached pages
3217 $this->setCookie( 'LoggedOut', time(), time() + 86400 );
3218 }
3219
3220 /**
3221 * Save this user's settings into the database.
3222 * @todo Only rarely do all these fields need to be set!
3223 */
3224 public function saveSettings() {
3225 global $wgAuth;
3226
3227 $this->load();
3228 if ( wfReadOnly() ) {
3229 return;
3230 }
3231 if ( 0 == $this->mId ) {
3232 return;
3233 }
3234
3235 $this->mTouched = self::newTouchedTimestamp();
3236 if ( !$wgAuth->allowSetLocalPassword() ) {
3237 $this->mPassword = '';
3238 }
3239
3240 $dbw = wfGetDB( DB_MASTER );
3241 $dbw->update( 'user',
3242 array( /* SET */
3243 'user_name' => $this->mName,
3244 'user_password' => $this->mPassword,
3245 'user_newpassword' => $this->mNewpassword,
3246 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
3247 'user_real_name' => $this->mRealName,
3248 'user_email' => $this->mEmail,
3249 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
3250 'user_touched' => $dbw->timestamp( $this->mTouched ),
3251 'user_token' => strval( $this->mToken ),
3252 'user_email_token' => $this->mEmailToken,
3253 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ),
3254 ), array( /* WHERE */
3255 'user_id' => $this->mId
3256 ), __METHOD__
3257 );
3258
3259 $this->saveOptions();
3260
3261 wfRunHooks( 'UserSaveSettings', array( $this ) );
3262 $this->clearSharedCache();
3263 $this->getUserPage()->invalidateCache();
3264 }
3265
3266 /**
3267 * If only this user's username is known, and it exists, return the user ID.
3268 * @return int
3269 */
3270 public function idForName() {
3271 $s = trim( $this->getName() );
3272 if ( $s === '' ) {
3273 return 0;
3274 }
3275
3276 $dbr = wfGetDB( DB_SLAVE );
3277 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__ );
3278 if ( $id === false ) {
3279 $id = 0;
3280 }
3281 return $id;
3282 }
3283
3284 /**
3285 * Add a user to the database, return the user object
3286 *
3287 * @param string $name Username to add
3288 * @param array $params of Strings Non-default parameters to save to the database as user_* fields:
3289 * - password The user's password hash. Password logins will be disabled if this is omitted.
3290 * - newpassword Hash for a temporary password that has been mailed to the user
3291 * - email The user's email address
3292 * - email_authenticated The email authentication timestamp
3293 * - real_name The user's real name
3294 * - options An associative array of non-default options
3295 * - token Random authentication token. Do not set.
3296 * - registration Registration timestamp. Do not set.
3297 *
3298 * @return User object, or null if the username already exists
3299 */
3300 public static function createNew( $name, $params = array() ) {
3301 $user = new User;
3302 $user->load();
3303 $user->setToken(); // init token
3304 if ( isset( $params['options'] ) ) {
3305 $user->mOptions = $params['options'] + (array)$user->mOptions;
3306 unset( $params['options'] );
3307 }
3308 $dbw = wfGetDB( DB_MASTER );
3309 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3310
3311 $fields = array(
3312 'user_id' => $seqVal,
3313 'user_name' => $name,
3314 'user_password' => $user->mPassword,
3315 'user_newpassword' => $user->mNewpassword,
3316 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime ),
3317 'user_email' => $user->mEmail,
3318 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
3319 'user_real_name' => $user->mRealName,
3320 'user_token' => strval( $user->mToken ),
3321 'user_registration' => $dbw->timestamp( $user->mRegistration ),
3322 'user_editcount' => 0,
3323 'user_touched' => $dbw->timestamp( self::newTouchedTimestamp() ),
3324 );
3325 foreach ( $params as $name => $value ) {
3326 $fields["user_$name"] = $value;
3327 }
3328 $dbw->insert( 'user', $fields, __METHOD__, array( 'IGNORE' ) );
3329 if ( $dbw->affectedRows() ) {
3330 $newUser = User::newFromId( $dbw->insertId() );
3331 } else {
3332 $newUser = null;
3333 }
3334 return $newUser;
3335 }
3336
3337 /**
3338 * Add this existing user object to the database. If the user already
3339 * exists, a fatal status object is returned, and the user object is
3340 * initialised with the data from the database.
3341 *
3342 * Previously, this function generated a DB error due to a key conflict
3343 * if the user already existed. Many extension callers use this function
3344 * in code along the lines of:
3345 *
3346 * $user = User::newFromName( $name );
3347 * if ( !$user->isLoggedIn() ) {
3348 * $user->addToDatabase();
3349 * }
3350 * // do something with $user...
3351 *
3352 * However, this was vulnerable to a race condition (bug 16020). By
3353 * initialising the user object if the user exists, we aim to support this
3354 * calling sequence as far as possible.
3355 *
3356 * Note that if the user exists, this function will acquire a write lock,
3357 * so it is still advisable to make the call conditional on isLoggedIn(),
3358 * and to commit the transaction after calling.
3359 *
3360 * @throws MWException
3361 * @return Status
3362 */
3363 public function addToDatabase() {
3364 $this->load();
3365 if ( !$this->mToken ) {
3366 $this->setToken(); // init token
3367 }
3368
3369 $this->mTouched = self::newTouchedTimestamp();
3370
3371 $dbw = wfGetDB( DB_MASTER );
3372 $inWrite = $dbw->writesOrCallbacksPending();
3373 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3374 $dbw->insert( 'user',
3375 array(
3376 'user_id' => $seqVal,
3377 'user_name' => $this->mName,
3378 'user_password' => $this->mPassword,
3379 'user_newpassword' => $this->mNewpassword,
3380 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
3381 'user_email' => $this->mEmail,
3382 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
3383 'user_real_name' => $this->mRealName,
3384 'user_token' => strval( $this->mToken ),
3385 'user_registration' => $dbw->timestamp( $this->mRegistration ),
3386 'user_editcount' => 0,
3387 'user_touched' => $dbw->timestamp( $this->mTouched ),
3388 ), __METHOD__,
3389 array( 'IGNORE' )
3390 );
3391 if ( !$dbw->affectedRows() ) {
3392 if ( !$inWrite ) {
3393 // XXX: Get out of REPEATABLE-READ so the SELECT below works.
3394 // Often this case happens early in views before any writes.
3395 // This shows up at least with CentralAuth.
3396 $dbw->commit( __METHOD__, 'flush' );
3397 }
3398 $this->mId = $dbw->selectField( 'user', 'user_id',
3399 array( 'user_name' => $this->mName ), __METHOD__ );
3400 $loaded = false;
3401 if ( $this->mId ) {
3402 if ( $this->loadFromDatabase() ) {
3403 $loaded = true;
3404 }
3405 }
3406 if ( !$loaded ) {
3407 throw new MWException( __METHOD__ . ": hit a key conflict attempting " .
3408 "to insert user '{$this->mName}' row, but it was not present in select!" );
3409 }
3410 return Status::newFatal( 'userexists' );
3411 }
3412 $this->mId = $dbw->insertId();
3413
3414 // Clear instance cache other than user table data, which is already accurate
3415 $this->clearInstanceCache();
3416
3417 $this->saveOptions();
3418 return Status::newGood();
3419 }
3420
3421 /**
3422 * If this user is logged-in and blocked,
3423 * block any IP address they've successfully logged in from.
3424 * @return bool A block was spread
3425 */
3426 public function spreadAnyEditBlock() {
3427 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3428 return $this->spreadBlock();
3429 }
3430 return false;
3431 }
3432
3433 /**
3434 * If this (non-anonymous) user is blocked,
3435 * block the IP address they've successfully logged in from.
3436 * @return bool A block was spread
3437 */
3438 protected function spreadBlock() {
3439 wfDebug( __METHOD__ . "()\n" );
3440 $this->load();
3441 if ( $this->mId == 0 ) {
3442 return false;
3443 }
3444
3445 $userblock = Block::newFromTarget( $this->getName() );
3446 if ( !$userblock ) {
3447 return false;
3448 }
3449
3450 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3451 }
3452
3453 /**
3454 * Generate a string which will be different for any combination of
3455 * user options which would produce different parser output.
3456 * This will be used as part of the hash key for the parser cache,
3457 * so users with the same options can share the same cached data
3458 * safely.
3459 *
3460 * Extensions which require it should install 'PageRenderingHash' hook,
3461 * which will give them a chance to modify this key based on their own
3462 * settings.
3463 *
3464 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3465 * @return string Page rendering hash
3466 */
3467 public function getPageRenderingHash() {
3468 wfDeprecated( __METHOD__, '1.17' );
3469
3470 global $wgRenderHashAppend, $wgLang, $wgContLang;
3471 if ( $this->mHash ) {
3472 return $this->mHash;
3473 }
3474
3475 // stubthreshold is only included below for completeness,
3476 // since it disables the parser cache, its value will always
3477 // be 0 when this function is called by parsercache.
3478
3479 $confstr = $this->getOption( 'math' );
3480 $confstr .= '!' . $this->getStubThreshold();
3481 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ? '1' : '' );
3482 $confstr .= '!' . $wgLang->getCode();
3483 $confstr .= '!' . $this->getOption( 'thumbsize' );
3484 // add in language specific options, if any
3485 $extra = $wgContLang->getExtraHashOptions();
3486 $confstr .= $extra;
3487
3488 // Since the skin could be overloading link(), it should be
3489 // included here but in practice, none of our skins do that.
3490
3491 $confstr .= $wgRenderHashAppend;
3492
3493 // Give a chance for extensions to modify the hash, if they have
3494 // extra options or other effects on the parser cache.
3495 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3496
3497 // Make it a valid memcached key fragment
3498 $confstr = str_replace( ' ', '_', $confstr );
3499 $this->mHash = $confstr;
3500 return $confstr;
3501 }
3502
3503 /**
3504 * Get whether the user is explicitly blocked from account creation.
3505 * @return bool|Block
3506 */
3507 public function isBlockedFromCreateAccount() {
3508 $this->getBlockedStatus();
3509 if ( $this->mBlock && $this->mBlock->prevents( 'createaccount' ) ) {
3510 return $this->mBlock;
3511 }
3512
3513 # bug 13611: if the IP address the user is trying to create an account from is
3514 # blocked with createaccount disabled, prevent new account creation there even
3515 # when the user is logged in
3516 if ( $this->mBlockedFromCreateAccount === false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3517 $this->mBlockedFromCreateAccount = Block::newFromTarget( null, $this->getRequest()->getIP() );
3518 }
3519 return $this->mBlockedFromCreateAccount instanceof Block && $this->mBlockedFromCreateAccount->prevents( 'createaccount' )
3520 ? $this->mBlockedFromCreateAccount
3521 : false;
3522 }
3523
3524 /**
3525 * Get whether the user is blocked from using Special:Emailuser.
3526 * @return bool
3527 */
3528 public function isBlockedFromEmailuser() {
3529 $this->getBlockedStatus();
3530 return $this->mBlock && $this->mBlock->prevents( 'sendemail' );
3531 }
3532
3533 /**
3534 * Get whether the user is allowed to create an account.
3535 * @return bool
3536 */
3537 function isAllowedToCreateAccount() {
3538 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3539 }
3540
3541 /**
3542 * Get this user's personal page title.
3543 *
3544 * @return Title: User's personal page title
3545 */
3546 public function getUserPage() {
3547 return Title::makeTitle( NS_USER, $this->getName() );
3548 }
3549
3550 /**
3551 * Get this user's talk page title.
3552 *
3553 * @return Title: User's talk page title
3554 */
3555 public function getTalkPage() {
3556 $title = $this->getUserPage();
3557 return $title->getTalkPage();
3558 }
3559
3560 /**
3561 * Determine whether the user is a newbie. Newbies are either
3562 * anonymous IPs, or the most recently created accounts.
3563 * @return bool
3564 */
3565 public function isNewbie() {
3566 return !$this->isAllowed( 'autoconfirmed' );
3567 }
3568
3569 /**
3570 * Check to see if the given clear-text password is one of the accepted passwords
3571 * @param string $password user password.
3572 * @return boolean: True if the given password is correct, otherwise False.
3573 */
3574 public function checkPassword( $password ) {
3575 global $wgAuth, $wgLegacyEncoding;
3576 $this->load();
3577
3578 // Even though we stop people from creating passwords that
3579 // are shorter than this, doesn't mean people wont be able
3580 // to. Certain authentication plugins do NOT want to save
3581 // domain passwords in a mysql database, so we should
3582 // check this (in case $wgAuth->strict() is false).
3583 if ( !$this->isValidPassword( $password ) ) {
3584 return false;
3585 }
3586
3587 if ( $wgAuth->authenticate( $this->getName(), $password ) ) {
3588 return true;
3589 } elseif ( $wgAuth->strict() ) {
3590 // Auth plugin doesn't allow local authentication
3591 return false;
3592 } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) {
3593 // Auth plugin doesn't allow local authentication for this user name
3594 return false;
3595 }
3596 if ( self::comparePasswords( $this->mPassword, $password, $this->mId ) ) {
3597 return true;
3598 } elseif ( $wgLegacyEncoding ) {
3599 // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3600 // Check for this with iconv
3601 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3602 if ( $cp1252Password != $password &&
3603 self::comparePasswords( $this->mPassword, $cp1252Password, $this->mId ) )
3604 {
3605 return true;
3606 }
3607 }
3608 return false;
3609 }
3610
3611 /**
3612 * Check if the given clear-text password matches the temporary password
3613 * sent by e-mail for password reset operations.
3614 *
3615 * @param $plaintext string
3616 *
3617 * @return boolean: True if matches, false otherwise
3618 */
3619 public function checkTemporaryPassword( $plaintext ) {
3620 global $wgNewPasswordExpiry;
3621
3622 $this->load();
3623 if ( self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() ) ) {
3624 if ( is_null( $this->mNewpassTime ) ) {
3625 return true;
3626 }
3627 $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgNewPasswordExpiry;
3628 return ( time() < $expiry );
3629 } else {
3630 return false;
3631 }
3632 }
3633
3634 /**
3635 * Alias for getEditToken.
3636 * @deprecated since 1.19, use getEditToken instead.
3637 *
3638 * @param string|array $salt of Strings Optional function-specific data for hashing
3639 * @param $request WebRequest object to use or null to use $wgRequest
3640 * @return string The new edit token
3641 */
3642 public function editToken( $salt = '', $request = null ) {
3643 wfDeprecated( __METHOD__, '1.19' );
3644 return $this->getEditToken( $salt, $request );
3645 }
3646
3647 /**
3648 * Initialize (if necessary) and return a session token value
3649 * which can be used in edit forms to show that the user's
3650 * login credentials aren't being hijacked with a foreign form
3651 * submission.
3652 *
3653 * @since 1.19
3654 *
3655 * @param string|array $salt of Strings Optional function-specific data for hashing
3656 * @param $request WebRequest object to use or null to use $wgRequest
3657 * @return string The new edit token
3658 */
3659 public function getEditToken( $salt = '', $request = null ) {
3660 if ( $request == null ) {
3661 $request = $this->getRequest();
3662 }
3663
3664 if ( $this->isAnon() ) {
3665 return EDIT_TOKEN_SUFFIX;
3666 } else {
3667 $token = $request->getSessionData( 'wsEditToken' );
3668 if ( $token === null ) {
3669 $token = MWCryptRand::generateHex( 32 );
3670 $request->setSessionData( 'wsEditToken', $token );
3671 }
3672 if ( is_array( $salt ) ) {
3673 $salt = implode( '|', $salt );
3674 }
3675 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX;
3676 }
3677 }
3678
3679 /**
3680 * Generate a looking random token for various uses.
3681 *
3682 * @return string The new random token
3683 * @deprecated since 1.20: Use MWCryptRand for secure purposes or wfRandomString for pseudo-randomness
3684 */
3685 public static function generateToken() {
3686 return MWCryptRand::generateHex( 32 );
3687 }
3688
3689 /**
3690 * Check given value against the token value stored in the session.
3691 * A match should confirm that the form was submitted from the
3692 * user's own login session, not a form submission from a third-party
3693 * site.
3694 *
3695 * @param string $val Input value to compare
3696 * @param string $salt Optional function-specific data for hashing
3697 * @param WebRequest $request Object to use or null to use $wgRequest
3698 * @return boolean: Whether the token matches
3699 */
3700 public function matchEditToken( $val, $salt = '', $request = null ) {
3701 $sessionToken = $this->getEditToken( $salt, $request );
3702 if ( $val != $sessionToken ) {
3703 wfDebug( "User::matchEditToken: broken session data\n" );
3704 }
3705 return $val == $sessionToken;
3706 }
3707
3708 /**
3709 * Check given value against the token value stored in the session,
3710 * ignoring the suffix.
3711 *
3712 * @param string $val Input value to compare
3713 * @param string $salt Optional function-specific data for hashing
3714 * @param WebRequest $request object to use or null to use $wgRequest
3715 * @return boolean: Whether the token matches
3716 */
3717 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3718 $sessionToken = $this->getEditToken( $salt, $request );
3719 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3720 }
3721
3722 /**
3723 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3724 * mail to the user's given address.
3725 *
3726 * @param string $type message to send, either "created", "changed" or "set"
3727 * @return Status object
3728 */
3729 public function sendConfirmationMail( $type = 'created' ) {
3730 global $wgLang;
3731 $expiration = null; // gets passed-by-ref and defined in next line.
3732 $token = $this->confirmationToken( $expiration );
3733 $url = $this->confirmationTokenUrl( $token );
3734 $invalidateURL = $this->invalidationTokenUrl( $token );
3735 $this->saveSettings();
3736
3737 if ( $type == 'created' || $type === false ) {
3738 $message = 'confirmemail_body';
3739 } elseif ( $type === true ) {
3740 $message = 'confirmemail_body_changed';
3741 } else {
3742 // Give grep a chance to find the usages:
3743 // confirmemail_body_changed, confirmemail_body_set
3744 $message = 'confirmemail_body_' . $type;
3745 }
3746
3747 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3748 wfMessage( $message,
3749 $this->getRequest()->getIP(),
3750 $this->getName(),
3751 $url,
3752 $wgLang->timeanddate( $expiration, false ),
3753 $invalidateURL,
3754 $wgLang->date( $expiration, false ),
3755 $wgLang->time( $expiration, false ) )->text() );
3756 }
3757
3758 /**
3759 * Send an e-mail to this user's account. Does not check for
3760 * confirmed status or validity.
3761 *
3762 * @param string $subject Message subject
3763 * @param string $body Message body
3764 * @param string $from Optional From address; if unspecified, default $wgPasswordSender will be used
3765 * @param string $replyto Reply-To address
3766 * @return Status
3767 */
3768 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3769 if ( is_null( $from ) ) {
3770 global $wgPasswordSender, $wgPasswordSenderName;
3771 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3772 } else {
3773 $sender = new MailAddress( $from );
3774 }
3775
3776 $to = new MailAddress( $this );
3777 return UserMailer::send( $to, $sender, $subject, $body, $replyto );
3778 }
3779
3780 /**
3781 * Generate, store, and return a new e-mail confirmation code.
3782 * A hash (unsalted, since it's used as a key) is stored.
3783 *
3784 * @note Call saveSettings() after calling this function to commit
3785 * this change to the database.
3786 *
3787 * @param &$expiration \mixed Accepts the expiration time
3788 * @return string New token
3789 */
3790 protected function confirmationToken( &$expiration ) {
3791 global $wgUserEmailConfirmationTokenExpiry;
3792 $now = time();
3793 $expires = $now + $wgUserEmailConfirmationTokenExpiry;
3794 $expiration = wfTimestamp( TS_MW, $expires );
3795 $this->load();
3796 $token = MWCryptRand::generateHex( 32 );
3797 $hash = md5( $token );
3798 $this->mEmailToken = $hash;
3799 $this->mEmailTokenExpires = $expiration;
3800 return $token;
3801 }
3802
3803 /**
3804 * Return a URL the user can use to confirm their email address.
3805 * @param string $token Accepts the email confirmation token
3806 * @return string New token URL
3807 */
3808 protected function confirmationTokenUrl( $token ) {
3809 return $this->getTokenUrl( 'ConfirmEmail', $token );
3810 }
3811
3812 /**
3813 * Return a URL the user can use to invalidate their email address.
3814 * @param string $token Accepts the email confirmation token
3815 * @return string New token URL
3816 */
3817 protected function invalidationTokenUrl( $token ) {
3818 return $this->getTokenUrl( 'InvalidateEmail', $token );
3819 }
3820
3821 /**
3822 * Internal function to format the e-mail validation/invalidation URLs.
3823 * This uses a quickie hack to use the
3824 * hardcoded English names of the Special: pages, for ASCII safety.
3825 *
3826 * @note Since these URLs get dropped directly into emails, using the
3827 * short English names avoids insanely long URL-encoded links, which
3828 * also sometimes can get corrupted in some browsers/mailers
3829 * (bug 6957 with Gmail and Internet Explorer).
3830 *
3831 * @param string $page Special page
3832 * @param string $token Token
3833 * @return string Formatted URL
3834 */
3835 protected function getTokenUrl( $page, $token ) {
3836 // Hack to bypass localization of 'Special:'
3837 $title = Title::makeTitle( NS_MAIN, "Special:$page/$token" );
3838 return $title->getCanonicalURL();
3839 }
3840
3841 /**
3842 * Mark the e-mail address confirmed.
3843 *
3844 * @note Call saveSettings() after calling this function to commit the change.
3845 *
3846 * @return bool
3847 */
3848 public function confirmEmail() {
3849 // Check if it's already confirmed, so we don't touch the database
3850 // and fire the ConfirmEmailComplete hook on redundant confirmations.
3851 if ( !$this->isEmailConfirmed() ) {
3852 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3853 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3854 }
3855 return true;
3856 }
3857
3858 /**
3859 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3860 * address if it was already confirmed.
3861 *
3862 * @note Call saveSettings() after calling this function to commit the change.
3863 * @return bool Returns true
3864 */
3865 function invalidateEmail() {
3866 $this->load();
3867 $this->mEmailToken = null;
3868 $this->mEmailTokenExpires = null;
3869 $this->setEmailAuthenticationTimestamp( null );
3870 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3871 return true;
3872 }
3873
3874 /**
3875 * Set the e-mail authentication timestamp.
3876 * @param string $timestamp TS_MW timestamp
3877 */
3878 function setEmailAuthenticationTimestamp( $timestamp ) {
3879 $this->load();
3880 $this->mEmailAuthenticated = $timestamp;
3881 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
3882 }
3883
3884 /**
3885 * Is this user allowed to send e-mails within limits of current
3886 * site configuration?
3887 * @return bool
3888 */
3889 public function canSendEmail() {
3890 global $wgEnableEmail, $wgEnableUserEmail;
3891 if ( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
3892 return false;
3893 }
3894 $canSend = $this->isEmailConfirmed();
3895 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3896 return $canSend;
3897 }
3898
3899 /**
3900 * Is this user allowed to receive e-mails within limits of current
3901 * site configuration?
3902 * @return bool
3903 */
3904 public function canReceiveEmail() {
3905 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3906 }
3907
3908 /**
3909 * Is this user's e-mail address valid-looking and confirmed within
3910 * limits of the current site configuration?
3911 *
3912 * @note If $wgEmailAuthentication is on, this may require the user to have
3913 * confirmed their address by returning a code or using a password
3914 * sent to the address from the wiki.
3915 *
3916 * @return bool
3917 */
3918 public function isEmailConfirmed() {
3919 global $wgEmailAuthentication;
3920 $this->load();
3921 $confirmed = true;
3922 if ( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3923 if ( $this->isAnon() ) {
3924 return false;
3925 }
3926 if ( !Sanitizer::validateEmail( $this->mEmail ) ) {
3927 return false;
3928 }
3929 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3930 return false;
3931 }
3932 return true;
3933 } else {
3934 return $confirmed;
3935 }
3936 }
3937
3938 /**
3939 * Check whether there is an outstanding request for e-mail confirmation.
3940 * @return bool
3941 */
3942 public function isEmailConfirmationPending() {
3943 global $wgEmailAuthentication;
3944 return $wgEmailAuthentication &&
3945 !$this->isEmailConfirmed() &&
3946 $this->mEmailToken &&
3947 $this->mEmailTokenExpires > wfTimestamp();
3948 }
3949
3950 /**
3951 * Get the timestamp of account creation.
3952 *
3953 * @return string|bool|null Timestamp of account creation, false for
3954 * non-existent/anonymous user accounts, or null if existing account
3955 * but information is not in database.
3956 */
3957 public function getRegistration() {
3958 if ( $this->isAnon() ) {
3959 return false;
3960 }
3961 $this->load();
3962 return $this->mRegistration;
3963 }
3964
3965 /**
3966 * Get the timestamp of the first edit
3967 *
3968 * @return string|bool Timestamp of first edit, or false for
3969 * non-existent/anonymous user accounts.
3970 */
3971 public function getFirstEditTimestamp() {
3972 if ( $this->getId() == 0 ) {
3973 return false; // anons
3974 }
3975 $dbr = wfGetDB( DB_SLAVE );
3976 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3977 array( 'rev_user' => $this->getId() ),
3978 __METHOD__,
3979 array( 'ORDER BY' => 'rev_timestamp ASC' )
3980 );
3981 if ( !$time ) {
3982 return false; // no edits
3983 }
3984 return wfTimestamp( TS_MW, $time );
3985 }
3986
3987 /**
3988 * Get the permissions associated with a given list of groups
3989 *
3990 * @param array $groups of Strings List of internal group names
3991 * @return Array of Strings List of permission key names for given groups combined
3992 */
3993 public static function getGroupPermissions( $groups ) {
3994 global $wgGroupPermissions, $wgRevokePermissions;
3995 $rights = array();
3996 // grant every granted permission first
3997 foreach ( $groups as $group ) {
3998 if ( isset( $wgGroupPermissions[$group] ) ) {
3999 $rights = array_merge( $rights,
4000 // array_filter removes empty items
4001 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4002 }
4003 }
4004 // now revoke the revoked permissions
4005 foreach ( $groups as $group ) {
4006 if ( isset( $wgRevokePermissions[$group] ) ) {
4007 $rights = array_diff( $rights,
4008 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4009 }
4010 }
4011 return array_unique( $rights );
4012 }
4013
4014 /**
4015 * Get all the groups who have a given permission
4016 *
4017 * @param string $role Role to check
4018 * @return Array of Strings List of internal group names with the given permission
4019 */
4020 public static function getGroupsWithPermission( $role ) {
4021 global $wgGroupPermissions;
4022 $allowedGroups = array();
4023 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4024 if ( self::groupHasPermission( $group, $role ) ) {
4025 $allowedGroups[] = $group;
4026 }
4027 }
4028 return $allowedGroups;
4029 }
4030
4031 /**
4032 * Check, if the given group has the given permission
4033 *
4034 * If you're wanting to check whether all users have a permission, use
4035 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4036 * from anyone.
4037 *
4038 * @since 1.21
4039 * @param string $group Group to check
4040 * @param string $role Role to check
4041 * @return bool
4042 */
4043 public static function groupHasPermission( $group, $role ) {
4044 global $wgGroupPermissions, $wgRevokePermissions;
4045 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4046 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4047 }
4048
4049 /**
4050 * Check if all users have the given permission
4051 *
4052 * @since 1.22
4053 * @param string $right Right to check
4054 * @return bool
4055 */
4056 public static function isEveryoneAllowed( $right ) {
4057 global $wgGroupPermissions, $wgRevokePermissions;
4058 static $cache = array();
4059
4060 // Use the cached results, except in unit tests which rely on
4061 // being able change the permission mid-request
4062 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4063 return $cache[$right];
4064 }
4065
4066 if ( !isset( $wgGroupPermissions['*'][$right] ) || !$wgGroupPermissions['*'][$right] ) {
4067 $cache[$right] = false;
4068 return false;
4069 }
4070
4071 // If it's revoked anywhere, then everyone doesn't have it
4072 foreach ( $wgRevokePermissions as $rights ) {
4073 if ( isset( $rights[$right] ) && $rights[$right] ) {
4074 $cache[$right] = false;
4075 return false;
4076 }
4077 }
4078
4079 // Allow extensions (e.g. OAuth) to say false
4080 if ( !wfRunHooks( 'UserIsEveryoneAllowed', array( $right ) ) ) {
4081 $cache[$right] = false;
4082 return false;
4083 }
4084
4085 $cache[$right] = true;
4086 return true;
4087 }
4088
4089 /**
4090 * Get the localized descriptive name for a group, if it exists
4091 *
4092 * @param string $group Internal group name
4093 * @return string Localized descriptive group name
4094 */
4095 public static function getGroupName( $group ) {
4096 $msg = wfMessage( "group-$group" );
4097 return $msg->isBlank() ? $group : $msg->text();
4098 }
4099
4100 /**
4101 * Get the localized descriptive name for a member of a group, if it exists
4102 *
4103 * @param string $group Internal group name
4104 * @param string $username Username for gender (since 1.19)
4105 * @return string Localized name for group member
4106 */
4107 public static function getGroupMember( $group, $username = '#' ) {
4108 $msg = wfMessage( "group-$group-member", $username );
4109 return $msg->isBlank() ? $group : $msg->text();
4110 }
4111
4112 /**
4113 * Return the set of defined explicit groups.
4114 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4115 * are not included, as they are defined automatically, not in the database.
4116 * @return Array of internal group names
4117 */
4118 public static function getAllGroups() {
4119 global $wgGroupPermissions, $wgRevokePermissions;
4120 return array_diff(
4121 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4122 self::getImplicitGroups()
4123 );
4124 }
4125
4126 /**
4127 * Get a list of all available permissions.
4128 * @return Array of permission names
4129 */
4130 public static function getAllRights() {
4131 if ( self::$mAllRights === false ) {
4132 global $wgAvailableRights;
4133 if ( count( $wgAvailableRights ) ) {
4134 self::$mAllRights = array_unique( array_merge( self::$mCoreRights, $wgAvailableRights ) );
4135 } else {
4136 self::$mAllRights = self::$mCoreRights;
4137 }
4138 wfRunHooks( 'UserGetAllRights', array( &self::$mAllRights ) );
4139 }
4140 return self::$mAllRights;
4141 }
4142
4143 /**
4144 * Get a list of implicit groups
4145 * @return Array of Strings Array of internal group names
4146 */
4147 public static function getImplicitGroups() {
4148 global $wgImplicitGroups;
4149 $groups = $wgImplicitGroups;
4150 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
4151 return $groups;
4152 }
4153
4154 /**
4155 * Get the title of a page describing a particular group
4156 *
4157 * @param string $group Internal group name
4158 * @return Title|bool Title of the page if it exists, false otherwise
4159 */
4160 public static function getGroupPage( $group ) {
4161 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4162 if ( $msg->exists() ) {
4163 $title = Title::newFromText( $msg->text() );
4164 if ( is_object( $title ) ) {
4165 return $title;
4166 }
4167 }
4168 return false;
4169 }
4170
4171 /**
4172 * Create a link to the group in HTML, if available;
4173 * else return the group name.
4174 *
4175 * @param string $group Internal name of the group
4176 * @param string $text The text of the link
4177 * @return string HTML link to the group
4178 */
4179 public static function makeGroupLinkHTML( $group, $text = '' ) {
4180 if ( $text == '' ) {
4181 $text = self::getGroupName( $group );
4182 }
4183 $title = self::getGroupPage( $group );
4184 if ( $title ) {
4185 return Linker::link( $title, htmlspecialchars( $text ) );
4186 } else {
4187 return $text;
4188 }
4189 }
4190
4191 /**
4192 * Create a link to the group in Wikitext, if available;
4193 * else return the group name.
4194 *
4195 * @param string $group Internal name of the group
4196 * @param string $text The text of the link
4197 * @return string Wikilink to the group
4198 */
4199 public static function makeGroupLinkWiki( $group, $text = '' ) {
4200 if ( $text == '' ) {
4201 $text = self::getGroupName( $group );
4202 }
4203 $title = self::getGroupPage( $group );
4204 if ( $title ) {
4205 $page = $title->getPrefixedText();
4206 return "[[$page|$text]]";
4207 } else {
4208 return $text;
4209 }
4210 }
4211
4212 /**
4213 * Returns an array of the groups that a particular group can add/remove.
4214 *
4215 * @param string $group the group to check for whether it can add/remove
4216 * @return Array array( 'add' => array( addablegroups ),
4217 * 'remove' => array( removablegroups ),
4218 * 'add-self' => array( addablegroups to self),
4219 * 'remove-self' => array( removable groups from self) )
4220 */
4221 public static function changeableByGroup( $group ) {
4222 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4223
4224 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
4225 if ( empty( $wgAddGroups[$group] ) ) {
4226 // Don't add anything to $groups
4227 } elseif ( $wgAddGroups[$group] === true ) {
4228 // You get everything
4229 $groups['add'] = self::getAllGroups();
4230 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4231 $groups['add'] = $wgAddGroups[$group];
4232 }
4233
4234 // Same thing for remove
4235 if ( empty( $wgRemoveGroups[$group] ) ) {
4236 } elseif ( $wgRemoveGroups[$group] === true ) {
4237 $groups['remove'] = self::getAllGroups();
4238 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4239 $groups['remove'] = $wgRemoveGroups[$group];
4240 }
4241
4242 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4243 if ( empty( $wgGroupsAddToSelf['user'] ) || $wgGroupsAddToSelf['user'] !== true ) {
4244 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4245 if ( is_int( $key ) ) {
4246 $wgGroupsAddToSelf['user'][] = $value;
4247 }
4248 }
4249 }
4250
4251 if ( empty( $wgGroupsRemoveFromSelf['user'] ) || $wgGroupsRemoveFromSelf['user'] !== true ) {
4252 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4253 if ( is_int( $key ) ) {
4254 $wgGroupsRemoveFromSelf['user'][] = $value;
4255 }
4256 }
4257 }
4258
4259 // Now figure out what groups the user can add to him/herself
4260 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4261 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4262 // No idea WHY this would be used, but it's there
4263 $groups['add-self'] = User::getAllGroups();
4264 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4265 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4266 }
4267
4268 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4269 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4270 $groups['remove-self'] = User::getAllGroups();
4271 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4272 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4273 }
4274
4275 return $groups;
4276 }
4277
4278 /**
4279 * Returns an array of groups that this user can add and remove
4280 * @return Array array( 'add' => array( addablegroups ),
4281 * 'remove' => array( removablegroups ),
4282 * 'add-self' => array( addablegroups to self),
4283 * 'remove-self' => array( removable groups from self) )
4284 */
4285 public function changeableGroups() {
4286 if ( $this->isAllowed( 'userrights' ) ) {
4287 // This group gives the right to modify everything (reverse-
4288 // compatibility with old "userrights lets you change
4289 // everything")
4290 // Using array_merge to make the groups reindexed
4291 $all = array_merge( User::getAllGroups() );
4292 return array(
4293 'add' => $all,
4294 'remove' => $all,
4295 'add-self' => array(),
4296 'remove-self' => array()
4297 );
4298 }
4299
4300 // Okay, it's not so simple, we will have to go through the arrays
4301 $groups = array(
4302 'add' => array(),
4303 'remove' => array(),
4304 'add-self' => array(),
4305 'remove-self' => array()
4306 );
4307 $addergroups = $this->getEffectiveGroups();
4308
4309 foreach ( $addergroups as $addergroup ) {
4310 $groups = array_merge_recursive(
4311 $groups, $this->changeableByGroup( $addergroup )
4312 );
4313 $groups['add'] = array_unique( $groups['add'] );
4314 $groups['remove'] = array_unique( $groups['remove'] );
4315 $groups['add-self'] = array_unique( $groups['add-self'] );
4316 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4317 }
4318 return $groups;
4319 }
4320
4321 /**
4322 * Increment the user's edit-count field.
4323 * Will have no effect for anonymous users.
4324 */
4325 public function incEditCount() {
4326 if ( !$this->isAnon() ) {
4327 $dbw = wfGetDB( DB_MASTER );
4328 $dbw->update(
4329 'user',
4330 array( 'user_editcount=user_editcount+1' ),
4331 array( 'user_id' => $this->getId() ),
4332 __METHOD__
4333 );
4334
4335 // Lazy initialization check...
4336 if ( $dbw->affectedRows() == 0 ) {
4337 // Now here's a goddamn hack...
4338 $dbr = wfGetDB( DB_SLAVE );
4339 if ( $dbr !== $dbw ) {
4340 // If we actually have a slave server, the count is
4341 // at least one behind because the current transaction
4342 // has not been committed and replicated.
4343 $this->initEditCount( 1 );
4344 } else {
4345 // But if DB_SLAVE is selecting the master, then the
4346 // count we just read includes the revision that was
4347 // just added in the working transaction.
4348 $this->initEditCount();
4349 }
4350 }
4351 }
4352 // edit count in user cache too
4353 $this->invalidateCache();
4354 }
4355
4356 /**
4357 * Initialize user_editcount from data out of the revision table
4358 *
4359 * @param $add Integer Edits to add to the count from the revision table
4360 * @return integer Number of edits
4361 */
4362 protected function initEditCount( $add = 0 ) {
4363 // Pull from a slave to be less cruel to servers
4364 // Accuracy isn't the point anyway here
4365 $dbr = wfGetDB( DB_SLAVE );
4366 $count = (int) $dbr->selectField(
4367 'revision',
4368 'COUNT(rev_user)',
4369 array( 'rev_user' => $this->getId() ),
4370 __METHOD__
4371 );
4372 $count = $count + $add;
4373
4374 $dbw = wfGetDB( DB_MASTER );
4375 $dbw->update(
4376 'user',
4377 array( 'user_editcount' => $count ),
4378 array( 'user_id' => $this->getId() ),
4379 __METHOD__
4380 );
4381
4382 return $count;
4383 }
4384
4385 /**
4386 * Get the description of a given right
4387 *
4388 * @param string $right Right to query
4389 * @return string Localized description of the right
4390 */
4391 public static function getRightDescription( $right ) {
4392 $key = "right-$right";
4393 $msg = wfMessage( $key );
4394 return $msg->isBlank() ? $right : $msg->text();
4395 }
4396
4397 /**
4398 * Make an old-style password hash
4399 *
4400 * @param string $password Plain-text password
4401 * @param string $userId User ID
4402 * @return string Password hash
4403 */
4404 public static function oldCrypt( $password, $userId ) {
4405 global $wgPasswordSalt;
4406 if ( $wgPasswordSalt ) {
4407 return md5( $userId . '-' . md5( $password ) );
4408 } else {
4409 return md5( $password );
4410 }
4411 }
4412
4413 /**
4414 * Make a new-style password hash
4415 *
4416 * @param string $password Plain-text password
4417 * @param bool|string $salt Optional salt, may be random or the user ID.
4418 * If unspecified or false, will generate one automatically
4419 * @return string Password hash
4420 */
4421 public static function crypt( $password, $salt = false ) {
4422 global $wgPasswordSalt;
4423
4424 $hash = '';
4425 if ( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
4426 return $hash;
4427 }
4428
4429 if ( $wgPasswordSalt ) {
4430 if ( $salt === false ) {
4431 $salt = MWCryptRand::generateHex( 8 );
4432 }
4433 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
4434 } else {
4435 return ':A:' . md5( $password );
4436 }
4437 }
4438
4439 /**
4440 * Compare a password hash with a plain-text password. Requires the user
4441 * ID if there's a chance that the hash is an old-style hash.
4442 *
4443 * @param string $hash Password hash
4444 * @param string $password Plain-text password to compare
4445 * @param string|bool $userId User ID for old-style password salt
4446 *
4447 * @return boolean
4448 */
4449 public static function comparePasswords( $hash, $password, $userId = false ) {
4450 $type = substr( $hash, 0, 3 );
4451
4452 $result = false;
4453 if ( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
4454 return $result;
4455 }
4456
4457 if ( $type == ':A:' ) {
4458 // Unsalted
4459 return md5( $password ) === substr( $hash, 3 );
4460 } elseif ( $type == ':B:' ) {
4461 // Salted
4462 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
4463 return md5( $salt . '-' . md5( $password ) ) === $realHash;
4464 } else {
4465 // Old-style
4466 return self::oldCrypt( $password, $userId ) === $hash;
4467 }
4468 }
4469
4470 /**
4471 * Add a newuser log entry for this user.
4472 * Before 1.19 the return value was always true.
4473 *
4474 * @param string|bool $action account creation type.
4475 * - String, one of the following values:
4476 * - 'create' for an anonymous user creating an account for himself.
4477 * This will force the action's performer to be the created user itself,
4478 * no matter the value of $wgUser
4479 * - 'create2' for a logged in user creating an account for someone else
4480 * - 'byemail' when the created user will receive its password by e-mail
4481 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
4482 * - Boolean means whether the account was created by e-mail (deprecated):
4483 * - true will be converted to 'byemail'
4484 * - false will be converted to 'create' if this object is the same as
4485 * $wgUser and to 'create2' otherwise
4486 *
4487 * @param string $reason user supplied reason
4488 *
4489 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4490 */
4491 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4492 global $wgUser, $wgNewUserLog;
4493 if ( empty( $wgNewUserLog ) ) {
4494 return true; // disabled
4495 }
4496
4497 if ( $action === true ) {
4498 $action = 'byemail';
4499 } elseif ( $action === false ) {
4500 if ( $this->getName() == $wgUser->getName() ) {
4501 $action = 'create';
4502 } else {
4503 $action = 'create2';
4504 }
4505 }
4506
4507 if ( $action === 'create' || $action === 'autocreate' ) {
4508 $performer = $this;
4509 } else {
4510 $performer = $wgUser;
4511 }
4512
4513 $logEntry = new ManualLogEntry( 'newusers', $action );
4514 $logEntry->setPerformer( $performer );
4515 $logEntry->setTarget( $this->getUserPage() );
4516 $logEntry->setComment( $reason );
4517 $logEntry->setParameters( array(
4518 '4::userid' => $this->getId(),
4519 ) );
4520 $logid = $logEntry->insert();
4521
4522 if ( $action !== 'autocreate' ) {
4523 $logEntry->publish( $logid );
4524 }
4525
4526 return (int)$logid;
4527 }
4528
4529 /**
4530 * Add an autocreate newuser log entry for this user
4531 * Used by things like CentralAuth and perhaps other authplugins.
4532 * Consider calling addNewUserLogEntry() directly instead.
4533 *
4534 * @return bool
4535 */
4536 public function addNewUserLogEntryAutoCreate() {
4537 $this->addNewUserLogEntry( 'autocreate' );
4538
4539 return true;
4540 }
4541
4542 /**
4543 * Load the user options either from cache, the database or an array
4544 *
4545 * @param array $data Rows for the current user out of the user_properties table
4546 */
4547 protected function loadOptions( $data = null ) {
4548 global $wgContLang;
4549
4550 $this->load();
4551
4552 if ( $this->mOptionsLoaded ) {
4553 return;
4554 }
4555
4556 $this->mOptions = self::getDefaultOptions();
4557
4558 if ( !$this->getId() ) {
4559 // For unlogged-in users, load language/variant options from request.
4560 // There's no need to do it for logged-in users: they can set preferences,
4561 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4562 // so don't override user's choice (especially when the user chooses site default).
4563 $variant = $wgContLang->getDefaultVariant();
4564 $this->mOptions['variant'] = $variant;
4565 $this->mOptions['language'] = $variant;
4566 $this->mOptionsLoaded = true;
4567 return;
4568 }
4569
4570 // Maybe load from the object
4571 if ( !is_null( $this->mOptionOverrides ) ) {
4572 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4573 foreach ( $this->mOptionOverrides as $key => $value ) {
4574 $this->mOptions[$key] = $value;
4575 }
4576 } else {
4577 if ( !is_array( $data ) ) {
4578 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4579 // Load from database
4580 $dbr = wfGetDB( DB_SLAVE );
4581
4582 $res = $dbr->select(
4583 'user_properties',
4584 array( 'up_property', 'up_value' ),
4585 array( 'up_user' => $this->getId() ),
4586 __METHOD__
4587 );
4588
4589 $this->mOptionOverrides = array();
4590 $data = array();
4591 foreach ( $res as $row ) {
4592 $data[$row->up_property] = $row->up_value;
4593 }
4594 }
4595 foreach ( $data as $property => $value ) {
4596 $this->mOptionOverrides[$property] = $value;
4597 $this->mOptions[$property] = $value;
4598 }
4599 }
4600
4601 $this->mOptionsLoaded = true;
4602
4603 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions ) );
4604 }
4605
4606 /**
4607 * @todo document
4608 */
4609 protected function saveOptions() {
4610 $this->loadOptions();
4611
4612 // Not using getOptions(), to keep hidden preferences in database
4613 $saveOptions = $this->mOptions;
4614
4615 // Allow hooks to abort, for instance to save to a global profile.
4616 // Reset options to default state before saving.
4617 if ( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4618 return;
4619 }
4620
4621 $userId = $this->getId();
4622 $insert_rows = array();
4623 foreach ( $saveOptions as $key => $value ) {
4624 // Don't bother storing default values
4625 $defaultOption = self::getDefaultOption( $key );
4626 if ( ( is_null( $defaultOption ) &&
4627 !( $value === false || is_null( $value ) ) ) ||
4628 $value != $defaultOption ) {
4629 $insert_rows[] = array(
4630 'up_user' => $userId,
4631 'up_property' => $key,
4632 'up_value' => $value,
4633 );
4634 }
4635 }
4636
4637 $dbw = wfGetDB( DB_MASTER );
4638 $hasRows = $dbw->selectField( 'user_properties', '1',
4639 array( 'up_user' => $userId ), __METHOD__ );
4640
4641 if ( $hasRows ) {
4642 // Only do this delete if there is something there. A very large portion of
4643 // calls to this function are for setting 'rememberpassword' for new accounts.
4644 // Doing this delete for new accounts with no rows in the table rougly causes
4645 // gap locks on [max user ID,+infinity) which causes high contention since many
4646 // updates will pile up on each other since they are for higher (newer) user IDs.
4647 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__ );
4648 }
4649 $dbw->insert( 'user_properties', $insert_rows, __METHOD__, array( 'IGNORE' ) );
4650 }
4651
4652 /**
4653 * Provide an array of HTML5 attributes to put on an input element
4654 * intended for the user to enter a new password. This may include
4655 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4656 *
4657 * Do *not* use this when asking the user to enter his current password!
4658 * Regardless of configuration, users may have invalid passwords for whatever
4659 * reason (e.g., they were set before requirements were tightened up).
4660 * Only use it when asking for a new password, like on account creation or
4661 * ResetPass.
4662 *
4663 * Obviously, you still need to do server-side checking.
4664 *
4665 * NOTE: A combination of bugs in various browsers means that this function
4666 * actually just returns array() unconditionally at the moment. May as
4667 * well keep it around for when the browser bugs get fixed, though.
4668 *
4669 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4670 *
4671 * @return array Array of HTML attributes suitable for feeding to
4672 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4673 * That will get confused by the boolean attribute syntax used.)
4674 */
4675 public static function passwordChangeInputAttribs() {
4676 global $wgMinimalPasswordLength;
4677
4678 if ( $wgMinimalPasswordLength == 0 ) {
4679 return array();
4680 }
4681
4682 # Note that the pattern requirement will always be satisfied if the
4683 # input is empty, so we need required in all cases.
4684 #
4685 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4686 # if e-mail confirmation is being used. Since HTML5 input validation
4687 # is b0rked anyway in some browsers, just return nothing. When it's
4688 # re-enabled, fix this code to not output required for e-mail
4689 # registration.
4690 #$ret = array( 'required' );
4691 $ret = array();
4692
4693 # We can't actually do this right now, because Opera 9.6 will print out
4694 # the entered password visibly in its error message! When other
4695 # browsers add support for this attribute, or Opera fixes its support,
4696 # we can add support with a version check to avoid doing this on Opera
4697 # versions where it will be a problem. Reported to Opera as
4698 # DSK-262266, but they don't have a public bug tracker for us to follow.
4699 /*
4700 if ( $wgMinimalPasswordLength > 1 ) {
4701 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4702 $ret['title'] = wfMessage( 'passwordtooshort' )
4703 ->numParams( $wgMinimalPasswordLength )->text();
4704 }
4705 */
4706
4707 return $ret;
4708 }
4709
4710 /**
4711 * Return the list of user fields that should be selected to create
4712 * a new user object.
4713 * @return array
4714 */
4715 public static function selectFields() {
4716 return array(
4717 'user_id',
4718 'user_name',
4719 'user_real_name',
4720 'user_password',
4721 'user_newpassword',
4722 'user_newpass_time',
4723 'user_email',
4724 'user_touched',
4725 'user_token',
4726 'user_email_authenticated',
4727 'user_email_token',
4728 'user_email_token_expires',
4729 'user_registration',
4730 'user_editcount',
4731 );
4732 }
4733
4734 /**
4735 * Factory function for fatal permission-denied errors
4736 *
4737 * @since 1.22
4738 * @param string $permission User right required
4739 * @return Status
4740 */
4741 static function newFatalPermissionDeniedStatus( $permission ) {
4742 global $wgLang;
4743
4744 $groups = array_map(
4745 array( 'User', 'makeGroupLinkWiki' ),
4746 User::getGroupsWithPermission( $permission )
4747 );
4748
4749 if ( $groups ) {
4750 return Status::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
4751 } else {
4752 return Status::newFatal( 'badaccess-group0' );
4753 }
4754 }
4755 }