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