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