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