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