3d4fdac8466b6cd31de7fb55941e2f49b7ab83b4
[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 = 0;
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() ) {
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 $this->load();
1683 if( $this->mId ) {
1684 $this->mTouched = self::newTouchedTimestamp();
1685
1686 $dbw = wfGetDB( DB_MASTER );
1687 $dbw->update( 'user',
1688 array( 'user_touched' => $dbw->timestamp( $this->mTouched ) ),
1689 array( 'user_id' => $this->mId ),
1690 __METHOD__ );
1691
1692 $this->clearSharedCache();
1693 }
1694 }
1695
1696 /**
1697 * Validate the cache for this account.
1698 * @param $timestamp \string A timestamp in TS_MW format
1699 */
1700 function validateCache( $timestamp ) {
1701 $this->load();
1702 return ($timestamp >= $this->mTouched);
1703 }
1704
1705 /**
1706 * Get the user touched timestamp
1707 */
1708 function getTouched() {
1709 $this->load();
1710 return $this->mTouched;
1711 }
1712
1713 /**
1714 * Set the password and reset the random token.
1715 * Calls through to authentication plugin if necessary;
1716 * will have no effect if the auth plugin refuses to
1717 * pass the change through or if the legal password
1718 * checks fail.
1719 *
1720 * As a special case, setting the password to null
1721 * wipes it, so the account cannot be logged in until
1722 * a new password is set, for instance via e-mail.
1723 *
1724 * @param $str \string New password to set
1725 * @throws PasswordError on failure
1726 */
1727 function setPassword( $str ) {
1728 global $wgAuth;
1729
1730 if( $str !== null ) {
1731 if( !$wgAuth->allowPasswordChange() ) {
1732 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1733 }
1734
1735 $valid = $this->isValidPassword( $str );
1736 if( $valid !== true ) {
1737 global $wgMinimalPasswordLength;
1738 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1739 $wgMinimalPasswordLength ) );
1740 }
1741 }
1742
1743 if( !$wgAuth->setPassword( $this, $str ) ) {
1744 throw new PasswordError( wfMsg( 'externaldberror' ) );
1745 }
1746
1747 $this->setInternalPassword( $str );
1748
1749 return true;
1750 }
1751
1752 /**
1753 * Set the password and reset the random token unconditionally.
1754 *
1755 * @param $str \string New password to set
1756 */
1757 function setInternalPassword( $str ) {
1758 $this->load();
1759 $this->setToken();
1760
1761 if( $str === null ) {
1762 // Save an invalid hash...
1763 $this->mPassword = '';
1764 } else {
1765 $this->mPassword = self::crypt( $str );
1766 }
1767 $this->mNewpassword = '';
1768 $this->mNewpassTime = null;
1769 }
1770
1771 /**
1772 * Get the user's current token.
1773 * @return \string Token
1774 */
1775 function getToken() {
1776 $this->load();
1777 return $this->mToken;
1778 }
1779
1780 /**
1781 * Set the random token (used for persistent authentication)
1782 * Called from loadDefaults() among other places.
1783 *
1784 * @param $token \string If specified, set the token to this value
1785 * @private
1786 */
1787 function setToken( $token = false ) {
1788 global $wgSecretKey, $wgProxyKey;
1789 $this->load();
1790 if ( !$token ) {
1791 if ( $wgSecretKey ) {
1792 $key = $wgSecretKey;
1793 } elseif ( $wgProxyKey ) {
1794 $key = $wgProxyKey;
1795 } else {
1796 $key = microtime();
1797 }
1798 $this->mToken = md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId );
1799 } else {
1800 $this->mToken = $token;
1801 }
1802 }
1803
1804 /**
1805 * Set the cookie password
1806 *
1807 * @param $str \string New cookie password
1808 * @private
1809 */
1810 function setCookiePassword( $str ) {
1811 $this->load();
1812 $this->mCookiePassword = md5( $str );
1813 }
1814
1815 /**
1816 * Set the password for a password reminder or new account email
1817 *
1818 * @param $str \string New password to set
1819 * @param $throttle \bool If true, reset the throttle timestamp to the present
1820 */
1821 function setNewpassword( $str, $throttle = true ) {
1822 $this->load();
1823 $this->mNewpassword = self::crypt( $str );
1824 if ( $throttle ) {
1825 $this->mNewpassTime = wfTimestampNow();
1826 }
1827 }
1828
1829 /**
1830 * Has password reminder email been sent within the last
1831 * $wgPasswordReminderResendTime hours?
1832 * @return \bool True or false
1833 */
1834 function isPasswordReminderThrottled() {
1835 global $wgPasswordReminderResendTime;
1836 $this->load();
1837 if ( !$this->mNewpassTime || !$wgPasswordReminderResendTime ) {
1838 return false;
1839 }
1840 $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgPasswordReminderResendTime * 3600;
1841 return time() < $expiry;
1842 }
1843
1844 /**
1845 * Get the user's e-mail address
1846 * @return \string User's email address
1847 */
1848 function getEmail() {
1849 $this->load();
1850 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail ) );
1851 return $this->mEmail;
1852 }
1853
1854 /**
1855 * Get the timestamp of the user's e-mail authentication
1856 * @return \string TS_MW timestamp
1857 */
1858 function getEmailAuthenticationTimestamp() {
1859 $this->load();
1860 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
1861 return $this->mEmailAuthenticated;
1862 }
1863
1864 /**
1865 * Set the user's e-mail address
1866 * @param $str \string New e-mail address
1867 */
1868 function setEmail( $str ) {
1869 $this->load();
1870 $this->mEmail = $str;
1871 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail ) );
1872 }
1873
1874 /**
1875 * Get the user's real name
1876 * @return \string User's real name
1877 */
1878 function getRealName() {
1879 $this->load();
1880 return $this->mRealName;
1881 }
1882
1883 /**
1884 * Set the user's real name
1885 * @param $str \string New real name
1886 */
1887 function setRealName( $str ) {
1888 $this->load();
1889 $this->mRealName = $str;
1890 }
1891
1892 /**
1893 * Get the user's current setting for a given option.
1894 *
1895 * @param $oname \string The option to check
1896 * @param $defaultOverride \string A default value returned if the option does not exist
1897 * @return \string User's current value for the option
1898 * @see getBoolOption()
1899 * @see getIntOption()
1900 */
1901 function getOption( $oname, $defaultOverride = null ) {
1902 $this->loadOptions();
1903
1904 if ( is_null( $this->mOptions ) ) {
1905 if($defaultOverride != '') {
1906 return $defaultOverride;
1907 }
1908 $this->mOptions = User::getDefaultOptions();
1909 }
1910
1911 if ( array_key_exists( $oname, $this->mOptions ) ) {
1912 return $this->mOptions[$oname];
1913 } else {
1914 return $defaultOverride;
1915 }
1916 }
1917
1918 /**
1919 * Get the user's current setting for a given option, as a boolean value.
1920 *
1921 * @param $oname \string The option to check
1922 * @return \bool User's current value for the option
1923 * @see getOption()
1924 */
1925 function getBoolOption( $oname ) {
1926 return (bool)$this->getOption( $oname );
1927 }
1928
1929
1930 /**
1931 * Get the user's current setting for a given option, as a boolean value.
1932 *
1933 * @param $oname \string The option to check
1934 * @param $defaultOverride \int A default value returned if the option does not exist
1935 * @return \int User's current value for the option
1936 * @see getOption()
1937 */
1938 function getIntOption( $oname, $defaultOverride=0 ) {
1939 $val = $this->getOption( $oname );
1940 if( $val == '' ) {
1941 $val = $defaultOverride;
1942 }
1943 return intval( $val );
1944 }
1945
1946 /**
1947 * Set the given option for a user.
1948 *
1949 * @param $oname \string The option to set
1950 * @param $val \mixed New value to set
1951 */
1952 function setOption( $oname, $val ) {
1953 $this->load();
1954 $this->loadOptions();
1955
1956 if ( $oname == 'skin' ) {
1957 # Clear cached skin, so the new one displays immediately in Special:Preferences
1958 unset( $this->mSkin );
1959 }
1960
1961 // Explicitly NULL values should refer to defaults
1962 global $wgDefaultUserOptions;
1963 if( is_null($val) && isset($wgDefaultUserOptions[$oname]) ) {
1964 $val = $wgDefaultUserOptions[$oname];
1965 }
1966
1967 $this->mOptions[$oname] = $val;
1968 }
1969
1970 /**
1971 * Reset all options to the site defaults
1972 */
1973 function resetOptions() {
1974 $this->mOptions = User::getDefaultOptions();
1975 }
1976
1977 /**
1978 * Get the user's preferred date format.
1979 * @return \string User's preferred date format
1980 */
1981 function getDatePreference() {
1982 // Important migration for old data rows
1983 if ( is_null( $this->mDatePreference ) ) {
1984 global $wgLang;
1985 $value = $this->getOption( 'date' );
1986 $map = $wgLang->getDatePreferenceMigrationMap();
1987 if ( isset( $map[$value] ) ) {
1988 $value = $map[$value];
1989 }
1990 $this->mDatePreference = $value;
1991 }
1992 return $this->mDatePreference;
1993 }
1994
1995 /**
1996 * Get the permissions this user has.
1997 * @return \type{\arrayof{\string}} Array of permission names
1998 */
1999 function getRights() {
2000 if ( is_null( $this->mRights ) ) {
2001 $this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() );
2002 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights ) );
2003 // Force reindexation of rights when a hook has unset one of them
2004 $this->mRights = array_values( $this->mRights );
2005 }
2006 return $this->mRights;
2007 }
2008
2009 /**
2010 * Get the list of explicit group memberships this user has.
2011 * The implicit * and user groups are not included.
2012 * @return \type{\arrayof{\string}} Array of internal group names
2013 */
2014 function getGroups() {
2015 $this->load();
2016 return $this->mGroups;
2017 }
2018
2019 /**
2020 * Get the list of implicit group memberships this user has.
2021 * This includes all explicit groups, plus 'user' if logged in,
2022 * '*' for all accounts and autopromoted groups
2023 * @param $recache \bool Whether to avoid the cache
2024 * @return \type{\arrayof{\string}} Array of internal group names
2025 */
2026 function getEffectiveGroups( $recache = false ) {
2027 if ( $recache || is_null( $this->mEffectiveGroups ) ) {
2028 $this->mEffectiveGroups = $this->getGroups();
2029 $this->mEffectiveGroups[] = '*';
2030 if( $this->getId() ) {
2031 $this->mEffectiveGroups[] = 'user';
2032
2033 $this->mEffectiveGroups = array_unique( array_merge(
2034 $this->mEffectiveGroups,
2035 Autopromote::getAutopromoteGroups( $this )
2036 ) );
2037
2038 # Hook for additional groups
2039 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups ) );
2040 }
2041 }
2042 return $this->mEffectiveGroups;
2043 }
2044
2045 /**
2046 * Get the user's edit count.
2047 * @return \int User'e edit count
2048 */
2049 function getEditCount() {
2050 if ($this->getId()) {
2051 if ( !isset( $this->mEditCount ) ) {
2052 /* Populate the count, if it has not been populated yet */
2053 $this->mEditCount = User::edits($this->mId);
2054 }
2055 return $this->mEditCount;
2056 } else {
2057 /* nil */
2058 return null;
2059 }
2060 }
2061
2062 /**
2063 * Add the user to the given group.
2064 * This takes immediate effect.
2065 * @param $group \string Name of the group to add
2066 */
2067 function addGroup( $group ) {
2068 $dbw = wfGetDB( DB_MASTER );
2069 if( $this->getId() ) {
2070 $dbw->insert( 'user_groups',
2071 array(
2072 'ug_user' => $this->getID(),
2073 'ug_group' => $group,
2074 ),
2075 'User::addGroup',
2076 array( 'IGNORE' ) );
2077 }
2078
2079 $this->loadGroups();
2080 $this->mGroups[] = $group;
2081 $this->mRights = User::getGroupPermissions( $this->getEffectiveGroups( true ) );
2082
2083 $this->invalidateCache();
2084 }
2085
2086 /**
2087 * Remove the user from the given group.
2088 * This takes immediate effect.
2089 * @param $group \string Name of the group to remove
2090 */
2091 function removeGroup( $group ) {
2092 $this->load();
2093 $dbw = wfGetDB( DB_MASTER );
2094 $dbw->delete( 'user_groups',
2095 array(
2096 'ug_user' => $this->getID(),
2097 'ug_group' => $group,
2098 ),
2099 'User::removeGroup' );
2100
2101 $this->loadGroups();
2102 $this->mGroups = array_diff( $this->mGroups, array( $group ) );
2103 $this->mRights = User::getGroupPermissions( $this->getEffectiveGroups( true ) );
2104
2105 $this->invalidateCache();
2106 }
2107
2108
2109 /**
2110 * Get whether the user is logged in
2111 * @return \bool True or false
2112 */
2113 function isLoggedIn() {
2114 return $this->getID() != 0;
2115 }
2116
2117 /**
2118 * Get whether the user is anonymous
2119 * @return \bool True or false
2120 */
2121 function isAnon() {
2122 return !$this->isLoggedIn();
2123 }
2124
2125 /**
2126 * Get whether the user is a bot
2127 * @return \bool True or false
2128 * @deprecated
2129 */
2130 function isBot() {
2131 wfDeprecated( __METHOD__ );
2132 return $this->isAllowed( 'bot' );
2133 }
2134
2135 /**
2136 * Check if user is allowed to access a feature / make an action
2137 * @param $action \string action to be checked
2138 * @return \bool True if action is allowed, else false
2139 */
2140 function isAllowed( $action = '' ) {
2141 if ( $action === '' )
2142 return true; // In the spirit of DWIM
2143 # Patrolling may not be enabled
2144 if( $action === 'patrol' || $action === 'autopatrol' ) {
2145 global $wgUseRCPatrol, $wgUseNPPatrol;
2146 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2147 return false;
2148 }
2149 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2150 # by misconfiguration: 0 == 'foo'
2151 return in_array( $action, $this->getRights(), true );
2152 }
2153
2154 /**
2155 * Check whether to enable recent changes patrol features for this user
2156 * @return \bool True or false
2157 */
2158 public function useRCPatrol() {
2159 global $wgUseRCPatrol;
2160 return( $wgUseRCPatrol && ($this->isAllowed('patrol') || $this->isAllowed('patrolmarks')) );
2161 }
2162
2163 /**
2164 * Check whether to enable new pages patrol features for this user
2165 * @return \bool True or false
2166 */
2167 public function useNPPatrol() {
2168 global $wgUseRCPatrol, $wgUseNPPatrol;
2169 return( ($wgUseRCPatrol || $wgUseNPPatrol) && ($this->isAllowed('patrol') || $this->isAllowed('patrolmarks')) );
2170 }
2171
2172 /**
2173 * Get the current skin, loading it if required, and setting a title
2174 * @param $t Title: the title to use in the skin
2175 * @return Skin The current skin
2176 * @todo FIXME : need to check the old failback system [AV]
2177 */
2178 function &getSkin( $t = null ) {
2179 if ( ! isset( $this->mSkin ) ) {
2180 wfProfileIn( __METHOD__ );
2181
2182 global $wgHiddenPrefs;
2183 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2184 # get the user skin
2185 global $wgRequest;
2186 $userSkin = $this->getOption( 'skin' );
2187 $userSkin = $wgRequest->getVal('useskin', $userSkin);
2188 } else {
2189 # if we're not allowing users to override, then use the default
2190 global $wgDefaultSkin;
2191 $userSkin = $wgDefaultSkin;
2192 }
2193
2194 $this->mSkin =& Skin::newFromKey( $userSkin );
2195 wfProfileOut( __METHOD__ );
2196 }
2197 if( $t || !$this->mSkin->getTitle() ) {
2198 if ( !$t ) {
2199 global $wgOut;
2200 $t = $wgOut->getTitle();
2201 }
2202 $this->mSkin->setTitle( $t );
2203 }
2204 return $this->mSkin;
2205 }
2206
2207 /**
2208 * Check the watched status of an article.
2209 * @param $title \type{Title} Title of the article to look at
2210 * @return \bool True if article is watched
2211 */
2212 function isWatched( $title ) {
2213 $wl = WatchedItem::fromUserTitle( $this, $title );
2214 return $wl->isWatched();
2215 }
2216
2217 /**
2218 * Watch an article.
2219 * @param $title \type{Title} Title of the article to look at
2220 */
2221 function addWatch( $title ) {
2222 $wl = WatchedItem::fromUserTitle( $this, $title );
2223 $wl->addWatch();
2224 $this->invalidateCache();
2225 }
2226
2227 /**
2228 * Stop watching an article.
2229 * @param $title \type{Title} Title of the article to look at
2230 */
2231 function removeWatch( $title ) {
2232 $wl = WatchedItem::fromUserTitle( $this, $title );
2233 $wl->removeWatch();
2234 $this->invalidateCache();
2235 }
2236
2237 /**
2238 * Clear the user's notification timestamp for the given title.
2239 * If e-notif e-mails are on, they will receive notification mails on
2240 * the next change of the page if it's watched etc.
2241 * @param $title \type{Title} Title of the article to look at
2242 */
2243 function clearNotification( &$title ) {
2244 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2245
2246 # Do nothing if the database is locked to writes
2247 if( wfReadOnly() ) {
2248 return;
2249 }
2250
2251 if ($title->getNamespace() == NS_USER_TALK &&
2252 $title->getText() == $this->getName() ) {
2253 if (!wfRunHooks('UserClearNewTalkNotification', array(&$this)))
2254 return;
2255 $this->setNewtalk( false );
2256 }
2257
2258 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2259 return;
2260 }
2261
2262 if( $this->isAnon() ) {
2263 // Nothing else to do...
2264 return;
2265 }
2266
2267 // Only update the timestamp if the page is being watched.
2268 // The query to find out if it is watched is cached both in memcached and per-invocation,
2269 // and when it does have to be executed, it can be on a slave
2270 // If this is the user's newtalk page, we always update the timestamp
2271 if ($title->getNamespace() == NS_USER_TALK &&
2272 $title->getText() == $wgUser->getName())
2273 {
2274 $watched = true;
2275 } elseif ( $this->getId() == $wgUser->getId() ) {
2276 $watched = $title->userIsWatching();
2277 } else {
2278 $watched = true;
2279 }
2280
2281 // If the page is watched by the user (or may be watched), update the timestamp on any
2282 // any matching rows
2283 if ( $watched ) {
2284 $dbw = wfGetDB( DB_MASTER );
2285 $dbw->update( 'watchlist',
2286 array( /* SET */
2287 'wl_notificationtimestamp' => NULL
2288 ), array( /* WHERE */
2289 'wl_title' => $title->getDBkey(),
2290 'wl_namespace' => $title->getNamespace(),
2291 'wl_user' => $this->getID()
2292 ), __METHOD__
2293 );
2294 }
2295 }
2296
2297 /**
2298 * Resets all of the given user's page-change notification timestamps.
2299 * If e-notif e-mails are on, they will receive notification mails on
2300 * the next change of any watched page.
2301 *
2302 * @param $currentUser \int User ID
2303 */
2304 function clearAllNotifications( $currentUser ) {
2305 global $wgUseEnotif, $wgShowUpdatedMarker;
2306 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2307 $this->setNewtalk( false );
2308 return;
2309 }
2310 if( $currentUser != 0 ) {
2311 $dbw = wfGetDB( DB_MASTER );
2312 $dbw->update( 'watchlist',
2313 array( /* SET */
2314 'wl_notificationtimestamp' => NULL
2315 ), array( /* WHERE */
2316 'wl_user' => $currentUser
2317 ), __METHOD__
2318 );
2319 # We also need to clear here the "you have new message" notification for the own user_talk page
2320 # This is cleared one page view later in Article::viewUpdates();
2321 }
2322 }
2323
2324 /**
2325 * Set this user's options from an encoded string
2326 * @param $str \string Encoded options to import
2327 * @private
2328 */
2329 function decodeOptions( $str ) {
2330 if (!$str)
2331 return;
2332
2333 $this->mOptionsLoaded = true;
2334 $this->mOptionOverrides = array();
2335
2336 $this->mOptions = array();
2337 $a = explode( "\n", $str );
2338 foreach ( $a as $s ) {
2339 $m = array();
2340 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2341 $this->mOptions[$m[1]] = $m[2];
2342 $this->mOptionOverrides[$m[1]] = $m[2];
2343 }
2344 }
2345 }
2346
2347 /**
2348 * Set a cookie on the user's client. Wrapper for
2349 * WebResponse::setCookie
2350 * @param $name \string Name of the cookie to set
2351 * @param $value \string Value to set
2352 * @param $exp \int Expiration time, as a UNIX time value;
2353 * if 0 or not specified, use the default $wgCookieExpiration
2354 */
2355 protected function setCookie( $name, $value, $exp=0 ) {
2356 global $wgRequest;
2357 $wgRequest->response()->setcookie( $name, $value, $exp );
2358 }
2359
2360 /**
2361 * Clear a cookie on the user's client
2362 * @param $name \string Name of the cookie to clear
2363 */
2364 protected function clearCookie( $name ) {
2365 $this->setCookie( $name, '', time() - 86400 );
2366 }
2367
2368 /**
2369 * Set the default cookies for this session on the user's client.
2370 */
2371 function setCookies() {
2372 $this->load();
2373 if ( 0 == $this->mId ) return;
2374 $session = array(
2375 'wsUserID' => $this->mId,
2376 'wsToken' => $this->mToken,
2377 'wsUserName' => $this->getName()
2378 );
2379 $cookies = array(
2380 'UserID' => $this->mId,
2381 'UserName' => $this->getName(),
2382 );
2383 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2384 $cookies['Token'] = $this->mToken;
2385 } else {
2386 $cookies['Token'] = false;
2387 }
2388
2389 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2390 #check for null, since the hook could cause a null value
2391 if ( !is_null( $session ) && isset( $_SESSION ) ){
2392 $_SESSION = $session + $_SESSION;
2393 }
2394 foreach ( $cookies as $name => $value ) {
2395 if ( $value === false ) {
2396 $this->clearCookie( $name );
2397 } else {
2398 $this->setCookie( $name, $value );
2399 }
2400 }
2401 }
2402
2403 /**
2404 * Log this user out.
2405 */
2406 function logout() {
2407 if( wfRunHooks( 'UserLogout', array(&$this) ) ) {
2408 $this->doLogout();
2409 }
2410 }
2411
2412 /**
2413 * Clear the user's cookies and session, and reset the instance cache.
2414 * @private
2415 * @see logout()
2416 */
2417 function doLogout() {
2418 $this->clearInstanceCache( 'defaults' );
2419
2420 $_SESSION['wsUserID'] = 0;
2421
2422 $this->clearCookie( 'UserID' );
2423 $this->clearCookie( 'Token' );
2424
2425 # Remember when user logged out, to prevent seeing cached pages
2426 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() + 86400 );
2427 }
2428
2429 /**
2430 * Save this user's settings into the database.
2431 * @todo Only rarely do all these fields need to be set!
2432 */
2433 function saveSettings() {
2434 $this->load();
2435 if ( wfReadOnly() ) { return; }
2436 if ( 0 == $this->mId ) { return; }
2437
2438 $this->mTouched = self::newTouchedTimestamp();
2439
2440 $dbw = wfGetDB( DB_MASTER );
2441 $dbw->update( 'user',
2442 array( /* SET */
2443 'user_name' => $this->mName,
2444 'user_password' => $this->mPassword,
2445 'user_newpassword' => $this->mNewpassword,
2446 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
2447 'user_real_name' => $this->mRealName,
2448 'user_email' => $this->mEmail,
2449 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
2450 'user_options' => '',
2451 'user_touched' => $dbw->timestamp($this->mTouched),
2452 'user_token' => $this->mToken,
2453 'user_email_token' => $this->mEmailToken,
2454 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ),
2455 ), array( /* WHERE */
2456 'user_id' => $this->mId
2457 ), __METHOD__
2458 );
2459
2460 $this->saveOptions();
2461
2462 wfRunHooks( 'UserSaveSettings', array( $this ) );
2463 $this->clearSharedCache();
2464 $this->getUserPage()->invalidateCache();
2465 }
2466
2467 /**
2468 * If only this user's username is known, and it exists, return the user ID.
2469 */
2470 function idForName() {
2471 $s = trim( $this->getName() );
2472 if ( $s === '' ) return 0;
2473
2474 $dbr = wfGetDB( DB_SLAVE );
2475 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__ );
2476 if ( $id === false ) {
2477 $id = 0;
2478 }
2479 return $id;
2480 }
2481
2482 /**
2483 * Add a user to the database, return the user object
2484 *
2485 * @param $name \string Username to add
2486 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2487 * - password The user's password. Password logins will be disabled if this is omitted.
2488 * - newpassword A temporary password mailed to the user
2489 * - email The user's email address
2490 * - email_authenticated The email authentication timestamp
2491 * - real_name The user's real name
2492 * - options An associative array of non-default options
2493 * - token Random authentication token. Do not set.
2494 * - registration Registration timestamp. Do not set.
2495 *
2496 * @return \type{User} A new User object, or null if the username already exists
2497 */
2498 static function createNew( $name, $params = array() ) {
2499 $user = new User;
2500 $user->load();
2501 if ( isset( $params['options'] ) ) {
2502 $user->mOptions = $params['options'] + (array)$user->mOptions;
2503 unset( $params['options'] );
2504 }
2505 $dbw = wfGetDB( DB_MASTER );
2506 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2507 $fields = array(
2508 'user_id' => $seqVal,
2509 'user_name' => $name,
2510 'user_password' => $user->mPassword,
2511 'user_newpassword' => $user->mNewpassword,
2512 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime ),
2513 'user_email' => $user->mEmail,
2514 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
2515 'user_real_name' => $user->mRealName,
2516 'user_options' => '',
2517 'user_token' => $user->mToken,
2518 'user_registration' => $dbw->timestamp( $user->mRegistration ),
2519 'user_editcount' => 0,
2520 );
2521 foreach ( $params as $name => $value ) {
2522 $fields["user_$name"] = $value;
2523 }
2524 $dbw->insert( 'user', $fields, __METHOD__, array( 'IGNORE' ) );
2525 if ( $dbw->affectedRows() ) {
2526 $newUser = User::newFromId( $dbw->insertId() );
2527 } else {
2528 $newUser = null;
2529 }
2530 return $newUser;
2531 }
2532
2533 /**
2534 * Add this existing user object to the database
2535 */
2536 function addToDatabase() {
2537 $this->load();
2538 $dbw = wfGetDB( DB_MASTER );
2539 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2540 $dbw->insert( 'user',
2541 array(
2542 'user_id' => $seqVal,
2543 'user_name' => $this->mName,
2544 'user_password' => $this->mPassword,
2545 'user_newpassword' => $this->mNewpassword,
2546 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime ),
2547 'user_email' => $this->mEmail,
2548 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
2549 'user_real_name' => $this->mRealName,
2550 'user_options' => '',
2551 'user_token' => $this->mToken,
2552 'user_registration' => $dbw->timestamp( $this->mRegistration ),
2553 'user_editcount' => 0,
2554 ), __METHOD__
2555 );
2556 $this->mId = $dbw->insertId();
2557
2558 // Clear instance cache other than user table data, which is already accurate
2559 $this->clearInstanceCache();
2560
2561 $this->saveOptions();
2562 }
2563
2564 /**
2565 * If this (non-anonymous) user is blocked, block any IP address
2566 * they've successfully logged in from.
2567 */
2568 function spreadBlock() {
2569 wfDebug( __METHOD__."()\n" );
2570 $this->load();
2571 if ( $this->mId == 0 ) {
2572 return;
2573 }
2574
2575 $userblock = Block::newFromDB( '', $this->mId );
2576 if ( !$userblock ) {
2577 return;
2578 }
2579
2580 $userblock->doAutoblock( wfGetIp() );
2581
2582 }
2583
2584 /**
2585 * Generate a string which will be different for any combination of
2586 * user options which would produce different parser output.
2587 * This will be used as part of the hash key for the parser cache,
2588 * so users will the same options can share the same cached data
2589 * safely.
2590 *
2591 * Extensions which require it should install 'PageRenderingHash' hook,
2592 * which will give them a chance to modify this key based on their own
2593 * settings.
2594 *
2595 * @return \string Page rendering hash
2596 */
2597 function getPageRenderingHash() {
2598 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2599 if( $this->mHash ){
2600 return $this->mHash;
2601 }
2602
2603 // stubthreshold is only included below for completeness,
2604 // it will always be 0 when this function is called by parsercache.
2605
2606 $confstr = $this->getOption( 'math' );
2607 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2608 if ( $wgUseDynamicDates ) {
2609 $confstr .= '!' . $this->getDatePreference();
2610 }
2611 $confstr .= '!' . ($this->getOption( 'numberheadings' ) ? '1' : '');
2612 $confstr .= '!' . $wgLang->getCode();
2613 $confstr .= '!' . $this->getOption( 'thumbsize' );
2614 // add in language specific options, if any
2615 $extra = $wgContLang->getExtraHashOptions();
2616 $confstr .= $extra;
2617
2618 $confstr .= $wgRenderHashAppend;
2619
2620 // Give a chance for extensions to modify the hash, if they have
2621 // extra options or other effects on the parser cache.
2622 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2623
2624 // Make it a valid memcached key fragment
2625 $confstr = str_replace( ' ', '_', $confstr );
2626 $this->mHash = $confstr;
2627 return $confstr;
2628 }
2629
2630 /**
2631 * Get whether the user is explicitly blocked from account creation.
2632 * @return \bool True if blocked
2633 */
2634 function isBlockedFromCreateAccount() {
2635 $this->getBlockedStatus();
2636 return $this->mBlock && $this->mBlock->mCreateAccount;
2637 }
2638
2639 /**
2640 * Get whether the user is blocked from using Special:Emailuser.
2641 * @return \bool True if blocked
2642 */
2643 function isBlockedFromEmailuser() {
2644 $this->getBlockedStatus();
2645 return $this->mBlock && $this->mBlock->mBlockEmail;
2646 }
2647
2648 /**
2649 * Get whether the user is allowed to create an account.
2650 * @return \bool True if allowed
2651 */
2652 function isAllowedToCreateAccount() {
2653 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2654 }
2655
2656 /**
2657 * @deprecated
2658 */
2659 function setLoaded( $loaded ) {
2660 wfDeprecated( __METHOD__ );
2661 }
2662
2663 /**
2664 * Get this user's personal page title.
2665 *
2666 * @return \type{Title} User's personal page title
2667 */
2668 function getUserPage() {
2669 return Title::makeTitle( NS_USER, $this->getName() );
2670 }
2671
2672 /**
2673 * Get this user's talk page title.
2674 *
2675 * @return \type{Title} User's talk page title
2676 */
2677 function getTalkPage() {
2678 $title = $this->getUserPage();
2679 return $title->getTalkPage();
2680 }
2681
2682 /**
2683 * Get the maximum valid user ID.
2684 * @return \int User ID
2685 * @static
2686 */
2687 function getMaxID() {
2688 static $res; // cache
2689
2690 if ( isset( $res ) )
2691 return $res;
2692 else {
2693 $dbr = wfGetDB( DB_SLAVE );
2694 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2695 }
2696 }
2697
2698 /**
2699 * Determine whether the user is a newbie. Newbies are either
2700 * anonymous IPs, or the most recently created accounts.
2701 * @return \bool True if the user is a newbie
2702 */
2703 function isNewbie() {
2704 return !$this->isAllowed( 'autoconfirmed' );
2705 }
2706
2707 /**
2708 * Check to see if the given clear-text password is one of the accepted passwords
2709 * @param $password \string user password.
2710 * @return \bool True if the given password is correct, otherwise False.
2711 */
2712 function checkPassword( $password ) {
2713 global $wgAuth;
2714 $this->load();
2715
2716 // Even though we stop people from creating passwords that
2717 // are shorter than this, doesn't mean people wont be able
2718 // to. Certain authentication plugins do NOT want to save
2719 // domain passwords in a mysql database, so we should
2720 // check this (incase $wgAuth->strict() is false).
2721 if( $this->isValidPassword( $password ) !== true ) {
2722 return false;
2723 }
2724
2725 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2726 return true;
2727 } elseif( $wgAuth->strict() ) {
2728 /* Auth plugin doesn't allow local authentication */
2729 return false;
2730 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2731 /* Auth plugin doesn't allow local authentication for this user name */
2732 return false;
2733 }
2734 if ( self::comparePasswords( $this->mPassword, $password, $this->mId ) ) {
2735 return true;
2736 } elseif ( function_exists( 'iconv' ) ) {
2737 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2738 # Check for this with iconv
2739 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2740 if ( self::comparePasswords( $this->mPassword, $cp1252Password, $this->mId ) ) {
2741 return true;
2742 }
2743 }
2744 return false;
2745 }
2746
2747 /**
2748 * Check if the given clear-text password matches the temporary password
2749 * sent by e-mail for password reset operations.
2750 * @return \bool True if matches, false otherwise
2751 */
2752 function checkTemporaryPassword( $plaintext ) {
2753 global $wgNewPasswordExpiry;
2754 if( self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() ) ) {
2755 $this->load();
2756 $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgNewPasswordExpiry;
2757 return ( time() < $expiry );
2758 } else {
2759 return false;
2760 }
2761 }
2762
2763 /**
2764 * Initialize (if necessary) and return a session token value
2765 * which can be used in edit forms to show that the user's
2766 * login credentials aren't being hijacked with a foreign form
2767 * submission.
2768 *
2769 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2770 * @return \string The new edit token
2771 */
2772 function editToken( $salt = '' ) {
2773 if ( $this->isAnon() ) {
2774 return EDIT_TOKEN_SUFFIX;
2775 } else {
2776 if( !isset( $_SESSION['wsEditToken'] ) ) {
2777 $token = $this->generateToken();
2778 $_SESSION['wsEditToken'] = $token;
2779 } else {
2780 $token = $_SESSION['wsEditToken'];
2781 }
2782 if( is_array( $salt ) ) {
2783 $salt = implode( '|', $salt );
2784 }
2785 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX;
2786 }
2787 }
2788
2789 /**
2790 * Generate a looking random token for various uses.
2791 *
2792 * @param $salt \string Optional salt value
2793 * @return \string The new random token
2794 */
2795 function generateToken( $salt = '' ) {
2796 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2797 return md5( $token . $salt );
2798 }
2799
2800 /**
2801 * Check given value against the token value stored in the session.
2802 * A match should confirm that the form was submitted from the
2803 * user's own login session, not a form submission from a third-party
2804 * site.
2805 *
2806 * @param $val \string Input value to compare
2807 * @param $salt \string Optional function-specific data for hashing
2808 * @return \bool Whether the token matches
2809 */
2810 function matchEditToken( $val, $salt = '' ) {
2811 $sessionToken = $this->editToken( $salt );
2812 if ( $val != $sessionToken ) {
2813 wfDebug( "User::matchEditToken: broken session data\n" );
2814 }
2815 return $val == $sessionToken;
2816 }
2817
2818 /**
2819 * Check given value against the token value stored in the session,
2820 * ignoring the suffix.
2821 *
2822 * @param $val \string Input value to compare
2823 * @param $salt \string Optional function-specific data for hashing
2824 * @return \bool Whether the token matches
2825 */
2826 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2827 $sessionToken = $this->editToken( $salt );
2828 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2829 }
2830
2831 /**
2832 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2833 * mail to the user's given address.
2834 *
2835 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2836 */
2837 function sendConfirmationMail() {
2838 global $wgLang;
2839 $expiration = null; // gets passed-by-ref and defined in next line.
2840 $token = $this->confirmationToken( $expiration );
2841 $url = $this->confirmationTokenUrl( $token );
2842 $invalidateURL = $this->invalidationTokenUrl( $token );
2843 $this->saveSettings();
2844
2845 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2846 wfMsg( 'confirmemail_body',
2847 wfGetIP(),
2848 $this->getName(),
2849 $url,
2850 $wgLang->timeanddate( $expiration, false ),
2851 $invalidateURL,
2852 $wgLang->date( $expiration, false ),
2853 $wgLang->time( $expiration, false ) ) );
2854 }
2855
2856 /**
2857 * Send an e-mail to this user's account. Does not check for
2858 * confirmed status or validity.
2859 *
2860 * @param $subject \string Message subject
2861 * @param $body \string Message body
2862 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2863 * @param $replyto \string Reply-To address
2864 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2865 */
2866 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2867 if( is_null( $from ) ) {
2868 global $wgPasswordSender;
2869 $from = $wgPasswordSender;
2870 }
2871
2872 $to = new MailAddress( $this );
2873 $sender = new MailAddress( $from );
2874 return UserMailer::send( $to, $sender, $subject, $body, $replyto );
2875 }
2876
2877 /**
2878 * Generate, store, and return a new e-mail confirmation code.
2879 * A hash (unsalted, since it's used as a key) is stored.
2880 *
2881 * @note Call saveSettings() after calling this function to commit
2882 * this change to the database.
2883 *
2884 * @param[out] &$expiration \mixed Accepts the expiration time
2885 * @return \string New token
2886 * @private
2887 */
2888 function confirmationToken( &$expiration ) {
2889 $now = time();
2890 $expires = $now + 7 * 24 * 60 * 60;
2891 $expiration = wfTimestamp( TS_MW, $expires );
2892 $token = $this->generateToken( $this->mId . $this->mEmail . $expires );
2893 $hash = md5( $token );
2894 $this->load();
2895 $this->mEmailToken = $hash;
2896 $this->mEmailTokenExpires = $expiration;
2897 return $token;
2898 }
2899
2900 /**
2901 * Return a URL the user can use to confirm their email address.
2902 * @param $token \string Accepts the email confirmation token
2903 * @return \string New token URL
2904 * @private
2905 */
2906 function confirmationTokenUrl( $token ) {
2907 return $this->getTokenUrl( 'ConfirmEmail', $token );
2908 }
2909 /**
2910 * Return a URL the user can use to invalidate their email address.
2911 * @param $token \string Accepts the email confirmation token
2912 * @return \string New token URL
2913 * @private
2914 */
2915 function invalidationTokenUrl( $token ) {
2916 return $this->getTokenUrl( 'Invalidateemail', $token );
2917 }
2918
2919 /**
2920 * Internal function to format the e-mail validation/invalidation URLs.
2921 * This uses $wgArticlePath directly as a quickie hack to use the
2922 * hardcoded English names of the Special: pages, for ASCII safety.
2923 *
2924 * @note Since these URLs get dropped directly into emails, using the
2925 * short English names avoids insanely long URL-encoded links, which
2926 * also sometimes can get corrupted in some browsers/mailers
2927 * (bug 6957 with Gmail and Internet Explorer).
2928 *
2929 * @param $page \string Special page
2930 * @param $token \string Token
2931 * @return \string Formatted URL
2932 */
2933 protected function getTokenUrl( $page, $token ) {
2934 global $wgArticlePath;
2935 return wfExpandUrl(
2936 str_replace(
2937 '$1',
2938 "Special:$page/$token",
2939 $wgArticlePath ) );
2940 }
2941
2942 /**
2943 * Mark the e-mail address confirmed.
2944 *
2945 * @note Call saveSettings() after calling this function to commit the change.
2946 */
2947 function confirmEmail() {
2948 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2949 return true;
2950 }
2951
2952 /**
2953 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2954 * address if it was already confirmed.
2955 *
2956 * @note Call saveSettings() after calling this function to commit the change.
2957 */
2958 function invalidateEmail() {
2959 $this->load();
2960 $this->mEmailToken = null;
2961 $this->mEmailTokenExpires = null;
2962 $this->setEmailAuthenticationTimestamp( null );
2963 return true;
2964 }
2965
2966 /**
2967 * Set the e-mail authentication timestamp.
2968 * @param $timestamp \string TS_MW timestamp
2969 */
2970 function setEmailAuthenticationTimestamp( $timestamp ) {
2971 $this->load();
2972 $this->mEmailAuthenticated = $timestamp;
2973 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
2974 }
2975
2976 /**
2977 * Is this user allowed to send e-mails within limits of current
2978 * site configuration?
2979 * @return \bool True if allowed
2980 */
2981 function canSendEmail() {
2982 global $wgEnableEmail, $wgEnableUserEmail;
2983 if( !$wgEnableEmail || !$wgEnableUserEmail ) {
2984 return false;
2985 }
2986 $canSend = $this->isEmailConfirmed();
2987 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
2988 return $canSend;
2989 }
2990
2991 /**
2992 * Is this user allowed to receive e-mails within limits of current
2993 * site configuration?
2994 * @return \bool True if allowed
2995 */
2996 function canReceiveEmail() {
2997 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
2998 }
2999
3000 /**
3001 * Is this user's e-mail address valid-looking and confirmed within
3002 * limits of the current site configuration?
3003 *
3004 * @note If $wgEmailAuthentication is on, this may require the user to have
3005 * confirmed their address by returning a code or using a password
3006 * sent to the address from the wiki.
3007 *
3008 * @return \bool True if confirmed
3009 */
3010 function isEmailConfirmed() {
3011 global $wgEmailAuthentication;
3012 $this->load();
3013 $confirmed = true;
3014 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3015 if( $this->isAnon() )
3016 return false;
3017 if( !self::isValidEmailAddr( $this->mEmail ) )
3018 return false;
3019 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3020 return false;
3021 return true;
3022 } else {
3023 return $confirmed;
3024 }
3025 }
3026
3027 /**
3028 * Check whether there is an outstanding request for e-mail confirmation.
3029 * @return \bool True if pending
3030 */
3031 function isEmailConfirmationPending() {
3032 global $wgEmailAuthentication;
3033 return $wgEmailAuthentication &&
3034 !$this->isEmailConfirmed() &&
3035 $this->mEmailToken &&
3036 $this->mEmailTokenExpires > wfTimestamp();
3037 }
3038
3039 /**
3040 * Get the timestamp of account creation.
3041 *
3042 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3043 * non-existent/anonymous user accounts.
3044 */
3045 public function getRegistration() {
3046 return $this->getId() > 0
3047 ? $this->mRegistration
3048 : false;
3049 }
3050
3051 /**
3052 * Get the timestamp of the first edit
3053 *
3054 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3055 * non-existent/anonymous user accounts.
3056 */
3057 public function getFirstEditTimestamp() {
3058 if( $this->getId() == 0 ) return false; // anons
3059 $dbr = wfGetDB( DB_SLAVE );
3060 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3061 array( 'rev_user' => $this->getId() ),
3062 __METHOD__,
3063 array( 'ORDER BY' => 'rev_timestamp ASC' )
3064 );
3065 if( !$time ) return false; // no edits
3066 return wfTimestamp( TS_MW, $time );
3067 }
3068
3069 /**
3070 * Get the permissions associated with a given list of groups
3071 *
3072 * @param $groups \type{\arrayof{\string}} List of internal group names
3073 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3074 */
3075 static function getGroupPermissions( $groups ) {
3076 global $wgGroupPermissions, $wgRevokePermissions;
3077 $rights = array();
3078 // grant every granted permission first
3079 foreach( $groups as $group ) {
3080 if( isset( $wgGroupPermissions[$group] ) ) {
3081 $rights = array_merge( $rights,
3082 // array_filter removes empty items
3083 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3084 }
3085 }
3086 // now revoke the revoked permissions
3087 foreach( $groups as $group ) {
3088 if( isset( $wgRevokePermissions[$group] ) ) {
3089 $rights = array_diff( $rights,
3090 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3091 }
3092 }
3093 return array_unique($rights);
3094 }
3095
3096 /**
3097 * Get all the groups who have a given permission
3098 *
3099 * @param $role \string Role to check
3100 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3101 */
3102 static function getGroupsWithPermission( $role ) {
3103 global $wgGroupPermissions;
3104 $allowedGroups = array();
3105 foreach ( $wgGroupPermissions as $group => $rights ) {
3106 if ( isset( $rights[$role] ) && $rights[$role] ) {
3107 $allowedGroups[] = $group;
3108 }
3109 }
3110 return $allowedGroups;
3111 }
3112
3113 /**
3114 * Get the localized descriptive name for a group, if it exists
3115 *
3116 * @param $group \string Internal group name
3117 * @return \string Localized descriptive group name
3118 */
3119 static function getGroupName( $group ) {
3120 global $wgMessageCache;
3121 $wgMessageCache->loadAllMessages();
3122 $key = "group-$group";
3123 $name = wfMsg( $key );
3124 return $name == '' || wfEmptyMsg( $key, $name )
3125 ? $group
3126 : $name;
3127 }
3128
3129 /**
3130 * Get the localized descriptive name for a member of a group, if it exists
3131 *
3132 * @param $group \string Internal group name
3133 * @return \string Localized name for group member
3134 */
3135 static function getGroupMember( $group ) {
3136 global $wgMessageCache;
3137 $wgMessageCache->loadAllMessages();
3138 $key = "group-$group-member";
3139 $name = wfMsg( $key );
3140 return $name == '' || wfEmptyMsg( $key, $name )
3141 ? $group
3142 : $name;
3143 }
3144
3145 /**
3146 * Return the set of defined explicit groups.
3147 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3148 * are not included, as they are defined automatically, not in the database.
3149 * @return \type{\arrayof{\string}} Array of internal group names
3150 */
3151 static function getAllGroups() {
3152 global $wgGroupPermissions, $wgRevokePermissions;
3153 return array_diff(
3154 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3155 self::getImplicitGroups()
3156 );
3157 }
3158
3159 /**
3160 * Get a list of all available permissions.
3161 * @return \type{\arrayof{\string}} Array of permission names
3162 */
3163 static function getAllRights() {
3164 if ( self::$mAllRights === false ) {
3165 global $wgAvailableRights;
3166 if ( count( $wgAvailableRights ) ) {
3167 self::$mAllRights = array_unique( array_merge( self::$mCoreRights, $wgAvailableRights ) );
3168 } else {
3169 self::$mAllRights = self::$mCoreRights;
3170 }
3171 wfRunHooks( 'UserGetAllRights', array( &self::$mAllRights ) );
3172 }
3173 return self::$mAllRights;
3174 }
3175
3176 /**
3177 * Get a list of implicit groups
3178 * @return \type{\arrayof{\string}} Array of internal group names
3179 */
3180 public static function getImplicitGroups() {
3181 global $wgImplicitGroups;
3182 $groups = $wgImplicitGroups;
3183 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3184 return $groups;
3185 }
3186
3187 /**
3188 * Get the title of a page describing a particular group
3189 *
3190 * @param $group \string Internal group name
3191 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3192 */
3193 static function getGroupPage( $group ) {
3194 global $wgMessageCache;
3195 $wgMessageCache->loadAllMessages();
3196 $page = wfMsgForContent( 'grouppage-' . $group );
3197 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3198 $title = Title::newFromText( $page );
3199 if( is_object( $title ) )
3200 return $title;
3201 }
3202 return false;
3203 }
3204
3205 /**
3206 * Create a link to the group in HTML, if available;
3207 * else return the group name.
3208 *
3209 * @param $group \string Internal name of the group
3210 * @param $text \string The text of the link
3211 * @return \string HTML link to the group
3212 */
3213 static function makeGroupLinkHTML( $group, $text = '' ) {
3214 if( $text == '' ) {
3215 $text = self::getGroupName( $group );
3216 }
3217 $title = self::getGroupPage( $group );
3218 if( $title ) {
3219 global $wgUser;
3220 $sk = $wgUser->getSkin();
3221 return $sk->link( $title, htmlspecialchars( $text ) );
3222 } else {
3223 return $text;
3224 }
3225 }
3226
3227 /**
3228 * Create a link to the group in Wikitext, if available;
3229 * else return the group name.
3230 *
3231 * @param $group \string Internal name of the group
3232 * @param $text \string The text of the link
3233 * @return \string Wikilink to the group
3234 */
3235 static function makeGroupLinkWiki( $group, $text = '' ) {
3236 if( $text == '' ) {
3237 $text = self::getGroupName( $group );
3238 }
3239 $title = self::getGroupPage( $group );
3240 if( $title ) {
3241 $page = $title->getPrefixedText();
3242 return "[[$page|$text]]";
3243 } else {
3244 return $text;
3245 }
3246 }
3247
3248 /**
3249 * Returns an array of the groups that a particular group can add/remove.
3250 *
3251 * @param $group String: the group to check for whether it can add/remove
3252 * @return Array array( 'add' => array( addablegroups ),
3253 * 'remove' => array( removablegroups ),
3254 * 'add-self' => array( addablegroups to self),
3255 * 'remove-self' => array( removable groups from self) )
3256 */
3257 static function changeableByGroup( $group ) {
3258 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3259
3260 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3261 if( empty($wgAddGroups[$group]) ) {
3262 // Don't add anything to $groups
3263 } elseif( $wgAddGroups[$group] === true ) {
3264 // You get everything
3265 $groups['add'] = self::getAllGroups();
3266 } elseif( is_array($wgAddGroups[$group]) ) {
3267 $groups['add'] = $wgAddGroups[$group];
3268 }
3269
3270 // Same thing for remove
3271 if( empty($wgRemoveGroups[$group]) ) {
3272 } elseif($wgRemoveGroups[$group] === true ) {
3273 $groups['remove'] = self::getAllGroups();
3274 } elseif( is_array($wgRemoveGroups[$group]) ) {
3275 $groups['remove'] = $wgRemoveGroups[$group];
3276 }
3277
3278 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3279 if( empty($wgGroupsAddToSelf['user']) || $wgGroupsAddToSelf['user'] !== true ) {
3280 foreach($wgGroupsAddToSelf as $key => $value) {
3281 if( is_int($key) ) {
3282 $wgGroupsAddToSelf['user'][] = $value;
3283 }
3284 }
3285 }
3286
3287 if( empty($wgGroupsRemoveFromSelf['user']) || $wgGroupsRemoveFromSelf['user'] !== true ) {
3288 foreach($wgGroupsRemoveFromSelf as $key => $value) {
3289 if( is_int($key) ) {
3290 $wgGroupsRemoveFromSelf['user'][] = $value;
3291 }
3292 }
3293 }
3294
3295 // Now figure out what groups the user can add to him/herself
3296 if( empty($wgGroupsAddToSelf[$group]) ) {
3297 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3298 // No idea WHY this would be used, but it's there
3299 $groups['add-self'] = User::getAllGroups();
3300 } elseif( is_array($wgGroupsAddToSelf[$group]) ) {
3301 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3302 }
3303
3304 if( empty($wgGroupsRemoveFromSelf[$group]) ) {
3305 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3306 $groups['remove-self'] = User::getAllGroups();
3307 } elseif( is_array($wgGroupsRemoveFromSelf[$group]) ) {
3308 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3309 }
3310
3311 return $groups;
3312 }
3313
3314 /**
3315 * Returns an array of groups that this user can add and remove
3316 * @return Array array( 'add' => array( addablegroups ),
3317 * 'remove' => array( removablegroups ),
3318 * 'add-self' => array( addablegroups to self),
3319 * 'remove-self' => array( removable groups from self) )
3320 */
3321 function changeableGroups() {
3322 if( $this->isAllowed( 'userrights' ) ) {
3323 // This group gives the right to modify everything (reverse-
3324 // compatibility with old "userrights lets you change
3325 // everything")
3326 // Using array_merge to make the groups reindexed
3327 $all = array_merge( User::getAllGroups() );
3328 return array(
3329 'add' => $all,
3330 'remove' => $all,
3331 'add-self' => array(),
3332 'remove-self' => array()
3333 );
3334 }
3335
3336 // Okay, it's not so simple, we will have to go through the arrays
3337 $groups = array(
3338 'add' => array(),
3339 'remove' => array(),
3340 'add-self' => array(),
3341 'remove-self' => array() );
3342 $addergroups = $this->getEffectiveGroups();
3343
3344 foreach ($addergroups as $addergroup) {
3345 $groups = array_merge_recursive(
3346 $groups, $this->changeableByGroup($addergroup)
3347 );
3348 $groups['add'] = array_unique( $groups['add'] );
3349 $groups['remove'] = array_unique( $groups['remove'] );
3350 $groups['add-self'] = array_unique( $groups['add-self'] );
3351 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3352 }
3353 return $groups;
3354 }
3355
3356 /**
3357 * Increment the user's edit-count field.
3358 * Will have no effect for anonymous users.
3359 */
3360 function incEditCount() {
3361 if( !$this->isAnon() ) {
3362 $dbw = wfGetDB( DB_MASTER );
3363 $dbw->update( 'user',
3364 array( 'user_editcount=user_editcount+1' ),
3365 array( 'user_id' => $this->getId() ),
3366 __METHOD__ );
3367
3368 // Lazy initialization check...
3369 if( $dbw->affectedRows() == 0 ) {
3370 // Pull from a slave to be less cruel to servers
3371 // Accuracy isn't the point anyway here
3372 $dbr = wfGetDB( DB_SLAVE );
3373 $count = $dbr->selectField( 'revision',
3374 'COUNT(rev_user)',
3375 array( 'rev_user' => $this->getId() ),
3376 __METHOD__ );
3377
3378 // Now here's a goddamn hack...
3379 if( $dbr !== $dbw ) {
3380 // If we actually have a slave server, the count is
3381 // at least one behind because the current transaction
3382 // has not been committed and replicated.
3383 $count++;
3384 } else {
3385 // But if DB_SLAVE is selecting the master, then the
3386 // count we just read includes the revision that was
3387 // just added in the working transaction.
3388 }
3389
3390 $dbw->update( 'user',
3391 array( 'user_editcount' => $count ),
3392 array( 'user_id' => $this->getId() ),
3393 __METHOD__ );
3394 }
3395 }
3396 // edit count in user cache too
3397 $this->invalidateCache();
3398 }
3399
3400 /**
3401 * Get the description of a given right
3402 *
3403 * @param $right \string Right to query
3404 * @return \string Localized description of the right
3405 */
3406 static function getRightDescription( $right ) {
3407 global $wgMessageCache;
3408 $wgMessageCache->loadAllMessages();
3409 $key = "right-$right";
3410 $name = wfMsg( $key );
3411 return $name == '' || wfEmptyMsg( $key, $name )
3412 ? $right
3413 : $name;
3414 }
3415
3416 /**
3417 * Make an old-style password hash
3418 *
3419 * @param $password \string Plain-text password
3420 * @param $userId \string User ID
3421 * @return \string Password hash
3422 */
3423 static function oldCrypt( $password, $userId ) {
3424 global $wgPasswordSalt;
3425 if ( $wgPasswordSalt ) {
3426 return md5( $userId . '-' . md5( $password ) );
3427 } else {
3428 return md5( $password );
3429 }
3430 }
3431
3432 /**
3433 * Make a new-style password hash
3434 *
3435 * @param $password \string Plain-text password
3436 * @param $salt \string Optional salt, may be random or the user ID.
3437 * If unspecified or false, will generate one automatically
3438 * @return \string Password hash
3439 */
3440 static function crypt( $password, $salt = false ) {
3441 global $wgPasswordSalt;
3442
3443 $hash = '';
3444 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3445 return $hash;
3446 }
3447
3448 if( $wgPasswordSalt ) {
3449 if ( $salt === false ) {
3450 $salt = substr( wfGenerateToken(), 0, 8 );
3451 }
3452 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3453 } else {
3454 return ':A:' . md5( $password );
3455 }
3456 }
3457
3458 /**
3459 * Compare a password hash with a plain-text password. Requires the user
3460 * ID if there's a chance that the hash is an old-style hash.
3461 *
3462 * @param $hash \string Password hash
3463 * @param $password \string Plain-text password to compare
3464 * @param $userId \string User ID for old-style password salt
3465 * @return \bool
3466 */
3467 static function comparePasswords( $hash, $password, $userId = false ) {
3468 $m = false;
3469 $type = substr( $hash, 0, 3 );
3470
3471 $result = false;
3472 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3473 return $result;
3474 }
3475
3476 if ( $type == ':A:' ) {
3477 # Unsalted
3478 return md5( $password ) === substr( $hash, 3 );
3479 } elseif ( $type == ':B:' ) {
3480 # Salted
3481 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3482 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3483 } else {
3484 # Old-style
3485 return self::oldCrypt( $password, $userId ) === $hash;
3486 }
3487 }
3488
3489 /**
3490 * Add a newuser log entry for this user
3491 * @param $byEmail Boolean: account made by email?
3492 */
3493 public function addNewUserLogEntry( $byEmail = false ) {
3494 global $wgUser, $wgContLang, $wgNewUserLog;
3495 if( empty($wgNewUserLog) ) {
3496 return true; // disabled
3497 }
3498 $talk = $wgContLang->getFormattedNsText( NS_TALK );
3499 if( $this->getName() == $wgUser->getName() ) {
3500 $action = 'create';
3501 $message = '';
3502 } else {
3503 $action = 'create2';
3504 $message = $byEmail ? wfMsgForContent( 'newuserlog-byemail' ) : '';
3505 }
3506 $log = new LogPage( 'newusers' );
3507 $log->addEntry( $action, $this->getUserPage(), $message, array( $this->getId() ) );
3508 return true;
3509 }
3510
3511 /**
3512 * Add an autocreate newuser log entry for this user
3513 * Used by things like CentralAuth and perhaps other authplugins.
3514 */
3515 public function addNewUserLogEntryAutoCreate() {
3516 global $wgNewUserLog;
3517 if( empty($wgNewUserLog) ) {
3518 return true; // disabled
3519 }
3520 $log = new LogPage( 'newusers', false );
3521 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3522 return true;
3523 }
3524
3525 protected function loadOptions() {
3526 $this->load();
3527 if ($this->mOptionsLoaded || !$this->getId() )
3528 return;
3529
3530 $this->mOptions = self::getDefaultOptions();
3531
3532 // Maybe load from the object
3533
3534 if ( !is_null($this->mOptionOverrides) ) {
3535 wfDebug( "Loading options for user ".$this->getId()." from override cache.\n" );
3536 foreach( $this->mOptionOverrides as $key => $value ) {
3537 $this->mOptions[$key] = $value;
3538 }
3539 } else {
3540 wfDebug( "Loading options for user ".$this->getId()." from database.\n" );
3541 // Load from database
3542 $dbr = wfGetDB( DB_SLAVE );
3543
3544 $res = $dbr->select( 'user_properties',
3545 '*',
3546 array('up_user' => $this->getId()),
3547 __METHOD__
3548 );
3549
3550 while( $row = $dbr->fetchObject( $res ) ) {
3551 $this->mOptionOverrides[$row->up_property] = $row->up_value;
3552 $this->mOptions[$row->up_property] = $row->up_value;
3553 }
3554 }
3555
3556 $this->mOptionsLoaded = true;
3557
3558 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions ) );
3559 }
3560
3561 protected function saveOptions() {
3562 global $wgAllowPrefChange;
3563
3564 $extuser = ExternalUser::newFromUser( $this );
3565
3566 $this->loadOptions();
3567 $dbw = wfGetDB( DB_MASTER );
3568
3569 $insert_rows = array();
3570
3571 $saveOptions = $this->mOptions;
3572
3573 // Allow hooks to abort, for instance to save to a global profile.
3574 // Reset options to default state before saving.
3575 if (!wfRunHooks( 'UserSaveOptions', array($this, &$saveOptions) ) )
3576 return;
3577
3578 foreach( $saveOptions as $key => $value ) {
3579 # Don't bother storing default values
3580 if ( ( is_null( self::getDefaultOption( $key ) ) &&
3581 !( $value === false || is_null($value) ) ) ||
3582 $value != self::getDefaultOption( $key ) ) {
3583 $insert_rows[] = array(
3584 'up_user' => $this->getId(),
3585 'up_property' => $key,
3586 'up_value' => $value,
3587 );
3588 }
3589 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3590 switch ( $wgAllowPrefChange[$key] ) {
3591 case 'local': case 'message':
3592 break;
3593 case 'semiglobal': case 'global':
3594 $extuser->setPref( $key, $value );
3595 }
3596 }
3597 }
3598
3599 $dbw->begin();
3600 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__ );
3601 $dbw->insert( 'user_properties', $insert_rows, __METHOD__ );
3602 $dbw->commit();
3603 }
3604
3605 /**
3606 * Provide an array of HTML 5 attributes to put on an input element
3607 * intended for the user to enter a new password. This may include
3608 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3609 *
3610 * Do *not* use this when asking the user to enter his current password!
3611 * Regardless of configuration, users may have invalid passwords for whatever
3612 * reason (e.g., they were set before requirements were tightened up).
3613 * Only use it when asking for a new password, like on account creation or
3614 * ResetPass.
3615 *
3616 * Obviously, you still need to do server-side checking.
3617 *
3618 * @return array Array of HTML attributes suitable for feeding to
3619 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3620 * That will potentially output invalid XHTML 1.0 Transitional, and will
3621 * get confused by the boolean attribute syntax used.)
3622 */
3623 public static function passwordChangeInputAttribs() {
3624 global $wgMinimalPasswordLength;
3625
3626 if ( $wgMinimalPasswordLength == 0 ) {
3627 return array();
3628 }
3629
3630 # Note that the pattern requirement will always be satisfied if the
3631 # input is empty, so we need required in all cases.
3632 $ret = array( 'required' );
3633
3634 # We can't actually do this right now, because Opera 9.6 will print out
3635 # the entered password visibly in its error message! When other
3636 # browsers add support for this attribute, or Opera fixes its support,
3637 # we can add support with a version check to avoid doing this on Opera
3638 # versions where it will be a problem. Reported to Opera as
3639 # DSK-262266, but they don't have a public bug tracker for us to follow.
3640 /*
3641 if ( $wgMinimalPasswordLength > 1 ) {
3642 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3643 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3644 $wgMinimalPasswordLength );
3645 }
3646 */
3647
3648 return $ret;
3649 }
3650 }