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