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