decodeOptions() used by GlobalAuth - made it public
[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 if ( isset( $row->user_name ) ) {
1057 $this->mName = $row->user_name;
1058 $this->mFrom = 'name';
1059 $this->setItemLoaded( 'name' );
1060 } else {
1061 $all = false;
1062 }
1063
1064 if ( isset( $row->user_real_name ) ) {
1065 $this->mRealName = $row->user_real_name;
1066 $this->setItemLoaded( 'realname' );
1067 } else {
1068 $all = false;
1069 }
1070
1071 if ( isset( $row->user_id ) ) {
1072 $this->mId = intval( $row->user_id );
1073 $this->mFrom = 'id';
1074 $this->setItemLoaded( 'id' );
1075 } else {
1076 $all = false;
1077 }
1078
1079 if ( isset( $row->user_password ) ) {
1080 $this->mPassword = $row->user_password;
1081 $this->mNewpassword = $row->user_newpassword;
1082 $this->mNewpassTime = wfTimestampOrNull( TS_MW, $row->user_newpass_time );
1083 $this->mEmail = $row->user_email;
1084 $this->decodeOptions( $row->user_options );
1085 $this->mTouched = wfTimestamp(TS_MW,$row->user_touched);
1086 $this->mToken = $row->user_token;
1087 $this->mEmailAuthenticated = wfTimestampOrNull( TS_MW, $row->user_email_authenticated );
1088 $this->mEmailToken = $row->user_email_token;
1089 $this->mEmailTokenExpires = wfTimestampOrNull( TS_MW, $row->user_email_token_expires );
1090 $this->mRegistration = wfTimestampOrNull( TS_MW, $row->user_registration );
1091 $this->mEditCount = $row->user_editcount;
1092 } else {
1093 $all = false;
1094 }
1095
1096 if ( $all ) {
1097 $this->mLoadedItems = true;
1098 }
1099 }
1100
1101 /**
1102 * Load the data for this user object from another user object.
1103 *
1104 * @param $user User
1105 */
1106 protected function loadFromUserObject( $user ) {
1107 $user->load();
1108 $user->loadGroups();
1109 $user->loadOptions();
1110 foreach ( self::$mCacheVars as $var ) {
1111 $this->$var = $user->$var;
1112 }
1113 }
1114
1115 /**
1116 * Load the groups from the database if they aren't already loaded.
1117 */
1118 private function loadGroups() {
1119 if ( is_null( $this->mGroups ) ) {
1120 $dbr = wfGetDB( DB_MASTER );
1121 $res = $dbr->select( 'user_groups',
1122 array( 'ug_group' ),
1123 array( 'ug_user' => $this->mId ),
1124 __METHOD__ );
1125 $this->mGroups = array();
1126 foreach ( $res as $row ) {
1127 $this->mGroups[] = $row->ug_group;
1128 }
1129 }
1130 }
1131
1132 /**
1133 * Add the user to the group if he/she meets given criteria.
1134 *
1135 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1136 * possible to remove manually via Special:UserRights. In such case it
1137 * will not be re-added automatically. The user will also not lose the
1138 * group if they no longer meet the criteria.
1139 *
1140 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1141 *
1142 * @return array Array of groups the user has been promoted to.
1143 *
1144 * @see $wgAutopromoteOnce
1145 */
1146 public function addAutopromoteOnceGroups( $event ) {
1147 global $wgAutopromoteOnceLogInRC;
1148
1149 $toPromote = array();
1150 if ( $this->getId() ) {
1151 $toPromote = Autopromote::getAutopromoteOnceGroups( $this, $event );
1152 if ( count( $toPromote ) ) {
1153 $oldGroups = $this->getGroups(); // previous groups
1154 foreach ( $toPromote as $group ) {
1155 $this->addGroup( $group );
1156 }
1157 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1158
1159 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1160 $log->addEntry( 'autopromote',
1161 $this->getUserPage(),
1162 '', // no comment
1163 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1164 );
1165 }
1166 }
1167 return $toPromote;
1168 }
1169
1170 /**
1171 * Clear various cached data stored in this object.
1172 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1173 * given source. May be "name", "id", "defaults", "session", or false for
1174 * no reload.
1175 */
1176 public function clearInstanceCache( $reloadFrom = false ) {
1177 $this->mNewtalk = -1;
1178 $this->mDatePreference = null;
1179 $this->mBlockedby = -1; # Unset
1180 $this->mHash = false;
1181 $this->mRights = null;
1182 $this->mEffectiveGroups = null;
1183 $this->mImplicitGroups = null;
1184 $this->mOptions = null;
1185
1186 if ( $reloadFrom ) {
1187 $this->mLoadedItems = array();
1188 $this->mFrom = $reloadFrom;
1189 }
1190 }
1191
1192 /**
1193 * Combine the language default options with any site-specific options
1194 * and add the default language variants.
1195 *
1196 * @return Array of String options
1197 */
1198 public static function getDefaultOptions() {
1199 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1200
1201 $defOpt = $wgDefaultUserOptions;
1202 # default language setting
1203 $variant = $wgContLang->getDefaultVariant();
1204 $defOpt['variant'] = $variant;
1205 $defOpt['language'] = $variant;
1206 foreach( SearchEngine::searchableNamespaces() as $nsnum => $nsname ) {
1207 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1208 }
1209 $defOpt['skin'] = $wgDefaultSkin;
1210
1211 return $defOpt;
1212 }
1213
1214 /**
1215 * Get a given default option value.
1216 *
1217 * @param $opt String Name of option to retrieve
1218 * @return String Default option value
1219 */
1220 public static function getDefaultOption( $opt ) {
1221 $defOpts = self::getDefaultOptions();
1222 if( isset( $defOpts[$opt] ) ) {
1223 return $defOpts[$opt];
1224 } else {
1225 return null;
1226 }
1227 }
1228
1229
1230 /**
1231 * Get blocking information
1232 * @param $bFromSlave Bool Whether to check the slave database first. To
1233 * improve performance, non-critical checks are done
1234 * against slaves. Check when actually saving should be
1235 * done against master.
1236 */
1237 private function getBlockedStatus( $bFromSlave = true ) {
1238 global $wgProxyWhitelist, $wgUser;
1239
1240 if ( -1 != $this->mBlockedby ) {
1241 return;
1242 }
1243
1244 wfProfileIn( __METHOD__ );
1245 wfDebug( __METHOD__.": checking...\n" );
1246
1247 // Initialize data...
1248 // Otherwise something ends up stomping on $this->mBlockedby when
1249 // things get lazy-loaded later, causing false positive block hits
1250 // due to -1 !== 0. Probably session-related... Nothing should be
1251 // overwriting mBlockedby, surely?
1252 $this->load();
1253
1254 $this->mBlockedby = 0;
1255 $this->mHideName = 0;
1256 $this->mAllowUsertalk = 0;
1257
1258 # We only need to worry about passing the IP address to the Block generator if the
1259 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1260 # know which IP address they're actually coming from
1261 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1262 $ip = wfGetIP();
1263 } else {
1264 $ip = null;
1265 }
1266
1267 # User/IP blocking
1268 $this->mBlock = Block::newFromTarget( $this->getName(), $ip, !$bFromSlave );
1269 if ( $this->mBlock instanceof Block ) {
1270 wfDebug( __METHOD__ . ": Found block.\n" );
1271 $this->mBlockedby = $this->mBlock->getByName();
1272 $this->mBlockreason = $this->mBlock->mReason;
1273 $this->mHideName = $this->mBlock->mHideName;
1274 $this->mAllowUsertalk = !$this->mBlock->prevents( 'editownusertalk' );
1275 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1276 $this->spreadBlock();
1277 }
1278 }
1279
1280 # Proxy blocking
1281 if ( $ip !== null && !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1282 # Local list
1283 if ( self::isLocallyBlockedProxy( $ip ) ) {
1284 $this->mBlockedby = wfMsg( 'proxyblocker' );
1285 $this->mBlockreason = wfMsg( 'proxyblockreason' );
1286 }
1287
1288 # DNSBL
1289 if ( !$this->mBlockedby && !$this->getID() ) {
1290 if ( $this->isDnsBlacklisted( $ip ) ) {
1291 $this->mBlockedby = wfMsg( 'sorbs' );
1292 $this->mBlockreason = wfMsg( 'sorbsreason' );
1293 }
1294 }
1295 }
1296
1297 # Extensions
1298 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1299
1300 wfProfileOut( __METHOD__ );
1301 }
1302
1303 /**
1304 * Whether the given IP is in a DNS blacklist.
1305 *
1306 * @param $ip String IP to check
1307 * @param $checkWhitelist Bool: whether to check the whitelist first
1308 * @return Bool True if blacklisted.
1309 */
1310 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1311 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1312 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1313
1314 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1315 return false;
1316
1317 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1318 return false;
1319
1320 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1321 return $this->inDnsBlacklist( $ip, $urls );
1322 }
1323
1324 /**
1325 * Whether the given IP is in a given DNS blacklist.
1326 *
1327 * @param $ip String IP to check
1328 * @param $bases String|Array of Strings: URL of the DNS blacklist
1329 * @return Bool True if blacklisted.
1330 */
1331 public function inDnsBlacklist( $ip, $bases ) {
1332 wfProfileIn( __METHOD__ );
1333
1334 $found = false;
1335 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1336 if( IP::isIPv4( $ip ) ) {
1337 # Reverse IP, bug 21255
1338 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1339
1340 foreach( (array)$bases as $base ) {
1341 # Make hostname
1342 # If we have an access key, use that too (ProjectHoneypot, etc.)
1343 if( is_array( $base ) ) {
1344 if( count( $base ) >= 2 ) {
1345 # Access key is 1, base URL is 0
1346 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1347 } else {
1348 $host = "$ipReversed.{$base[0]}";
1349 }
1350 } else {
1351 $host = "$ipReversed.$base";
1352 }
1353
1354 # Send query
1355 $ipList = gethostbynamel( $host );
1356
1357 if( $ipList ) {
1358 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1359 $found = true;
1360 break;
1361 } else {
1362 wfDebug( "Requested $host, not found in $base.\n" );
1363 }
1364 }
1365 }
1366
1367 wfProfileOut( __METHOD__ );
1368 return $found;
1369 }
1370
1371 /**
1372 * Check if an IP address is in the local proxy list
1373 *
1374 * @param $ip string
1375 *
1376 * @return bool
1377 */
1378 public static function isLocallyBlockedProxy( $ip ) {
1379 global $wgProxyList;
1380
1381 if ( !$wgProxyList ) {
1382 return false;
1383 }
1384 wfProfileIn( __METHOD__ );
1385
1386 if ( !is_array( $wgProxyList ) ) {
1387 # Load from the specified file
1388 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1389 }
1390
1391 if ( !is_array( $wgProxyList ) ) {
1392 $ret = false;
1393 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1394 $ret = true;
1395 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1396 # Old-style flipped proxy list
1397 $ret = true;
1398 } else {
1399 $ret = false;
1400 }
1401 wfProfileOut( __METHOD__ );
1402 return $ret;
1403 }
1404
1405 /**
1406 * Is this user subject to rate limiting?
1407 *
1408 * @return Bool True if rate limited
1409 */
1410 public function isPingLimitable() {
1411 global $wgRateLimitsExcludedIPs;
1412 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1413 // No other good way currently to disable rate limits
1414 // for specific IPs. :P
1415 // But this is a crappy hack and should die.
1416 return false;
1417 }
1418 return !$this->isAllowed('noratelimit');
1419 }
1420
1421 /**
1422 * Primitive rate limits: enforce maximum actions per time period
1423 * to put a brake on flooding.
1424 *
1425 * @note When using a shared cache like memcached, IP-address
1426 * last-hit counters will be shared across wikis.
1427 *
1428 * @param $action String Action to enforce; 'edit' if unspecified
1429 * @return Bool True if a rate limiter was tripped
1430 */
1431 public function pingLimiter( $action = 'edit' ) {
1432 # Call the 'PingLimiter' hook
1433 $result = false;
1434 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1435 return $result;
1436 }
1437
1438 global $wgRateLimits;
1439 if( !isset( $wgRateLimits[$action] ) ) {
1440 return false;
1441 }
1442
1443 # Some groups shouldn't trigger the ping limiter, ever
1444 if( !$this->isPingLimitable() )
1445 return false;
1446
1447 global $wgMemc, $wgRateLimitLog;
1448 wfProfileIn( __METHOD__ );
1449
1450 $limits = $wgRateLimits[$action];
1451 $keys = array();
1452 $id = $this->getId();
1453 $ip = wfGetIP();
1454 $userLimit = false;
1455
1456 if( isset( $limits['anon'] ) && $id == 0 ) {
1457 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1458 }
1459
1460 if( isset( $limits['user'] ) && $id != 0 ) {
1461 $userLimit = $limits['user'];
1462 }
1463 if( $this->isNewbie() ) {
1464 if( isset( $limits['newbie'] ) && $id != 0 ) {
1465 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1466 }
1467 if( isset( $limits['ip'] ) ) {
1468 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1469 }
1470 $matches = array();
1471 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1472 $subnet = $matches[1];
1473 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1474 }
1475 }
1476 // Check for group-specific permissions
1477 // If more than one group applies, use the group with the highest limit
1478 foreach ( $this->getGroups() as $group ) {
1479 if ( isset( $limits[$group] ) ) {
1480 if ( $userLimit === false || $limits[$group] > $userLimit ) {
1481 $userLimit = $limits[$group];
1482 }
1483 }
1484 }
1485 // Set the user limit key
1486 if ( $userLimit !== false ) {
1487 wfDebug( __METHOD__ . ": effective user limit: $userLimit\n" );
1488 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1489 }
1490
1491 $triggered = false;
1492 foreach( $keys as $key => $limit ) {
1493 list( $max, $period ) = $limit;
1494 $summary = "(limit $max in {$period}s)";
1495 $count = $wgMemc->get( $key );
1496 // Already pinged?
1497 if( $count ) {
1498 if( $count > $max ) {
1499 wfDebug( __METHOD__ . ": tripped! $key at $count $summary\n" );
1500 if( $wgRateLimitLog ) {
1501 wfSuppressWarnings();
1502 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW ) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND );
1503 wfRestoreWarnings();
1504 }
1505 $triggered = true;
1506 } else {
1507 wfDebug( __METHOD__ . ": ok. $key at $count $summary\n" );
1508 }
1509 } else {
1510 wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
1511 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1512 }
1513 $wgMemc->incr( $key );
1514 }
1515
1516 wfProfileOut( __METHOD__ );
1517 return $triggered;
1518 }
1519
1520 /**
1521 * Check if user is blocked
1522 *
1523 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1524 * @return Bool True if blocked, false otherwise
1525 */
1526 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1527 $this->getBlockedStatus( $bFromSlave );
1528 return $this->mBlock instanceof Block && $this->mBlock->prevents( 'edit' );
1529 }
1530
1531 /**
1532 * Check if user is blocked from editing a particular article
1533 *
1534 * @param $title Title to check
1535 * @param $bFromSlave Bool whether to check the slave database instead of the master
1536 * @return Bool
1537 */
1538 function isBlockedFrom( $title, $bFromSlave = false ) {
1539 global $wgBlockAllowsUTEdit;
1540 wfProfileIn( __METHOD__ );
1541
1542 $blocked = $this->isBlocked( $bFromSlave );
1543 $allowUsertalk = ( $wgBlockAllowsUTEdit ? $this->mAllowUsertalk : false );
1544 # If a user's name is suppressed, they cannot make edits anywhere
1545 if ( !$this->mHideName && $allowUsertalk && $title->getText() === $this->getName() &&
1546 $title->getNamespace() == NS_USER_TALK ) {
1547 $blocked = false;
1548 wfDebug( __METHOD__ . ": self-talk page, ignoring any blocks\n" );
1549 }
1550
1551 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1552
1553 wfProfileOut( __METHOD__ );
1554 return $blocked;
1555 }
1556
1557 /**
1558 * If user is blocked, return the name of the user who placed the block
1559 * @return String name of blocker
1560 */
1561 public function blockedBy() {
1562 $this->getBlockedStatus();
1563 return $this->mBlockedby;
1564 }
1565
1566 /**
1567 * If user is blocked, return the specified reason for the block
1568 * @return String Blocking reason
1569 */
1570 public function blockedFor() {
1571 $this->getBlockedStatus();
1572 return $this->mBlockreason;
1573 }
1574
1575 /**
1576 * If user is blocked, return the ID for the block
1577 * @return Int Block ID
1578 */
1579 public function getBlockId() {
1580 $this->getBlockedStatus();
1581 return ( $this->mBlock ? $this->mBlock->getId() : false );
1582 }
1583
1584 /**
1585 * Check if user is blocked on all wikis.
1586 * Do not use for actual edit permission checks!
1587 * This is intented for quick UI checks.
1588 *
1589 * @param $ip String IP address, uses current client if none given
1590 * @return Bool True if blocked, false otherwise
1591 */
1592 public function isBlockedGlobally( $ip = '' ) {
1593 if( $this->mBlockedGlobally !== null ) {
1594 return $this->mBlockedGlobally;
1595 }
1596 // User is already an IP?
1597 if( IP::isIPAddress( $this->getName() ) ) {
1598 $ip = $this->getName();
1599 } elseif( !$ip ) {
1600 $ip = wfGetIP();
1601 }
1602 $blocked = false;
1603 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1604 $this->mBlockedGlobally = (bool)$blocked;
1605 return $this->mBlockedGlobally;
1606 }
1607
1608 /**
1609 * Check if user account is locked
1610 *
1611 * @return Bool True if locked, false otherwise
1612 */
1613 public function isLocked() {
1614 if( $this->mLocked !== null ) {
1615 return $this->mLocked;
1616 }
1617 global $wgAuth;
1618 $authUser = $wgAuth->getUserInstance( $this );
1619 $this->mLocked = (bool)$authUser->isLocked();
1620 return $this->mLocked;
1621 }
1622
1623 /**
1624 * Check if user account is hidden
1625 *
1626 * @return Bool True if hidden, false otherwise
1627 */
1628 public function isHidden() {
1629 if( $this->mHideName !== null ) {
1630 return $this->mHideName;
1631 }
1632 $this->getBlockedStatus();
1633 if( !$this->mHideName ) {
1634 global $wgAuth;
1635 $authUser = $wgAuth->getUserInstance( $this );
1636 $this->mHideName = (bool)$authUser->isHidden();
1637 }
1638 return $this->mHideName;
1639 }
1640
1641 /**
1642 * Get the user's ID.
1643 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1644 */
1645 public function getId() {
1646 if( $this->mId === null && $this->mName !== null
1647 && User::isIP( $this->mName ) ) {
1648 // Special case, we know the user is anonymous
1649 return 0;
1650 } elseif( !$this->isItemLoaded( 'id' ) ) {
1651 // Don't load if this was initialized from an ID
1652 $this->load();
1653 }
1654 return $this->mId;
1655 }
1656
1657 /**
1658 * Set the user and reload all fields according to a given ID
1659 * @param $v Int User ID to reload
1660 */
1661 public function setId( $v ) {
1662 $this->mId = $v;
1663 $this->clearInstanceCache( 'id' );
1664 }
1665
1666 /**
1667 * Get the user name, or the IP of an anonymous user
1668 * @return String User's name or IP address
1669 */
1670 public function getName() {
1671 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1672 # Special case optimisation
1673 return $this->mName;
1674 } else {
1675 $this->load();
1676 if ( $this->mName === false ) {
1677 # Clean up IPs
1678 $this->mName = IP::sanitizeIP( wfGetIP() );
1679 }
1680 return $this->mName;
1681 }
1682 }
1683
1684 /**
1685 * Set the user name.
1686 *
1687 * This does not reload fields from the database according to the given
1688 * name. Rather, it is used to create a temporary "nonexistent user" for
1689 * later addition to the database. It can also be used to set the IP
1690 * address for an anonymous user to something other than the current
1691 * remote IP.
1692 *
1693 * @note User::newFromName() has rougly the same function, when the named user
1694 * does not exist.
1695 * @param $str String New user name to set
1696 */
1697 public function setName( $str ) {
1698 $this->load();
1699 $this->mName = $str;
1700 }
1701
1702 /**
1703 * Get the user's name escaped by underscores.
1704 * @return String Username escaped by underscores.
1705 */
1706 public function getTitleKey() {
1707 return str_replace( ' ', '_', $this->getName() );
1708 }
1709
1710 /**
1711 * Check if the user has new messages.
1712 * @return Bool True if the user has new messages
1713 */
1714 public function getNewtalk() {
1715 $this->load();
1716
1717 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1718 if( $this->mNewtalk === -1 ) {
1719 $this->mNewtalk = false; # reset talk page status
1720
1721 # Check memcached separately for anons, who have no
1722 # entire User object stored in there.
1723 if( !$this->mId ) {
1724 global $wgMemc;
1725 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1726 $newtalk = $wgMemc->get( $key );
1727 if( strval( $newtalk ) !== '' ) {
1728 $this->mNewtalk = (bool)$newtalk;
1729 } else {
1730 // Since we are caching this, make sure it is up to date by getting it
1731 // from the master
1732 $this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName(), true );
1733 $wgMemc->set( $key, (int)$this->mNewtalk, 1800 );
1734 }
1735 } else {
1736 $this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
1737 }
1738 }
1739
1740 return (bool)$this->mNewtalk;
1741 }
1742
1743 /**
1744 * Return the talk page(s) this user has new messages on.
1745 * @return Array of String page URLs
1746 */
1747 public function getNewMessageLinks() {
1748 $talks = array();
1749 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1750 return $talks;
1751
1752 if( !$this->getNewtalk() )
1753 return array();
1754 $up = $this->getUserPage();
1755 $utp = $up->getTalkPage();
1756 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1757 }
1758
1759 /**
1760 * Internal uncached check for new messages
1761 *
1762 * @see getNewtalk()
1763 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1764 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1765 * @param $fromMaster Bool true to fetch from the master, false for a slave
1766 * @return Bool True if the user has new messages
1767 */
1768 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1769 if ( $fromMaster ) {
1770 $db = wfGetDB( DB_MASTER );
1771 } else {
1772 $db = wfGetDB( DB_SLAVE );
1773 }
1774 $ok = $db->selectField( 'user_newtalk', $field,
1775 array( $field => $id ), __METHOD__ );
1776 return $ok !== false;
1777 }
1778
1779 /**
1780 * Add or update the new messages flag
1781 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1782 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1783 * @return Bool True if successful, false otherwise
1784 */
1785 protected function updateNewtalk( $field, $id ) {
1786 $dbw = wfGetDB( DB_MASTER );
1787 $dbw->insert( 'user_newtalk',
1788 array( $field => $id ),
1789 __METHOD__,
1790 'IGNORE' );
1791 if ( $dbw->affectedRows() ) {
1792 wfDebug( __METHOD__ . ": set on ($field, $id)\n" );
1793 return true;
1794 } else {
1795 wfDebug( __METHOD__ . " already set ($field, $id)\n" );
1796 return false;
1797 }
1798 }
1799
1800 /**
1801 * Clear the new messages flag for the given user
1802 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1803 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1804 * @return Bool True if successful, false otherwise
1805 */
1806 protected function deleteNewtalk( $field, $id ) {
1807 $dbw = wfGetDB( DB_MASTER );
1808 $dbw->delete( 'user_newtalk',
1809 array( $field => $id ),
1810 __METHOD__ );
1811 if ( $dbw->affectedRows() ) {
1812 wfDebug( __METHOD__ . ": killed on ($field, $id)\n" );
1813 return true;
1814 } else {
1815 wfDebug( __METHOD__ . ": already gone ($field, $id)\n" );
1816 return false;
1817 }
1818 }
1819
1820 /**
1821 * Update the 'You have new messages!' status.
1822 * @param $val Bool Whether the user has new messages
1823 */
1824 public function setNewtalk( $val ) {
1825 if( wfReadOnly() ) {
1826 return;
1827 }
1828
1829 $this->load();
1830 $this->mNewtalk = $val;
1831
1832 if( $this->isAnon() ) {
1833 $field = 'user_ip';
1834 $id = $this->getName();
1835 } else {
1836 $field = 'user_id';
1837 $id = $this->getId();
1838 }
1839 global $wgMemc;
1840
1841 if( $val ) {
1842 $changed = $this->updateNewtalk( $field, $id );
1843 } else {
1844 $changed = $this->deleteNewtalk( $field, $id );
1845 }
1846
1847 if( $this->isAnon() ) {
1848 // Anons have a separate memcached space, since
1849 // user records aren't kept for them.
1850 $key = wfMemcKey( 'newtalk', 'ip', $id );
1851 $wgMemc->set( $key, $val ? 1 : 0, 1800 );
1852 }
1853 if ( $changed ) {
1854 $this->invalidateCache();
1855 }
1856 }
1857
1858 /**
1859 * Generate a current or new-future timestamp to be stored in the
1860 * user_touched field when we update things.
1861 * @return String Timestamp in TS_MW format
1862 */
1863 private static function newTouchedTimestamp() {
1864 global $wgClockSkewFudge;
1865 return wfTimestamp( TS_MW, time() + $wgClockSkewFudge );
1866 }
1867
1868 /**
1869 * Clear user data from memcached.
1870 * Use after applying fun updates to the database; caller's
1871 * responsibility to update user_touched if appropriate.
1872 *
1873 * Called implicitly from invalidateCache() and saveSettings().
1874 */
1875 private function clearSharedCache() {
1876 $this->load();
1877 if( $this->mId ) {
1878 global $wgMemc;
1879 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId ) );
1880 }
1881 }
1882
1883 /**
1884 * Immediately touch the user data cache for this account.
1885 * Updates user_touched field, and removes account data from memcached
1886 * for reload on the next hit.
1887 */
1888 public function invalidateCache() {
1889 if( wfReadOnly() ) {
1890 return;
1891 }
1892 $this->load();
1893 if( $this->mId ) {
1894 $this->mTouched = self::newTouchedTimestamp();
1895
1896 $dbw = wfGetDB( DB_MASTER );
1897 $dbw->update( 'user',
1898 array( 'user_touched' => $dbw->timestamp( $this->mTouched ) ),
1899 array( 'user_id' => $this->mId ),
1900 __METHOD__ );
1901
1902 $this->clearSharedCache();
1903 }
1904 }
1905
1906 /**
1907 * Validate the cache for this account.
1908 * @param $timestamp String A timestamp in TS_MW format
1909 *
1910 * @return bool
1911 */
1912 public function validateCache( $timestamp ) {
1913 $this->load();
1914 return ( $timestamp >= $this->mTouched );
1915 }
1916
1917 /**
1918 * Get the user touched timestamp
1919 * @return String timestamp
1920 */
1921 public function getTouched() {
1922 $this->load();
1923 return $this->mTouched;
1924 }
1925
1926 /**
1927 * Set the password and reset the random token.
1928 * Calls through to authentication plugin if necessary;
1929 * will have no effect if the auth plugin refuses to
1930 * pass the change through or if the legal password
1931 * checks fail.
1932 *
1933 * As a special case, setting the password to null
1934 * wipes it, so the account cannot be logged in until
1935 * a new password is set, for instance via e-mail.
1936 *
1937 * @param $str String New password to set
1938 * @throws PasswordError on failure
1939 *
1940 * @return bool
1941 */
1942 public function setPassword( $str ) {
1943 global $wgAuth;
1944
1945 if( $str !== null ) {
1946 if( !$wgAuth->allowPasswordChange() ) {
1947 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1948 }
1949
1950 if( !$this->isValidPassword( $str ) ) {
1951 global $wgMinimalPasswordLength;
1952 $valid = $this->getPasswordValidity( $str );
1953 if ( is_array( $valid ) ) {
1954 $message = array_shift( $valid );
1955 $params = $valid;
1956 } else {
1957 $message = $valid;
1958 $params = array( $wgMinimalPasswordLength );
1959 }
1960 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
1961 }
1962 }
1963
1964 if( !$wgAuth->setPassword( $this, $str ) ) {
1965 throw new PasswordError( wfMsg( 'externaldberror' ) );
1966 }
1967
1968 $this->setInternalPassword( $str );
1969
1970 return true;
1971 }
1972
1973 /**
1974 * Set the password and reset the random token unconditionally.
1975 *
1976 * @param $str String New password to set
1977 */
1978 public function setInternalPassword( $str ) {
1979 $this->load();
1980 $this->setToken();
1981
1982 if( $str === null ) {
1983 // Save an invalid hash...
1984 $this->mPassword = '';
1985 } else {
1986 $this->mPassword = self::crypt( $str );
1987 }
1988 $this->mNewpassword = '';
1989 $this->mNewpassTime = null;
1990 }
1991
1992 /**
1993 * Get the user's current token.
1994 * @return String Token
1995 */
1996 public function getToken() {
1997 $this->load();
1998 return $this->mToken;
1999 }
2000
2001 /**
2002 * Set the random token (used for persistent authentication)
2003 * Called from loadDefaults() among other places.
2004 *
2005 * @param $token String|bool If specified, set the token to this value
2006 */
2007 public function setToken( $token = false ) {
2008 global $wgSecretKey, $wgProxyKey;
2009 $this->load();
2010 if ( !$token ) {
2011 if ( $wgSecretKey ) {
2012 $key = $wgSecretKey;
2013 } elseif ( $wgProxyKey ) {
2014 $key = $wgProxyKey;
2015 } else {
2016 $key = microtime();
2017 }
2018 $this->mToken = md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId );
2019 } else {
2020 $this->mToken = $token;
2021 }
2022 }
2023
2024 /**
2025 * Set the cookie password
2026 *
2027 * @param $str String New cookie password
2028 */
2029 private function setCookiePassword( $str ) {
2030 $this->load();
2031 $this->mCookiePassword = md5( $str );
2032 }
2033
2034 /**
2035 * Set the password for a password reminder or new account email
2036 *
2037 * @param $str String New password to set
2038 * @param $throttle Bool If true, reset the throttle timestamp to the present
2039 */
2040 public function setNewpassword( $str, $throttle = true ) {
2041 $this->load();
2042 $this->mNewpassword = self::crypt( $str );
2043 if ( $throttle ) {
2044 $this->mNewpassTime = wfTimestampNow();
2045 }
2046 }
2047
2048 /**
2049 * Has password reminder email been sent within the last
2050 * $wgPasswordReminderResendTime hours?
2051 * @return Bool
2052 */
2053 public function isPasswordReminderThrottled() {
2054 global $wgPasswordReminderResendTime;
2055 $this->load();
2056 if ( !$this->mNewpassTime || !$wgPasswordReminderResendTime ) {
2057 return false;
2058 }
2059 $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgPasswordReminderResendTime * 3600;
2060 return time() < $expiry;
2061 }
2062
2063 /**
2064 * Get the user's e-mail address
2065 * @return String User's email address
2066 */
2067 public function getEmail() {
2068 $this->load();
2069 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail ) );
2070 return $this->mEmail;
2071 }
2072
2073 /**
2074 * Get the timestamp of the user's e-mail authentication
2075 * @return String TS_MW timestamp
2076 */
2077 public function getEmailAuthenticationTimestamp() {
2078 $this->load();
2079 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
2080 return $this->mEmailAuthenticated;
2081 }
2082
2083 /**
2084 * Set the user's e-mail address
2085 * @param $str String New e-mail address
2086 */
2087 public function setEmail( $str ) {
2088 $this->load();
2089 $this->mEmail = $str;
2090 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail ) );
2091 }
2092
2093 /**
2094 * Get the user's real name
2095 * @return String User's real name
2096 */
2097 public function getRealName() {
2098 if ( !$this->isItemLoaded( 'realname' ) ) {
2099 $this->load();
2100 }
2101
2102 return $this->mRealName;
2103 }
2104
2105 /**
2106 * Set the user's real name
2107 * @param $str String New real name
2108 */
2109 public function setRealName( $str ) {
2110 $this->load();
2111 $this->mRealName = $str;
2112 }
2113
2114 /**
2115 * Get the user's current setting for a given option.
2116 *
2117 * @param $oname String The option to check
2118 * @param $defaultOverride String A default value returned if the option does not exist
2119 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2120 * @return String User's current value for the option
2121 * @see getBoolOption()
2122 * @see getIntOption()
2123 */
2124 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2125 global $wgHiddenPrefs;
2126 $this->loadOptions();
2127
2128 if ( is_null( $this->mOptions ) ) {
2129 if($defaultOverride != '') {
2130 return $defaultOverride;
2131 }
2132 $this->mOptions = User::getDefaultOptions();
2133 }
2134
2135 # We want 'disabled' preferences to always behave as the default value for
2136 # users, even if they have set the option explicitly in their settings (ie they
2137 # set it, and then it was disabled removing their ability to change it). But
2138 # we don't want to erase the preferences in the database in case the preference
2139 # is re-enabled again. So don't touch $mOptions, just override the returned value
2140 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2141 return self::getDefaultOption( $oname );
2142 }
2143
2144 if ( array_key_exists( $oname, $this->mOptions ) ) {
2145 return $this->mOptions[$oname];
2146 } else {
2147 return $defaultOverride;
2148 }
2149 }
2150
2151 /**
2152 * Get all user's options
2153 *
2154 * @return array
2155 */
2156 public function getOptions() {
2157 global $wgHiddenPrefs;
2158 $this->loadOptions();
2159 $options = $this->mOptions;
2160
2161 # We want 'disabled' preferences to always behave as the default value for
2162 # users, even if they have set the option explicitly in their settings (ie they
2163 # set it, and then it was disabled removing their ability to change it). But
2164 # we don't want to erase the preferences in the database in case the preference
2165 # is re-enabled again. So don't touch $mOptions, just override the returned value
2166 foreach( $wgHiddenPrefs as $pref ){
2167 $default = self::getDefaultOption( $pref );
2168 if( $default !== null ){
2169 $options[$pref] = $default;
2170 }
2171 }
2172
2173 return $options;
2174 }
2175
2176 /**
2177 * Get the user's current setting for a given option, as a boolean value.
2178 *
2179 * @param $oname String The option to check
2180 * @return Bool User's current value for the option
2181 * @see getOption()
2182 */
2183 public function getBoolOption( $oname ) {
2184 return (bool)$this->getOption( $oname );
2185 }
2186
2187 /**
2188 * Get the user's current setting for a given option, as a boolean value.
2189 *
2190 * @param $oname String The option to check
2191 * @param $defaultOverride Int A default value returned if the option does not exist
2192 * @return Int User's current value for the option
2193 * @see getOption()
2194 */
2195 public function getIntOption( $oname, $defaultOverride=0 ) {
2196 $val = $this->getOption( $oname );
2197 if( $val == '' ) {
2198 $val = $defaultOverride;
2199 }
2200 return intval( $val );
2201 }
2202
2203 /**
2204 * Set the given option for a user.
2205 *
2206 * @param $oname String The option to set
2207 * @param $val mixed New value to set
2208 */
2209 public function setOption( $oname, $val ) {
2210 $this->load();
2211 $this->loadOptions();
2212
2213 // Explicitly NULL values should refer to defaults
2214 global $wgDefaultUserOptions;
2215 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2216 $val = $wgDefaultUserOptions[$oname];
2217 }
2218
2219 $this->mOptions[$oname] = $val;
2220 }
2221
2222 /**
2223 * Reset all options to the site defaults
2224 */
2225 public function resetOptions() {
2226 $this->mOptions = self::getDefaultOptions();
2227 }
2228
2229 /**
2230 * Get the user's preferred date format.
2231 * @return String User's preferred date format
2232 */
2233 public function getDatePreference() {
2234 // Important migration for old data rows
2235 if ( is_null( $this->mDatePreference ) ) {
2236 global $wgLang;
2237 $value = $this->getOption( 'date' );
2238 $map = $wgLang->getDatePreferenceMigrationMap();
2239 if ( isset( $map[$value] ) ) {
2240 $value = $map[$value];
2241 }
2242 $this->mDatePreference = $value;
2243 }
2244 return $this->mDatePreference;
2245 }
2246
2247 /**
2248 * Get the user preferred stub threshold
2249 *
2250 * @return int
2251 */
2252 public function getStubThreshold() {
2253 global $wgMaxArticleSize; # Maximum article size, in Kb
2254 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2255 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2256 # If they have set an impossible value, disable the preference
2257 # so we can use the parser cache again.
2258 $threshold = 0;
2259 }
2260 return $threshold;
2261 }
2262
2263 /**
2264 * Get the permissions this user has.
2265 * @param $ns int If numeric, get permissions for this namespace
2266 * @return Array of String permission names
2267 */
2268 public function getRights( $ns = null ) {
2269 $key = is_null( $ns ) ? '*' : intval( $ns );
2270
2271 if ( is_null( $this->mRights ) ) {
2272 $this->mRights = array();
2273 }
2274
2275 if ( !isset( $this->mRights[$key] ) ) {
2276 $this->mRights[$key] = self::getGroupPermissions( $this->getEffectiveGroups(), $ns );
2277 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights[$key], $ns ) );
2278 // Force reindexation of rights when a hook has unset one of them
2279 $this->mRights[$key] = array_values( $this->mRights[$key] );
2280 }
2281 if ( is_null( $ns ) ) {
2282 return $this->mRights[$key];
2283 } else {
2284 // Merge non namespace specific rights
2285 return array_merge( $this->mRights[$key], $this->getRights() );
2286 }
2287
2288 }
2289
2290 /**
2291 * Get the list of explicit group memberships this user has.
2292 * The implicit * and user groups are not included.
2293 * @return Array of String internal group names
2294 */
2295 public function getGroups() {
2296 $this->load();
2297 return $this->mGroups;
2298 }
2299
2300 /**
2301 * Get the list of implicit group memberships this user has.
2302 * This includes all explicit groups, plus 'user' if logged in,
2303 * '*' for all accounts, and autopromoted groups
2304 * @param $recache Bool Whether to avoid the cache
2305 * @return Array of String internal group names
2306 */
2307 public function getEffectiveGroups( $recache = false ) {
2308 if ( $recache || is_null( $this->mEffectiveGroups ) ) {
2309 wfProfileIn( __METHOD__ );
2310 $this->mEffectiveGroups = array_unique( array_merge(
2311 $this->getGroups(), // explicit groups
2312 $this->getAutomaticGroups( $recache ) // implicit groups
2313 ) );
2314 # Hook for additional groups
2315 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups ) );
2316 wfProfileOut( __METHOD__ );
2317 }
2318 return $this->mEffectiveGroups;
2319 }
2320
2321 /**
2322 * Get the list of implicit group memberships this user has.
2323 * This includes 'user' if logged in, '*' for all accounts,
2324 * and autopromoted groups
2325 * @param $recache Bool Whether to avoid the cache
2326 * @return Array of String internal group names
2327 */
2328 public function getAutomaticGroups( $recache = false ) {
2329 if ( $recache || is_null( $this->mImplicitGroups ) ) {
2330 wfProfileIn( __METHOD__ );
2331 $this->mImplicitGroups = array( '*' );
2332 if ( $this->getId() ) {
2333 $this->mImplicitGroups[] = 'user';
2334
2335 $this->mImplicitGroups = array_unique( array_merge(
2336 $this->mImplicitGroups,
2337 Autopromote::getAutopromoteGroups( $this )
2338 ) );
2339 }
2340 if ( $recache ) {
2341 # Assure data consistency with rights/groups,
2342 # as getEffectiveGroups() depends on this function
2343 $this->mEffectiveGroups = null;
2344 }
2345 wfProfileOut( __METHOD__ );
2346 }
2347 return $this->mImplicitGroups;
2348 }
2349
2350 /**
2351 * Returns the groups the user has belonged to.
2352 *
2353 * The user may still belong to the returned groups. Compare with getGroups().
2354 *
2355 * The function will not return groups the user had belonged to before MW 1.17
2356 *
2357 * @return array Names of the groups the user has belonged to.
2358 */
2359 public function getFormerGroups() {
2360 if( is_null( $this->mFormerGroups ) ) {
2361 $dbr = wfGetDB( DB_MASTER );
2362 $res = $dbr->select( 'user_former_groups',
2363 array( 'ufg_group' ),
2364 array( 'ufg_user' => $this->mId ),
2365 __METHOD__ );
2366 $this->mFormerGroups = array();
2367 foreach( $res as $row ) {
2368 $this->mFormerGroups[] = $row->ufg_group;
2369 }
2370 }
2371 return $this->mFormerGroups;
2372 }
2373
2374 /**
2375 * Get the user's edit count.
2376 * @return Int
2377 */
2378 public function getEditCount() {
2379 if( $this->getId() ) {
2380 if ( !isset( $this->mEditCount ) ) {
2381 /* Populate the count, if it has not been populated yet */
2382 $this->mEditCount = User::edits( $this->mId );
2383 }
2384 return $this->mEditCount;
2385 } else {
2386 /* nil */
2387 return null;
2388 }
2389 }
2390
2391 /**
2392 * Add the user to the given group.
2393 * This takes immediate effect.
2394 * @param $group String Name of the group to add
2395 */
2396 public function addGroup( $group ) {
2397 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2398 $dbw = wfGetDB( DB_MASTER );
2399 if( $this->getId() ) {
2400 $dbw->insert( 'user_groups',
2401 array(
2402 'ug_user' => $this->getID(),
2403 'ug_group' => $group,
2404 ),
2405 __METHOD__,
2406 array( 'IGNORE' ) );
2407 }
2408 }
2409 $this->loadGroups();
2410 $this->mGroups[] = $group;
2411 $this->mRights = null;
2412
2413 $this->invalidateCache();
2414 }
2415
2416 /**
2417 * Remove the user from the given group.
2418 * This takes immediate effect.
2419 * @param $group String Name of the group to remove
2420 */
2421 public function removeGroup( $group ) {
2422 $this->load();
2423 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2424 $dbw = wfGetDB( DB_MASTER );
2425 $dbw->delete( 'user_groups',
2426 array(
2427 'ug_user' => $this->getID(),
2428 'ug_group' => $group,
2429 ), __METHOD__ );
2430 // Remember that the user was in this group
2431 $dbw->insert( 'user_former_groups',
2432 array(
2433 'ufg_user' => $this->getID(),
2434 'ufg_group' => $group,
2435 ),
2436 __METHOD__,
2437 array( 'IGNORE' ) );
2438 }
2439 $this->loadGroups();
2440 $this->mGroups = array_diff( $this->mGroups, array( $group ) );
2441 $this->mRights = null;
2442
2443 $this->invalidateCache();
2444 }
2445
2446 /**
2447 * Get whether the user is logged in
2448 * @return Bool
2449 */
2450 public function isLoggedIn() {
2451 return $this->getID() != 0;
2452 }
2453
2454 /**
2455 * Get whether the user is anonymous
2456 * @return Bool
2457 */
2458 public function isAnon() {
2459 return !$this->isLoggedIn();
2460 }
2461
2462 /**
2463 * Check if user is allowed to access a feature / make an action
2464 *
2465 * @internal param \String $varargs permissions to test
2466 * @return Boolean: True if user is allowed to perform *any* of the given actions
2467 *
2468 * @return bool
2469 */
2470 public function isAllowedAny( /*...*/ ){
2471 $permissions = func_get_args();
2472 foreach( $permissions as $permission ){
2473 if( $this->isAllowed( $permission ) ){
2474 return true;
2475 }
2476 }
2477 return false;
2478 }
2479
2480 /**
2481 *
2482 * @internal param $varargs string
2483 * @return bool True if the user is allowed to perform *all* of the given actions
2484 */
2485 public function isAllowedAll( /*...*/ ){
2486 $permissions = func_get_args();
2487 foreach( $permissions as $permission ){
2488 if( !$this->isAllowed( $permission ) ){
2489 return false;
2490 }
2491 }
2492 return true;
2493 }
2494
2495 /**
2496 * Internal mechanics of testing a permission
2497 * @param $action String
2498 * @param $ns int|null Namespace optional
2499 * @return bool
2500 */
2501 public function isAllowed( $action = '', $ns = null ) {
2502 if ( $action === '' ) {
2503 return true; // In the spirit of DWIM
2504 }
2505 # Patrolling may not be enabled
2506 if( $action === 'patrol' || $action === 'autopatrol' ) {
2507 global $wgUseRCPatrol, $wgUseNPPatrol;
2508 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2509 return false;
2510 }
2511 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2512 # by misconfiguration: 0 == 'foo'
2513 return in_array( $action, $this->getRights( $ns ), true );
2514 }
2515
2516 /**
2517 * Check whether to enable recent changes patrol features for this user
2518 * @return Boolean: True or false
2519 */
2520 public function useRCPatrol() {
2521 global $wgUseRCPatrol;
2522 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2523 }
2524
2525 /**
2526 * Check whether to enable new pages patrol features for this user
2527 * @return Bool True or false
2528 */
2529 public function useNPPatrol() {
2530 global $wgUseRCPatrol, $wgUseNPPatrol;
2531 return( ( $wgUseRCPatrol || $wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2532 }
2533
2534 /**
2535 * Get the WebRequest object to use with this object
2536 *
2537 * @return WebRequest
2538 */
2539 public function getRequest() {
2540 if ( $this->mRequest ) {
2541 return $this->mRequest;
2542 } else {
2543 global $wgRequest;
2544 return $wgRequest;
2545 }
2546 }
2547
2548 /**
2549 * Get the current skin, loading it if required
2550 * @return Skin The current skin
2551 * @todo FIXME: Need to check the old failback system [AV]
2552 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2553 */
2554 public function getSkin() {
2555 return RequestContext::getMain()->getSkin();
2556 }
2557
2558 /**
2559 * Check the watched status of an article.
2560 * @param $title Title of the article to look at
2561 * @return Bool
2562 */
2563 public function isWatched( $title ) {
2564 $wl = WatchedItem::fromUserTitle( $this, $title );
2565 return $wl->isWatched();
2566 }
2567
2568 /**
2569 * Watch an article.
2570 * @param $title Title of the article to look at
2571 */
2572 public function addWatch( $title ) {
2573 $wl = WatchedItem::fromUserTitle( $this, $title );
2574 $wl->addWatch();
2575 $this->invalidateCache();
2576 }
2577
2578 /**
2579 * Stop watching an article.
2580 * @param $title Title of the article to look at
2581 */
2582 public function removeWatch( $title ) {
2583 $wl = WatchedItem::fromUserTitle( $this, $title );
2584 $wl->removeWatch();
2585 $this->invalidateCache();
2586 }
2587
2588 /**
2589 * Clear the user's notification timestamp for the given title.
2590 * If e-notif e-mails are on, they will receive notification mails on
2591 * the next change of the page if it's watched etc.
2592 * @param $title Title of the article to look at
2593 */
2594 public function clearNotification( &$title ) {
2595 global $wgUseEnotif, $wgShowUpdatedMarker;
2596
2597 # Do nothing if the database is locked to writes
2598 if( wfReadOnly() ) {
2599 return;
2600 }
2601
2602 if( $title->getNamespace() == NS_USER_TALK &&
2603 $title->getText() == $this->getName() ) {
2604 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2605 return;
2606 $this->setNewtalk( false );
2607 }
2608
2609 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2610 return;
2611 }
2612
2613 if( $this->isAnon() ) {
2614 // Nothing else to do...
2615 return;
2616 }
2617
2618 // Only update the timestamp if the page is being watched.
2619 // The query to find out if it is watched is cached both in memcached and per-invocation,
2620 // and when it does have to be executed, it can be on a slave
2621 // If this is the user's newtalk page, we always update the timestamp
2622 if( $title->getNamespace() == NS_USER_TALK &&
2623 $title->getText() == $this->getName() )
2624 {
2625 $watched = true;
2626 } else {
2627 $watched = $this->isWatched( $title );
2628 }
2629
2630 // If the page is watched by the user (or may be watched), update the timestamp on any
2631 // any matching rows
2632 if ( $watched ) {
2633 $dbw = wfGetDB( DB_MASTER );
2634 $dbw->update( 'watchlist',
2635 array( /* SET */
2636 'wl_notificationtimestamp' => null
2637 ), array( /* WHERE */
2638 'wl_title' => $title->getDBkey(),
2639 'wl_namespace' => $title->getNamespace(),
2640 'wl_user' => $this->getID()
2641 ), __METHOD__
2642 );
2643 }
2644 }
2645
2646 /**
2647 * Resets all of the given user's page-change notification timestamps.
2648 * If e-notif e-mails are on, they will receive notification mails on
2649 * the next change of any watched page.
2650 */
2651 public function clearAllNotifications() {
2652 global $wgUseEnotif, $wgShowUpdatedMarker;
2653 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2654 $this->setNewtalk( false );
2655 return;
2656 }
2657 $id = $this->getId();
2658 if( $id != 0 ) {
2659 $dbw = wfGetDB( DB_MASTER );
2660 $dbw->update( 'watchlist',
2661 array( /* SET */
2662 'wl_notificationtimestamp' => null
2663 ), array( /* WHERE */
2664 'wl_user' => $id
2665 ), __METHOD__
2666 );
2667 # We also need to clear here the "you have new message" notification for the own user_talk page
2668 # This is cleared one page view later in Article::viewUpdates();
2669 }
2670 }
2671
2672 /**
2673 * Set this user's options from an encoded string
2674 * @param $str String Encoded options to import
2675 */
2676 public function decodeOptions( $str ) {
2677 if( !$str )
2678 return;
2679
2680 $this->mOptionsLoaded = true;
2681 $this->mOptionOverrides = array();
2682
2683 // If an option is not set in $str, use the default value
2684 $this->mOptions = self::getDefaultOptions();
2685
2686 $a = explode( "\n", $str );
2687 foreach ( $a as $s ) {
2688 $m = array();
2689 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2690 $this->mOptions[$m[1]] = $m[2];
2691 $this->mOptionOverrides[$m[1]] = $m[2];
2692 }
2693 }
2694 }
2695
2696 /**
2697 * Set a cookie on the user's client. Wrapper for
2698 * WebResponse::setCookie
2699 * @param $name String Name of the cookie to set
2700 * @param $value String Value to set
2701 * @param $exp Int Expiration time, as a UNIX time value;
2702 * if 0 or not specified, use the default $wgCookieExpiration
2703 */
2704 protected function setCookie( $name, $value, $exp = 0 ) {
2705 $this->getRequest()->response()->setcookie( $name, $value, $exp );
2706 }
2707
2708 /**
2709 * Clear a cookie on the user's client
2710 * @param $name String Name of the cookie to clear
2711 */
2712 protected function clearCookie( $name ) {
2713 $this->setCookie( $name, '', time() - 86400 );
2714 }
2715
2716 /**
2717 * Set the default cookies for this session on the user's client.
2718 *
2719 * @param $request WebRequest object to use; $wgRequest will be used if null
2720 * is passed.
2721 */
2722 public function setCookies( $request = null ) {
2723 if ( $request === null ) {
2724 $request = $this->getRequest();
2725 }
2726
2727 $this->load();
2728 if ( 0 == $this->mId ) return;
2729 $session = array(
2730 'wsUserID' => $this->mId,
2731 'wsToken' => $this->mToken,
2732 'wsUserName' => $this->getName()
2733 );
2734 $cookies = array(
2735 'UserID' => $this->mId,
2736 'UserName' => $this->getName(),
2737 );
2738 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2739 $cookies['Token'] = $this->mToken;
2740 } else {
2741 $cookies['Token'] = false;
2742 }
2743
2744 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2745
2746 foreach ( $session as $name => $value ) {
2747 $request->setSessionData( $name, $value );
2748 }
2749 foreach ( $cookies as $name => $value ) {
2750 if ( $value === false ) {
2751 $this->clearCookie( $name );
2752 } else {
2753 $this->setCookie( $name, $value );
2754 }
2755 }
2756 }
2757
2758 /**
2759 * Log this user out.
2760 */
2761 public function logout() {
2762 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2763 $this->doLogout();
2764 }
2765 }
2766
2767 /**
2768 * Clear the user's cookies and session, and reset the instance cache.
2769 * @see logout()
2770 */
2771 public function doLogout() {
2772 $this->clearInstanceCache( 'defaults' );
2773
2774 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2775
2776 $this->clearCookie( 'UserID' );
2777 $this->clearCookie( 'Token' );
2778
2779 # Remember when user logged out, to prevent seeing cached pages
2780 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() + 86400 );
2781 }
2782
2783 /**
2784 * Save this user's settings into the database.
2785 * @todo Only rarely do all these fields need to be set!
2786 */
2787 public function saveSettings() {
2788 $this->load();
2789 if ( wfReadOnly() ) { return; }
2790 if ( 0 == $this->mId ) { return; }
2791
2792 $this->mTouched = self::newTouchedTimestamp();
2793
2794 $dbw = wfGetDB( DB_MASTER );
2795 $dbw->update( 'user',
2796 array( /* SET */
2797 'user_name' => $this->mName,
2798 'user_password' => $this->mPassword,
2799 'user_newpassword' => $this->mNewpassword,
2800 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
2801 'user_real_name' => $this->mRealName,
2802 'user_email' => $this->mEmail,
2803 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
2804 'user_options' => '',
2805 'user_touched' => $dbw->timestamp( $this->mTouched ),
2806 'user_token' => $this->mToken,
2807 'user_email_token' => $this->mEmailToken,
2808 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ),
2809 ), array( /* WHERE */
2810 'user_id' => $this->mId
2811 ), __METHOD__
2812 );
2813
2814 $this->saveOptions();
2815
2816 wfRunHooks( 'UserSaveSettings', array( $this ) );
2817 $this->clearSharedCache();
2818 $this->getUserPage()->invalidateCache();
2819 }
2820
2821 /**
2822 * If only this user's username is known, and it exists, return the user ID.
2823 * @return Int
2824 */
2825 public function idForName() {
2826 $s = trim( $this->getName() );
2827 if ( $s === '' ) return 0;
2828
2829 $dbr = wfGetDB( DB_SLAVE );
2830 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__ );
2831 if ( $id === false ) {
2832 $id = 0;
2833 }
2834 return $id;
2835 }
2836
2837 /**
2838 * Add a user to the database, return the user object
2839 *
2840 * @param $name String Username to add
2841 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2842 * - password The user's password hash. Password logins will be disabled if this is omitted.
2843 * - newpassword Hash for a temporary password that has been mailed to the user
2844 * - email The user's email address
2845 * - email_authenticated The email authentication timestamp
2846 * - real_name The user's real name
2847 * - options An associative array of non-default options
2848 * - token Random authentication token. Do not set.
2849 * - registration Registration timestamp. Do not set.
2850 *
2851 * @return User object, or null if the username already exists
2852 */
2853 public static function createNew( $name, $params = array() ) {
2854 $user = new User;
2855 $user->load();
2856 if ( isset( $params['options'] ) ) {
2857 $user->mOptions = $params['options'] + (array)$user->mOptions;
2858 unset( $params['options'] );
2859 }
2860 $dbw = wfGetDB( DB_MASTER );
2861 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2862
2863 $fields = array(
2864 'user_id' => $seqVal,
2865 'user_name' => $name,
2866 'user_password' => $user->mPassword,
2867 'user_newpassword' => $user->mNewpassword,
2868 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime ),
2869 'user_email' => $user->mEmail,
2870 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
2871 'user_real_name' => $user->mRealName,
2872 'user_options' => '',
2873 'user_token' => $user->mToken,
2874 'user_registration' => $dbw->timestamp( $user->mRegistration ),
2875 'user_editcount' => 0,
2876 );
2877 foreach ( $params as $name => $value ) {
2878 $fields["user_$name"] = $value;
2879 }
2880 $dbw->insert( 'user', $fields, __METHOD__, array( 'IGNORE' ) );
2881 if ( $dbw->affectedRows() ) {
2882 $newUser = User::newFromId( $dbw->insertId() );
2883 } else {
2884 $newUser = null;
2885 }
2886 return $newUser;
2887 }
2888
2889 /**
2890 * Add this existing user object to the database
2891 */
2892 public function addToDatabase() {
2893 $this->load();
2894 $dbw = wfGetDB( DB_MASTER );
2895 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2896 $dbw->insert( 'user',
2897 array(
2898 'user_id' => $seqVal,
2899 'user_name' => $this->mName,
2900 'user_password' => $this->mPassword,
2901 'user_newpassword' => $this->mNewpassword,
2902 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
2903 'user_email' => $this->mEmail,
2904 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
2905 'user_real_name' => $this->mRealName,
2906 'user_options' => '',
2907 'user_token' => $this->mToken,
2908 'user_registration' => $dbw->timestamp( $this->mRegistration ),
2909 'user_editcount' => 0,
2910 ), __METHOD__
2911 );
2912 $this->mId = $dbw->insertId();
2913
2914 // Clear instance cache other than user table data, which is already accurate
2915 $this->clearInstanceCache();
2916
2917 $this->saveOptions();
2918 }
2919
2920 /**
2921 * If this (non-anonymous) user is blocked, block any IP address
2922 * they've successfully logged in from.
2923 */
2924 public function spreadBlock() {
2925 wfDebug( __METHOD__ . "()\n" );
2926 $this->load();
2927 if ( $this->mId == 0 ) {
2928 return;
2929 }
2930
2931 $userblock = Block::newFromTarget( $this->getName() );
2932 if ( !$userblock ) {
2933 return;
2934 }
2935
2936 $userblock->doAutoblock( wfGetIP() );
2937 }
2938
2939 /**
2940 * Generate a string which will be different for any combination of
2941 * user options which would produce different parser output.
2942 * This will be used as part of the hash key for the parser cache,
2943 * so users with the same options can share the same cached data
2944 * safely.
2945 *
2946 * Extensions which require it should install 'PageRenderingHash' hook,
2947 * which will give them a chance to modify this key based on their own
2948 * settings.
2949 *
2950 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
2951 * @return String Page rendering hash
2952 */
2953 public function getPageRenderingHash() {
2954 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2955 if( $this->mHash ){
2956 return $this->mHash;
2957 }
2958 wfDeprecated( __METHOD__ );
2959
2960 // stubthreshold is only included below for completeness,
2961 // since it disables the parser cache, its value will always
2962 // be 0 when this function is called by parsercache.
2963
2964 $confstr = $this->getOption( 'math' );
2965 $confstr .= '!' . $this->getStubThreshold();
2966 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
2967 $confstr .= '!' . $this->getDatePreference();
2968 }
2969 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ? '1' : '' );
2970 $confstr .= '!' . $wgLang->getCode();
2971 $confstr .= '!' . $this->getOption( 'thumbsize' );
2972 // add in language specific options, if any
2973 $extra = $wgContLang->getExtraHashOptions();
2974 $confstr .= $extra;
2975
2976 // Since the skin could be overloading link(), it should be
2977 // included here but in practice, none of our skins do that.
2978
2979 $confstr .= $wgRenderHashAppend;
2980
2981 // Give a chance for extensions to modify the hash, if they have
2982 // extra options or other effects on the parser cache.
2983 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2984
2985 // Make it a valid memcached key fragment
2986 $confstr = str_replace( ' ', '_', $confstr );
2987 $this->mHash = $confstr;
2988 return $confstr;
2989 }
2990
2991 /**
2992 * Get whether the user is explicitly blocked from account creation.
2993 * @return Bool|Block
2994 */
2995 public function isBlockedFromCreateAccount() {
2996 $this->getBlockedStatus();
2997 if( $this->mBlock && $this->mBlock->prevents( 'createaccount' ) ){
2998 return $this->mBlock;
2999 }
3000
3001 # bug 13611: if the IP address the user is trying to create an account from is
3002 # blocked with createaccount disabled, prevent new account creation there even
3003 # when the user is logged in
3004 if( $this->mBlockedFromCreateAccount === false ){
3005 $this->mBlockedFromCreateAccount = Block::newFromTarget( null, wfGetIP() );
3006 }
3007 return $this->mBlockedFromCreateAccount instanceof Block && $this->mBlockedFromCreateAccount->prevents( 'createaccount' )
3008 ? $this->mBlockedFromCreateAccount
3009 : false;
3010 }
3011
3012 /**
3013 * Get whether the user is blocked from using Special:Emailuser.
3014 * @return Bool
3015 */
3016 public function isBlockedFromEmailuser() {
3017 $this->getBlockedStatus();
3018 return $this->mBlock && $this->mBlock->prevents( 'sendemail' );
3019 }
3020
3021 /**
3022 * Get whether the user is allowed to create an account.
3023 * @return Bool
3024 */
3025 function isAllowedToCreateAccount() {
3026 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3027 }
3028
3029 /**
3030 * Get this user's personal page title.
3031 *
3032 * @return Title: User's personal page title
3033 */
3034 public function getUserPage() {
3035 return Title::makeTitle( NS_USER, $this->getName() );
3036 }
3037
3038 /**
3039 * Get this user's talk page title.
3040 *
3041 * @return Title: User's talk page title
3042 */
3043 public function getTalkPage() {
3044 $title = $this->getUserPage();
3045 return $title->getTalkPage();
3046 }
3047
3048 /**
3049 * Determine whether the user is a newbie. Newbies are either
3050 * anonymous IPs, or the most recently created accounts.
3051 * @return Bool
3052 */
3053 public function isNewbie() {
3054 return !$this->isAllowed( 'autoconfirmed' );
3055 }
3056
3057 /**
3058 * Check to see if the given clear-text password is one of the accepted passwords
3059 * @param $password String: user password.
3060 * @return Boolean: True if the given password is correct, otherwise False.
3061 */
3062 public function checkPassword( $password ) {
3063 global $wgAuth, $wgLegacyEncoding;
3064 $this->load();
3065
3066 // Even though we stop people from creating passwords that
3067 // are shorter than this, doesn't mean people wont be able
3068 // to. Certain authentication plugins do NOT want to save
3069 // domain passwords in a mysql database, so we should
3070 // check this (in case $wgAuth->strict() is false).
3071 if( !$this->isValidPassword( $password ) ) {
3072 return false;
3073 }
3074
3075 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3076 return true;
3077 } elseif( $wgAuth->strict() ) {
3078 /* Auth plugin doesn't allow local authentication */
3079 return false;
3080 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3081 /* Auth plugin doesn't allow local authentication for this user name */
3082 return false;
3083 }
3084 if ( self::comparePasswords( $this->mPassword, $password, $this->mId ) ) {
3085 return true;
3086 } elseif ( $wgLegacyEncoding ) {
3087 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3088 # Check for this with iconv
3089 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3090 if ( $cp1252Password != $password &&
3091 self::comparePasswords( $this->mPassword, $cp1252Password, $this->mId ) )
3092 {
3093 return true;
3094 }
3095 }
3096 return false;
3097 }
3098
3099 /**
3100 * Check if the given clear-text password matches the temporary password
3101 * sent by e-mail for password reset operations.
3102 *
3103 * @param $plaintext string
3104 *
3105 * @return Boolean: True if matches, false otherwise
3106 */
3107 public function checkTemporaryPassword( $plaintext ) {
3108 global $wgNewPasswordExpiry;
3109
3110 $this->load();
3111 if( self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() ) ) {
3112 if ( is_null( $this->mNewpassTime ) ) {
3113 return true;
3114 }
3115 $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgNewPasswordExpiry;
3116 return ( time() < $expiry );
3117 } else {
3118 return false;
3119 }
3120 }
3121
3122 /**
3123 * Initialize (if necessary) and return a session token value
3124 * which can be used in edit forms to show that the user's
3125 * login credentials aren't being hijacked with a foreign form
3126 * submission.
3127 *
3128 * @param $salt String|Array of Strings Optional function-specific data for hashing
3129 * @param $request WebRequest object to use or null to use $wgRequest
3130 * @return String The new edit token
3131 */
3132 public function editToken( $salt = '', $request = null ) {
3133 if ( $request == null ) {
3134 $request = $this->getRequest();
3135 }
3136
3137 if ( $this->isAnon() ) {
3138 return EDIT_TOKEN_SUFFIX;
3139 } else {
3140 $token = $request->getSessionData( 'wsEditToken' );
3141 if ( $token === null ) {
3142 $token = self::generateToken();
3143 $request->setSessionData( 'wsEditToken', $token );
3144 }
3145 if( is_array( $salt ) ) {
3146 $salt = implode( '|', $salt );
3147 }
3148 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX;
3149 }
3150 }
3151
3152 /**
3153 * Generate a looking random token for various uses.
3154 *
3155 * @param $salt String Optional salt value
3156 * @return String The new random token
3157 */
3158 public static function generateToken( $salt = '' ) {
3159 $token = dechex( mt_rand() ) . dechex( mt_rand() );
3160 return md5( $token . $salt );
3161 }
3162
3163 /**
3164 * Check given value against the token value stored in the session.
3165 * A match should confirm that the form was submitted from the
3166 * user's own login session, not a form submission from a third-party
3167 * site.
3168 *
3169 * @param $val String Input value to compare
3170 * @param $salt String Optional function-specific data for hashing
3171 * @param $request WebRequest object to use or null to use $wgRequest
3172 * @return Boolean: Whether the token matches
3173 */
3174 public function matchEditToken( $val, $salt = '', $request = null ) {
3175 $sessionToken = $this->editToken( $salt, $request );
3176 if ( $val != $sessionToken ) {
3177 wfDebug( "User::matchEditToken: broken session data\n" );
3178 }
3179 return $val == $sessionToken;
3180 }
3181
3182 /**
3183 * Check given value against the token value stored in the session,
3184 * ignoring the suffix.
3185 *
3186 * @param $val String Input value to compare
3187 * @param $salt String Optional function-specific data for hashing
3188 * @param $request WebRequest object to use or null to use $wgRequest
3189 * @return Boolean: Whether the token matches
3190 */
3191 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3192 $sessionToken = $this->editToken( $salt, $request );
3193 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3194 }
3195
3196 /**
3197 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3198 * mail to the user's given address.
3199 *
3200 * @param $type String: message to send, either "created", "changed" or "set"
3201 * @return Status object
3202 */
3203 public function sendConfirmationMail( $type = 'created' ) {
3204 global $wgLang;
3205 $expiration = null; // gets passed-by-ref and defined in next line.
3206 $token = $this->confirmationToken( $expiration );
3207 $url = $this->confirmationTokenUrl( $token );
3208 $invalidateURL = $this->invalidationTokenUrl( $token );
3209 $this->saveSettings();
3210
3211 if ( $type == 'created' || $type === false ) {
3212 $message = 'confirmemail_body';
3213 } elseif ( $type === true ) {
3214 $message = 'confirmemail_body_changed';
3215 } else {
3216 $message = 'confirmemail_body_' . $type;
3217 }
3218
3219 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3220 wfMsg( $message,
3221 wfGetIP(),
3222 $this->getName(),
3223 $url,
3224 $wgLang->timeanddate( $expiration, false ),
3225 $invalidateURL,
3226 $wgLang->date( $expiration, false ),
3227 $wgLang->time( $expiration, false ) ) );
3228 }
3229
3230 /**
3231 * Send an e-mail to this user's account. Does not check for
3232 * confirmed status or validity.
3233 *
3234 * @param $subject String Message subject
3235 * @param $body String Message body
3236 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3237 * @param $replyto String Reply-To address
3238 * @return Status
3239 */
3240 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3241 if( is_null( $from ) ) {
3242 global $wgPasswordSender, $wgPasswordSenderName;
3243 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3244 } else {
3245 $sender = new MailAddress( $from );
3246 }
3247
3248 $to = new MailAddress( $this );
3249 return UserMailer::send( $to, $sender, $subject, $body, $replyto );
3250 }
3251
3252 /**
3253 * Generate, store, and return a new e-mail confirmation code.
3254 * A hash (unsalted, since it's used as a key) is stored.
3255 *
3256 * @note Call saveSettings() after calling this function to commit
3257 * this change to the database.
3258 *
3259 * @param &$expiration \mixed Accepts the expiration time
3260 * @return String New token
3261 */
3262 private function confirmationToken( &$expiration ) {
3263 global $wgUserEmailConfirmationTokenExpiry;
3264 $now = time();
3265 $expires = $now + $wgUserEmailConfirmationTokenExpiry;
3266 $expiration = wfTimestamp( TS_MW, $expires );
3267 $token = self::generateToken( $this->mId . $this->mEmail . $expires );
3268 $hash = md5( $token );
3269 $this->load();
3270 $this->mEmailToken = $hash;
3271 $this->mEmailTokenExpires = $expiration;
3272 return $token;
3273 }
3274
3275 /**
3276 * Return a URL the user can use to confirm their email address.
3277 * @param $token String Accepts the email confirmation token
3278 * @return String New token URL
3279 */
3280 private function confirmationTokenUrl( $token ) {
3281 return $this->getTokenUrl( 'ConfirmEmail', $token );
3282 }
3283
3284 /**
3285 * Return a URL the user can use to invalidate their email address.
3286 * @param $token String Accepts the email confirmation token
3287 * @return String New token URL
3288 */
3289 private function invalidationTokenUrl( $token ) {
3290 return $this->getTokenUrl( 'Invalidateemail', $token );
3291 }
3292
3293 /**
3294 * Internal function to format the e-mail validation/invalidation URLs.
3295 * This uses $wgArticlePath directly as a quickie hack to use the
3296 * hardcoded English names of the Special: pages, for ASCII safety.
3297 *
3298 * @note Since these URLs get dropped directly into emails, using the
3299 * short English names avoids insanely long URL-encoded links, which
3300 * also sometimes can get corrupted in some browsers/mailers
3301 * (bug 6957 with Gmail and Internet Explorer).
3302 *
3303 * @param $page String Special page
3304 * @param $token String Token
3305 * @return String Formatted URL
3306 */
3307 protected function getTokenUrl( $page, $token ) {
3308 global $wgArticlePath;
3309 return wfExpandUrl(
3310 str_replace(
3311 '$1',
3312 "Special:$page/$token",
3313 $wgArticlePath ) );
3314 }
3315
3316 /**
3317 * Mark the e-mail address confirmed.
3318 *
3319 * @note Call saveSettings() after calling this function to commit the change.
3320 *
3321 * @return true
3322 */
3323 public function confirmEmail() {
3324 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3325 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3326 return true;
3327 }
3328
3329 /**
3330 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3331 * address if it was already confirmed.
3332 *
3333 * @note Call saveSettings() after calling this function to commit the change.
3334 * @return true
3335 */
3336 function invalidateEmail() {
3337 $this->load();
3338 $this->mEmailToken = null;
3339 $this->mEmailTokenExpires = null;
3340 $this->setEmailAuthenticationTimestamp( null );
3341 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3342 return true;
3343 }
3344
3345 /**
3346 * Set the e-mail authentication timestamp.
3347 * @param $timestamp String TS_MW timestamp
3348 */
3349 function setEmailAuthenticationTimestamp( $timestamp ) {
3350 $this->load();
3351 $this->mEmailAuthenticated = $timestamp;
3352 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
3353 }
3354
3355 /**
3356 * Is this user allowed to send e-mails within limits of current
3357 * site configuration?
3358 * @return Bool
3359 */
3360 public function canSendEmail() {
3361 global $wgEnableEmail, $wgEnableUserEmail;
3362 if( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
3363 return false;
3364 }
3365 $canSend = $this->isEmailConfirmed();
3366 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3367 return $canSend;
3368 }
3369
3370 /**
3371 * Is this user allowed to receive e-mails within limits of current
3372 * site configuration?
3373 * @return Bool
3374 */
3375 public function canReceiveEmail() {
3376 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3377 }
3378
3379 /**
3380 * Is this user's e-mail address valid-looking and confirmed within
3381 * limits of the current site configuration?
3382 *
3383 * @note If $wgEmailAuthentication is on, this may require the user to have
3384 * confirmed their address by returning a code or using a password
3385 * sent to the address from the wiki.
3386 *
3387 * @return Bool
3388 */
3389 public function isEmailConfirmed() {
3390 global $wgEmailAuthentication;
3391 $this->load();
3392 $confirmed = true;
3393 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3394 if( $this->isAnon() ) {
3395 return false;
3396 }
3397 if( !Sanitizer::validateEmail( $this->mEmail ) ) {
3398 return false;
3399 }
3400 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3401 return false;
3402 }
3403 return true;
3404 } else {
3405 return $confirmed;
3406 }
3407 }
3408
3409 /**
3410 * Check whether there is an outstanding request for e-mail confirmation.
3411 * @return Bool
3412 */
3413 public function isEmailConfirmationPending() {
3414 global $wgEmailAuthentication;
3415 return $wgEmailAuthentication &&
3416 !$this->isEmailConfirmed() &&
3417 $this->mEmailToken &&
3418 $this->mEmailTokenExpires > wfTimestamp();
3419 }
3420
3421 /**
3422 * Get the timestamp of account creation.
3423 *
3424 * @return String|Bool Timestamp of account creation, or false for
3425 * non-existent/anonymous user accounts.
3426 */
3427 public function getRegistration() {
3428 if ( $this->isAnon() ) {
3429 return false;
3430 }
3431 $this->load();
3432 return $this->mRegistration;
3433 }
3434
3435 /**
3436 * Get the timestamp of the first edit
3437 *
3438 * @return String|Bool Timestamp of first edit, or false for
3439 * non-existent/anonymous user accounts.
3440 */
3441 public function getFirstEditTimestamp() {
3442 if( $this->getId() == 0 ) {
3443 return false; // anons
3444 }
3445 $dbr = wfGetDB( DB_SLAVE );
3446 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3447 array( 'rev_user' => $this->getId() ),
3448 __METHOD__,
3449 array( 'ORDER BY' => 'rev_timestamp ASC' )
3450 );
3451 if( !$time ) {
3452 return false; // no edits
3453 }
3454 return wfTimestamp( TS_MW, $time );
3455 }
3456
3457 /**
3458 * Get the permissions associated with a given list of groups
3459 *
3460 * @param $groups Array of Strings List of internal group names
3461 * @param $ns int
3462 *
3463 * @return Array of Strings List of permission key names for given groups combined
3464 */
3465 public static function getGroupPermissions( $groups, $ns = null ) {
3466 global $wgGroupPermissions, $wgRevokePermissions;
3467 $rights = array();
3468
3469 // Grant every granted permission first
3470 foreach( $groups as $group ) {
3471 if( isset( $wgGroupPermissions[$group] ) ) {
3472 $rights = array_merge( $rights, self::extractRights(
3473 $wgGroupPermissions[$group], $ns ) );
3474 }
3475 }
3476
3477 // Revoke the revoked permissions
3478 foreach( $groups as $group ) {
3479 if( isset( $wgRevokePermissions[$group] ) ) {
3480 $rights = array_diff( $rights, self::extractRights(
3481 $wgRevokePermissions[$group], $ns ) );
3482 }
3483 }
3484 return array_unique( $rights );
3485 }
3486
3487 /**
3488 * Helper for User::getGroupPermissions
3489 * @param $list array
3490 * @param $ns int
3491 * @return array
3492 */
3493 private static function extractRights( $list, $ns ) {
3494 $rights = array();
3495 foreach( $list as $right => $value ) {
3496 if ( is_array( $value ) ) {
3497 # This is a list of namespaces where the permission applies
3498 if ( !is_null( $ns ) && !empty( $value[$ns] ) ) {
3499 $rights[] = $right;
3500 }
3501 } else {
3502 # This is a boolean indicating that the permission applies
3503 if ( $value ) {
3504 $rights[] = $right;
3505 }
3506 }
3507 }
3508 return $rights;
3509 }
3510
3511 /**
3512 * Get all the groups who have a given permission
3513 *
3514 * @param $role String Role to check
3515 * @param $ns int
3516 *
3517 *
3518 * @return Array of Strings List of internal group names with the given permission
3519 */
3520 public static function getGroupsWithPermission( $role, $ns = null ) {
3521 global $wgGroupPermissions;
3522 $allowedGroups = array();
3523 foreach ( $wgGroupPermissions as $group => $rights ) {
3524 if ( in_array( $role, self::getGroupPermissions( array( $group ), $ns ), true ) ) {
3525 $allowedGroups[] = $group;
3526 }
3527 }
3528 return $allowedGroups;
3529 }
3530
3531 /**
3532 * Get the localized descriptive name for a group, if it exists
3533 *
3534 * @param $group String Internal group name
3535 * @return String Localized descriptive group name
3536 */
3537 public static function getGroupName( $group ) {
3538 $msg = wfMessage( "group-$group" );
3539 return $msg->isBlank() ? $group : $msg->text();
3540 }
3541
3542 /**
3543 * Get the localized descriptive name for a member of a group, if it exists
3544 *
3545 * @param $group String Internal group name
3546 * @return String Localized name for group member
3547 */
3548 public static function getGroupMember( $group ) {
3549 $msg = wfMessage( "group-$group-member" );
3550 return $msg->isBlank() ? $group : $msg->text();
3551 }
3552
3553 /**
3554 * Return the set of defined explicit groups.
3555 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3556 * are not included, as they are defined automatically, not in the database.
3557 * @return Array of internal group names
3558 */
3559 public static function getAllGroups() {
3560 global $wgGroupPermissions, $wgRevokePermissions;
3561 return array_diff(
3562 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3563 self::getImplicitGroups()
3564 );
3565 }
3566
3567 /**
3568 * Get a list of all available permissions.
3569 * @return Array of permission names
3570 */
3571 public static function getAllRights() {
3572 if ( self::$mAllRights === false ) {
3573 global $wgAvailableRights;
3574 if ( count( $wgAvailableRights ) ) {
3575 self::$mAllRights = array_unique( array_merge( self::$mCoreRights, $wgAvailableRights ) );
3576 } else {
3577 self::$mAllRights = self::$mCoreRights;
3578 }
3579 wfRunHooks( 'UserGetAllRights', array( &self::$mAllRights ) );
3580 }
3581 return self::$mAllRights;
3582 }
3583
3584 /**
3585 * Get a list of implicit groups
3586 * @return Array of Strings Array of internal group names
3587 */
3588 public static function getImplicitGroups() {
3589 global $wgImplicitGroups;
3590 $groups = $wgImplicitGroups;
3591 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3592 return $groups;
3593 }
3594
3595 /**
3596 * Get the title of a page describing a particular group
3597 *
3598 * @param $group String Internal group name
3599 * @return Title|Bool Title of the page if it exists, false otherwise
3600 */
3601 public static function getGroupPage( $group ) {
3602 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3603 if( $msg->exists() ) {
3604 $title = Title::newFromText( $msg->text() );
3605 if( is_object( $title ) )
3606 return $title;
3607 }
3608 return false;
3609 }
3610
3611 /**
3612 * Create a link to the group in HTML, if available;
3613 * else return the group name.
3614 *
3615 * @param $group String Internal name of the group
3616 * @param $text String The text of the link
3617 * @return String HTML link to the group
3618 */
3619 public static function makeGroupLinkHTML( $group, $text = '' ) {
3620 if( $text == '' ) {
3621 $text = self::getGroupName( $group );
3622 }
3623 $title = self::getGroupPage( $group );
3624 if( $title ) {
3625 return Linker::link( $title, htmlspecialchars( $text ) );
3626 } else {
3627 return $text;
3628 }
3629 }
3630
3631 /**
3632 * Create a link to the group in Wikitext, if available;
3633 * else return the group name.
3634 *
3635 * @param $group String Internal name of the group
3636 * @param $text String The text of the link
3637 * @return String Wikilink to the group
3638 */
3639 public static function makeGroupLinkWiki( $group, $text = '' ) {
3640 if( $text == '' ) {
3641 $text = self::getGroupName( $group );
3642 }
3643 $title = self::getGroupPage( $group );
3644 if( $title ) {
3645 $page = $title->getPrefixedText();
3646 return "[[$page|$text]]";
3647 } else {
3648 return $text;
3649 }
3650 }
3651
3652 /**
3653 * Returns an array of the groups that a particular group can add/remove.
3654 *
3655 * @param $group String: the group to check for whether it can add/remove
3656 * @return Array array( 'add' => array( addablegroups ),
3657 * 'remove' => array( removablegroups ),
3658 * 'add-self' => array( addablegroups to self),
3659 * 'remove-self' => array( removable groups from self) )
3660 */
3661 public static function changeableByGroup( $group ) {
3662 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3663
3664 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3665 if( empty( $wgAddGroups[$group] ) ) {
3666 // Don't add anything to $groups
3667 } elseif( $wgAddGroups[$group] === true ) {
3668 // You get everything
3669 $groups['add'] = self::getAllGroups();
3670 } elseif( is_array( $wgAddGroups[$group] ) ) {
3671 $groups['add'] = $wgAddGroups[$group];
3672 }
3673
3674 // Same thing for remove
3675 if( empty( $wgRemoveGroups[$group] ) ) {
3676 } elseif( $wgRemoveGroups[$group] === true ) {
3677 $groups['remove'] = self::getAllGroups();
3678 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3679 $groups['remove'] = $wgRemoveGroups[$group];
3680 }
3681
3682 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3683 if( empty( $wgGroupsAddToSelf['user']) || $wgGroupsAddToSelf['user'] !== true ) {
3684 foreach( $wgGroupsAddToSelf as $key => $value ) {
3685 if( is_int( $key ) ) {
3686 $wgGroupsAddToSelf['user'][] = $value;
3687 }
3688 }
3689 }
3690
3691 if( empty( $wgGroupsRemoveFromSelf['user']) || $wgGroupsRemoveFromSelf['user'] !== true ) {
3692 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3693 if( is_int( $key ) ) {
3694 $wgGroupsRemoveFromSelf['user'][] = $value;
3695 }
3696 }
3697 }
3698
3699 // Now figure out what groups the user can add to him/herself
3700 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3701 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3702 // No idea WHY this would be used, but it's there
3703 $groups['add-self'] = User::getAllGroups();
3704 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3705 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3706 }
3707
3708 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3709 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3710 $groups['remove-self'] = User::getAllGroups();
3711 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3712 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3713 }
3714
3715 return $groups;
3716 }
3717
3718 /**
3719 * Returns an array of groups that this user can add and remove
3720 * @return Array array( 'add' => array( addablegroups ),
3721 * 'remove' => array( removablegroups ),
3722 * 'add-self' => array( addablegroups to self),
3723 * 'remove-self' => array( removable groups from self) )
3724 */
3725 public function changeableGroups() {
3726 if( $this->isAllowed( 'userrights' ) ) {
3727 // This group gives the right to modify everything (reverse-
3728 // compatibility with old "userrights lets you change
3729 // everything")
3730 // Using array_merge to make the groups reindexed
3731 $all = array_merge( User::getAllGroups() );
3732 return array(
3733 'add' => $all,
3734 'remove' => $all,
3735 'add-self' => array(),
3736 'remove-self' => array()
3737 );
3738 }
3739
3740 // Okay, it's not so simple, we will have to go through the arrays
3741 $groups = array(
3742 'add' => array(),
3743 'remove' => array(),
3744 'add-self' => array(),
3745 'remove-self' => array()
3746 );
3747 $addergroups = $this->getEffectiveGroups();
3748
3749 foreach( $addergroups as $addergroup ) {
3750 $groups = array_merge_recursive(
3751 $groups, $this->changeableByGroup( $addergroup )
3752 );
3753 $groups['add'] = array_unique( $groups['add'] );
3754 $groups['remove'] = array_unique( $groups['remove'] );
3755 $groups['add-self'] = array_unique( $groups['add-self'] );
3756 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3757 }
3758 return $groups;
3759 }
3760
3761 /**
3762 * Increment the user's edit-count field.
3763 * Will have no effect for anonymous users.
3764 */
3765 public function incEditCount() {
3766 if( !$this->isAnon() ) {
3767 $dbw = wfGetDB( DB_MASTER );
3768 $dbw->update( 'user',
3769 array( 'user_editcount=user_editcount+1' ),
3770 array( 'user_id' => $this->getId() ),
3771 __METHOD__ );
3772
3773 // Lazy initialization check...
3774 if( $dbw->affectedRows() == 0 ) {
3775 // Pull from a slave to be less cruel to servers
3776 // Accuracy isn't the point anyway here
3777 $dbr = wfGetDB( DB_SLAVE );
3778 $count = $dbr->selectField( 'revision',
3779 'COUNT(rev_user)',
3780 array( 'rev_user' => $this->getId() ),
3781 __METHOD__ );
3782
3783 // Now here's a goddamn hack...
3784 if( $dbr !== $dbw ) {
3785 // If we actually have a slave server, the count is
3786 // at least one behind because the current transaction
3787 // has not been committed and replicated.
3788 $count++;
3789 } else {
3790 // But if DB_SLAVE is selecting the master, then the
3791 // count we just read includes the revision that was
3792 // just added in the working transaction.
3793 }
3794
3795 $dbw->update( 'user',
3796 array( 'user_editcount' => $count ),
3797 array( 'user_id' => $this->getId() ),
3798 __METHOD__ );
3799 }
3800 }
3801 // edit count in user cache too
3802 $this->invalidateCache();
3803 }
3804
3805 /**
3806 * Get the description of a given right
3807 *
3808 * @param $right String Right to query
3809 * @return String Localized description of the right
3810 */
3811 public static function getRightDescription( $right ) {
3812 $key = "right-$right";
3813 $msg = wfMessage( $key );
3814 return $msg->isBlank() ? $right : $msg->text();
3815 }
3816
3817 /**
3818 * Make an old-style password hash
3819 *
3820 * @param $password String Plain-text password
3821 * @param $userId String User ID
3822 * @return String Password hash
3823 */
3824 public static function oldCrypt( $password, $userId ) {
3825 global $wgPasswordSalt;
3826 if ( $wgPasswordSalt ) {
3827 return md5( $userId . '-' . md5( $password ) );
3828 } else {
3829 return md5( $password );
3830 }
3831 }
3832
3833 /**
3834 * Make a new-style password hash
3835 *
3836 * @param $password String Plain-text password
3837 * @param bool|string $salt Optional salt, may be random or the user ID.
3838
3839 * If unspecified or false, will generate one automatically
3840 * @return String Password hash
3841 */
3842 public static function crypt( $password, $salt = false ) {
3843 global $wgPasswordSalt;
3844
3845 $hash = '';
3846 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3847 return $hash;
3848 }
3849
3850 if( $wgPasswordSalt ) {
3851 if ( $salt === false ) {
3852 $salt = substr( wfGenerateToken(), 0, 8 );
3853 }
3854 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3855 } else {
3856 return ':A:' . md5( $password );
3857 }
3858 }
3859
3860 /**
3861 * Compare a password hash with a plain-text password. Requires the user
3862 * ID if there's a chance that the hash is an old-style hash.
3863 *
3864 * @param $hash String Password hash
3865 * @param $password String Plain-text password to compare
3866 * @param $userId String|bool User ID for old-style password salt
3867 *
3868 * @return Boolean
3869 */
3870 public static function comparePasswords( $hash, $password, $userId = false ) {
3871 $type = substr( $hash, 0, 3 );
3872
3873 $result = false;
3874 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3875 return $result;
3876 }
3877
3878 if ( $type == ':A:' ) {
3879 # Unsalted
3880 return md5( $password ) === substr( $hash, 3 );
3881 } elseif ( $type == ':B:' ) {
3882 # Salted
3883 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3884 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3885 } else {
3886 # Old-style
3887 return self::oldCrypt( $password, $userId ) === $hash;
3888 }
3889 }
3890
3891 /**
3892 * Add a newuser log entry for this user
3893 *
3894 * @param $byEmail Boolean: account made by email?
3895 * @param $reason String: user supplied reason
3896 *
3897 * @return true
3898 */
3899 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3900 global $wgUser, $wgContLang, $wgNewUserLog;
3901 if( empty( $wgNewUserLog ) ) {
3902 return true; // disabled
3903 }
3904
3905 if( $this->getName() == $wgUser->getName() ) {
3906 $action = 'create';
3907 } else {
3908 $action = 'create2';
3909 if ( $byEmail ) {
3910 if ( $reason === '' ) {
3911 $reason = wfMsgForContent( 'newuserlog-byemail' );
3912 } else {
3913 $reason = $wgContLang->commaList( array(
3914 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3915 }
3916 }
3917 }
3918 $log = new LogPage( 'newusers' );
3919 $log->addEntry(
3920 $action,
3921 $this->getUserPage(),
3922 $reason,
3923 array( $this->getId() )
3924 );
3925 return true;
3926 }
3927
3928 /**
3929 * Add an autocreate newuser log entry for this user
3930 * Used by things like CentralAuth and perhaps other authplugins.
3931 *
3932 * @return true
3933 */
3934 public function addNewUserLogEntryAutoCreate() {
3935 global $wgNewUserLog;
3936 if( !$wgNewUserLog ) {
3937 return true; // disabled
3938 }
3939 $log = new LogPage( 'newusers', false );
3940 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3941 return true;
3942 }
3943
3944 /**
3945 * @todo document
3946 */
3947 protected function loadOptions() {
3948 $this->load();
3949 if ( $this->mOptionsLoaded || !$this->getId() )
3950 return;
3951
3952 $this->mOptions = self::getDefaultOptions();
3953
3954 // Maybe load from the object
3955 if ( !is_null( $this->mOptionOverrides ) ) {
3956 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
3957 foreach( $this->mOptionOverrides as $key => $value ) {
3958 $this->mOptions[$key] = $value;
3959 }
3960 } else {
3961 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
3962 // Load from database
3963 $dbr = wfGetDB( DB_SLAVE );
3964
3965 $res = $dbr->select(
3966 'user_properties',
3967 '*',
3968 array( 'up_user' => $this->getId() ),
3969 __METHOD__
3970 );
3971
3972 foreach ( $res as $row ) {
3973 $this->mOptionOverrides[$row->up_property] = $row->up_value;
3974 $this->mOptions[$row->up_property] = $row->up_value;
3975 }
3976 }
3977
3978 $this->mOptionsLoaded = true;
3979
3980 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions ) );
3981 }
3982
3983 /**
3984 * @todo document
3985 */
3986 protected function saveOptions() {
3987 global $wgAllowPrefChange;
3988
3989 $extuser = ExternalUser::newFromUser( $this );
3990
3991 $this->loadOptions();
3992 $dbw = wfGetDB( DB_MASTER );
3993
3994 $insert_rows = array();
3995
3996 $saveOptions = $this->mOptions;
3997
3998 // Allow hooks to abort, for instance to save to a global profile.
3999 // Reset options to default state before saving.
4000 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4001 return;
4002 }
4003
4004 foreach( $saveOptions as $key => $value ) {
4005 # Don't bother storing default values
4006 if ( ( is_null( self::getDefaultOption( $key ) ) &&
4007 !( $value === false || is_null($value) ) ) ||
4008 $value != self::getDefaultOption( $key ) ) {
4009 $insert_rows[] = array(
4010 'up_user' => $this->getId(),
4011 'up_property' => $key,
4012 'up_value' => $value,
4013 );
4014 }
4015 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4016 switch ( $wgAllowPrefChange[$key] ) {
4017 case 'local':
4018 case 'message':
4019 break;
4020 case 'semiglobal':
4021 case 'global':
4022 $extuser->setPref( $key, $value );
4023 }
4024 }
4025 }
4026
4027 $dbw->begin();
4028 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__ );
4029 $dbw->insert( 'user_properties', $insert_rows, __METHOD__ );
4030 $dbw->commit();
4031 }
4032
4033 /**
4034 * Provide an array of HTML5 attributes to put on an input element
4035 * intended for the user to enter a new password. This may include
4036 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4037 *
4038 * Do *not* use this when asking the user to enter his current password!
4039 * Regardless of configuration, users may have invalid passwords for whatever
4040 * reason (e.g., they were set before requirements were tightened up).
4041 * Only use it when asking for a new password, like on account creation or
4042 * ResetPass.
4043 *
4044 * Obviously, you still need to do server-side checking.
4045 *
4046 * NOTE: A combination of bugs in various browsers means that this function
4047 * actually just returns array() unconditionally at the moment. May as
4048 * well keep it around for when the browser bugs get fixed, though.
4049 *
4050 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4051 *
4052 * @return array Array of HTML attributes suitable for feeding to
4053 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4054 * That will potentially output invalid XHTML 1.0 Transitional, and will
4055 * get confused by the boolean attribute syntax used.)
4056 */
4057 public static function passwordChangeInputAttribs() {
4058 global $wgMinimalPasswordLength;
4059
4060 if ( $wgMinimalPasswordLength == 0 ) {
4061 return array();
4062 }
4063
4064 # Note that the pattern requirement will always be satisfied if the
4065 # input is empty, so we need required in all cases.
4066 #
4067 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4068 # if e-mail confirmation is being used. Since HTML5 input validation
4069 # is b0rked anyway in some browsers, just return nothing. When it's
4070 # re-enabled, fix this code to not output required for e-mail
4071 # registration.
4072 #$ret = array( 'required' );
4073 $ret = array();
4074
4075 # We can't actually do this right now, because Opera 9.6 will print out
4076 # the entered password visibly in its error message! When other
4077 # browsers add support for this attribute, or Opera fixes its support,
4078 # we can add support with a version check to avoid doing this on Opera
4079 # versions where it will be a problem. Reported to Opera as
4080 # DSK-262266, but they don't have a public bug tracker for us to follow.
4081 /*
4082 if ( $wgMinimalPasswordLength > 1 ) {
4083 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4084 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
4085 $wgMinimalPasswordLength );
4086 }
4087 */
4088
4089 return $ret;
4090 }
4091 }