Feature karma: removing a useless feature that I recently committed.
[lhc/web/wiklou.git] / includes / User.php
1 <?php
2 /**
3 * See user.txt
4 *
5 * @package MediaWiki
6 */
7
8 /**
9 *
10 */
11 require_once( 'WatchedItem.php' );
12
13 # Number of characters in user_token field
14 define( 'USER_TOKEN_LENGTH', 32 );
15
16 # Serialized record version
17 define( 'MW_USER_VERSION', 3 );
18
19 /**
20 *
21 * @package MediaWiki
22 */
23 class User {
24 /**#@+
25 * @access private
26 */
27 var $mId, $mName, $mPassword, $mEmail, $mNewtalk;
28 var $mEmailAuthenticated;
29 var $mRights, $mOptions;
30 var $mDataLoaded, $mNewpassword;
31 var $mSkin;
32 var $mBlockedby, $mBlockreason;
33 var $mTouched;
34 var $mToken;
35 var $mRealName;
36 var $mHash;
37 var $mGroups;
38 var $mVersion; // serialized version
39 var $mRegistration;
40
41 /** Construct using User:loadDefaults() */
42 function User() {
43 $this->loadDefaults();
44 $this->mVersion = MW_USER_VERSION;
45 }
46
47 /**
48 * Static factory method
49 * @param string $name Username, validated by Title:newFromText()
50 * @return User
51 * @static
52 */
53 function newFromName( $name ) {
54 # Force usernames to capital
55 global $wgContLang;
56 $name = $wgContLang->ucfirst( $name );
57
58 # Clean up name according to title rules
59 $t = Title::newFromText( $name );
60 if( is_null( $t ) ) {
61 return null;
62 }
63
64 # Reject various classes of invalid names
65 $canonicalName = $t->getText();
66 global $wgAuth;
67 $canonicalName = $wgAuth->getCanonicalName( $t->getText() );
68
69 if( !User::isValidUserName( $canonicalName ) ) {
70 return null;
71 }
72
73 $u = new User();
74 $u->setName( $canonicalName );
75 $u->setId( $u->idFromName( $canonicalName ) );
76 return $u;
77 }
78
79 /**
80 * Factory method to fetch whichever use has a given email confirmation code.
81 * This code is generated when an account is created or its e-mail address
82 * has changed.
83 *
84 * If the code is invalid or has expired, returns NULL.
85 *
86 * @param string $code
87 * @return User
88 * @static
89 */
90 function newFromConfirmationCode( $code ) {
91 $dbr =& wfGetDB( DB_SLAVE );
92 $name = $dbr->selectField( 'user', 'user_name', array(
93 'user_email_token' => md5( $code ),
94 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
95 ) );
96 if( is_string( $name ) ) {
97 return User::newFromName( $name );
98 } else {
99 return null;
100 }
101 }
102
103 /**
104 * Serialze sleep function, for better cache efficiency and avoidance of
105 * silly "incomplete type" errors when skins are cached
106 */
107 function __sleep() {
108 return array( 'mId', 'mName', 'mPassword', 'mEmail', 'mNewtalk',
109 'mEmailAuthenticated', 'mRights', 'mOptions', 'mDataLoaded',
110 'mNewpassword', 'mBlockedby', 'mBlockreason', 'mTouched',
111 'mToken', 'mRealName', 'mHash', 'mGroups', 'mRegistration' );
112 }
113
114 /**
115 * Get username given an id.
116 * @param integer $id Database user id
117 * @return string Nickname of a user
118 * @static
119 */
120 function whoIs( $id ) {
121 $dbr =& wfGetDB( DB_SLAVE );
122 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
123 }
124
125 /**
126 * Get real username given an id.
127 * @param integer $id Database user id
128 * @return string Realname of a user
129 * @static
130 */
131 function whoIsReal( $id ) {
132 $dbr =& wfGetDB( DB_SLAVE );
133 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), 'User::whoIsReal' );
134 }
135
136 /**
137 * Get database id given a user name
138 * @param string $name Nickname of a user
139 * @return integer|null Database user id (null: if non existent
140 * @static
141 */
142 function idFromName( $name ) {
143 $fname = "User::idFromName";
144
145 $nt = Title::newFromText( $name );
146 if( is_null( $nt ) ) {
147 # Illegal name
148 return null;
149 }
150 $dbr =& wfGetDB( DB_SLAVE );
151 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), $fname );
152
153 if ( $s === false ) {
154 return 0;
155 } else {
156 return $s->user_id;
157 }
158 }
159
160 /**
161 * does the string match an anonymous IPv4 address?
162 *
163 * Note: We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
164 * address because the usemod software would "cloak" anonymous IP
165 * addresses like this, if we allowed accounts like this to be created
166 * new users could get the old edits of these anonymous users.
167 *
168 * @bug 3631
169 *
170 * @static
171 * @param string $name Nickname of a user
172 * @return bool
173 */
174 function isIP( $name ) {
175 return preg_match("/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/",$name);
176 /*return preg_match("/^
177 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
178 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
179 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
180 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))
181 $/x", $name);*/
182 }
183
184 /**
185 * Is the input a valid username?
186 *
187 * Checks if the input is a valid username, we don't want an empty string,
188 * an IP address, anything that containins slashes (would mess up subpages),
189 * is longer than the maximum allowed username size or doesn't begin with
190 * a capital letter.
191 *
192 * @param string $name
193 * @return bool
194 * @static
195 */
196 function isValidUserName( $name ) {
197 global $wgContLang, $wgMaxNameChars;
198
199 if ( $name == ''
200 || User::isIP( $name )
201 || strpos( $name, '/' ) !== false
202 || strlen( $name ) > $wgMaxNameChars
203 || $name != $wgContLang->ucfirst( $name ) )
204 return false;
205
206 // Ensure that the name can't be misresolved as a different title,
207 // such as with extra namespace keys at the start.
208 $parsed = Title::newFromText( $name );
209 if( is_null( $parsed )
210 || $parsed->getNamespace()
211 || strcmp( $name, $parsed->getPrefixedText() ) )
212 return false;
213 else
214 return true;
215 }
216
217 /**
218 * Is the input a valid password?
219 *
220 * @param string $password
221 * @return bool
222 * @static
223 */
224 function isValidPassword( $password ) {
225 global $wgMinimalPasswordLength;
226 return strlen( $password ) >= $wgMinimalPasswordLength;
227 }
228
229 /**
230 * Does the string match roughly an email address ?
231 *
232 * There used to be a regular expression here, it got removed because it
233 * rejected valid addresses. Actually just check if there is '@' somewhere
234 * in the given address.
235 *
236 * @todo Check for RFC 2822 compilance
237 * @bug 959
238 *
239 * @param string $addr email address
240 * @static
241 * @return bool
242 */
243 function isValidEmailAddr ( $addr ) {
244 return ( trim( $addr ) != '' ) &&
245 (false !== strpos( $addr, '@' ) );
246 }
247
248 /**
249 * Count the number of edits of a user
250 *
251 * @param int $uid The user ID to check
252 * @return int
253 */
254 function edits( $uid ) {
255 $fname = 'User::edits';
256
257 $dbr =& wfGetDB( DB_SLAVE );
258 return $dbr->selectField(
259 'revision', 'count(*)',
260 array( 'rev_user' => $uid ),
261 $fname
262 );
263 }
264
265 /**
266 * probably return a random password
267 * @return string probably a random password
268 * @static
269 * @todo Check what is doing really [AV]
270 */
271 function randomPassword() {
272 global $wgMinimalPasswordLength;
273 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
274 $l = strlen( $pwchars ) - 1;
275
276 $pwlength = max( 7, $wgMinimalPasswordLength );
277 $digit = mt_rand(0, $pwlength - 1);
278 $np = '';
279 for ( $i = 0; $i < $pwlength; $i++ ) {
280 $np .= $i == $digit ? chr( mt_rand(48, 57) ) : $pwchars{ mt_rand(0, $l)};
281 }
282 return $np;
283 }
284
285 /**
286 * Set properties to default
287 * Used at construction. It will load per language default settings only
288 * if we have an available language object.
289 */
290 function loadDefaults() {
291 static $n=0;
292 $n++;
293 $fname = 'User::loadDefaults' . $n;
294 wfProfileIn( $fname );
295
296 global $wgContLang, $wgDBname;
297 global $wgNamespacesToBeSearchedDefault;
298
299 $this->mId = 0;
300 $this->mNewtalk = -1;
301 $this->mName = false;
302 $this->mRealName = $this->mEmail = '';
303 $this->mEmailAuthenticated = null;
304 $this->mPassword = $this->mNewpassword = '';
305 $this->mRights = array();
306 $this->mGroups = array();
307 $this->mOptions = User::getDefaultOptions();
308
309 foreach( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
310 $this->mOptions['searchNs'.$nsnum] = $val;
311 }
312 unset( $this->mSkin );
313 $this->mDataLoaded = false;
314 $this->mBlockedby = -1; # Unset
315 $this->setToken(); # Random
316 $this->mHash = false;
317
318 if ( isset( $_COOKIE[$wgDBname.'LoggedOut'] ) ) {
319 $this->mTouched = wfTimestamp( TS_MW, $_COOKIE[$wgDBname.'LoggedOut'] );
320 }
321 else {
322 $this->mTouched = '0'; # Allow any pages to be cached
323 }
324
325 $this->mRegistration = wfTimestamp( TS_MW );
326
327 wfProfileOut( $fname );
328 }
329
330 /**
331 * Combine the language default options with any site-specific options
332 * and add the default language variants.
333 *
334 * @return array
335 * @static
336 * @access private
337 */
338 function getDefaultOptions() {
339 /**
340 * Site defaults will override the global/language defaults
341 */
342 global $wgContLang, $wgDefaultUserOptions;
343 $defOpt = $wgDefaultUserOptions + $wgContLang->getDefaultUserOptions();
344
345 /**
346 * default language setting
347 */
348 $variant = $wgContLang->getPreferredVariant();
349 $defOpt['variant'] = $variant;
350 $defOpt['language'] = $variant;
351
352 return $defOpt;
353 }
354
355 /**
356 * Get a given default option value.
357 *
358 * @param string $opt
359 * @return string
360 * @static
361 * @access public
362 */
363 function getDefaultOption( $opt ) {
364 $defOpts = User::getDefaultOptions();
365 if( isset( $defOpts[$opt] ) ) {
366 return $defOpts[$opt];
367 } else {
368 return '';
369 }
370 }
371
372 /**
373 * Get blocking information
374 * @access private
375 * @param bool $bFromSlave Specify whether to check slave or master. To improve performance,
376 * non-critical checks are done against slaves. Check when actually saving should be done against
377 * master.
378 */
379 function getBlockedStatus( $bFromSlave = true ) {
380 global $wgEnableSorbs, $wgProxyWhitelist;
381
382 if ( -1 != $this->mBlockedby ) {
383 wfDebug( "User::getBlockedStatus: already loaded.\n" );
384 return;
385 }
386
387 $fname = 'User::getBlockedStatus';
388 wfProfileIn( $fname );
389 wfDebug( "$fname: checking...\n" );
390
391 $this->mBlockedby = 0;
392 $ip = wfGetIP();
393
394 # User/IP blocking
395 $block = new Block();
396 $block->fromMaster( !$bFromSlave );
397 if ( $block->load( $ip , $this->mId ) ) {
398 wfDebug( "$fname: Found block.\n" );
399 $this->mBlockedby = $block->mBy;
400 $this->mBlockreason = $block->mReason;
401 if ( $this->isLoggedIn() ) {
402 $this->spreadBlock();
403 }
404 } else {
405 wfDebug( "$fname: No block.\n" );
406 }
407
408 # Proxy blocking
409 if ( !$this->isSysop() && !in_array( $ip, $wgProxyWhitelist ) ) {
410
411 # Local list
412 if ( wfIsLocallyBlockedProxy( $ip ) ) {
413 $this->mBlockedby = wfMsg( 'proxyblocker' );
414 $this->mBlockreason = wfMsg( 'proxyblockreason' );
415 }
416
417 # DNSBL
418 if ( !$this->mBlockedby && $wgEnableSorbs && !$this->getID() ) {
419 if ( $this->inSorbsBlacklist( $ip ) ) {
420 $this->mBlockedby = wfMsg( 'sorbs' );
421 $this->mBlockreason = wfMsg( 'sorbsreason' );
422 }
423 }
424 }
425
426 # Extensions
427 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
428
429 wfProfileOut( $fname );
430 }
431
432 function inSorbsBlacklist( $ip ) {
433 global $wgEnableSorbs;
434 return $wgEnableSorbs &&
435 $this->inDnsBlacklist( $ip, 'http.dnsbl.sorbs.net.' );
436 }
437
438 function inOpmBlacklist( $ip ) {
439 global $wgEnableOpm;
440 return $wgEnableOpm &&
441 $this->inDnsBlacklist( $ip, 'opm.blitzed.org.' );
442 }
443
444 function inDnsBlacklist( $ip, $base ) {
445 $fname = 'User::inDnsBlacklist';
446 wfProfileIn( $fname );
447
448 $found = false;
449 $host = '';
450
451 if ( preg_match( '/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/', $ip, $m ) ) {
452 # Make hostname
453 for ( $i=4; $i>=1; $i-- ) {
454 $host .= $m[$i] . '.';
455 }
456 $host .= $base;
457
458 # Send query
459 $ipList = gethostbynamel( $host );
460
461 if ( $ipList ) {
462 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
463 $found = true;
464 } else {
465 wfDebug( "Requested $host, not found in $base.\n" );
466 }
467 }
468
469 wfProfileOut( $fname );
470 return $found;
471 }
472
473 /**
474 * Primitive rate limits: enforce maximum actions per time period
475 * to put a brake on flooding.
476 *
477 * Note: when using a shared cache like memcached, IP-address
478 * last-hit counters will be shared across wikis.
479 *
480 * @return bool true if a rate limiter was tripped
481 * @access public
482 */
483 function pingLimiter( $action='edit' ) {
484 global $wgRateLimits;
485 if( !isset( $wgRateLimits[$action] ) ) {
486 return false;
487 }
488 if( $this->isAllowed( 'delete' ) ) {
489 // goddam cabal
490 return false;
491 }
492
493 global $wgMemc, $wgDBname, $wgRateLimitLog;
494 $fname = 'User::pingLimiter';
495 wfProfileIn( $fname );
496
497 $limits = $wgRateLimits[$action];
498 $keys = array();
499 $id = $this->getId();
500 $ip = wfGetIP();
501
502 if( isset( $limits['anon'] ) && $id == 0 ) {
503 $keys["$wgDBname:limiter:$action:anon"] = $limits['anon'];
504 }
505
506 if( isset( $limits['user'] ) && $id != 0 ) {
507 $keys["$wgDBname:limiter:$action:user:$id"] = $limits['user'];
508 }
509 if( $this->isNewbie() ) {
510 if( isset( $limits['newbie'] ) && $id != 0 ) {
511 $keys["$wgDBname:limiter:$action:user:$id"] = $limits['newbie'];
512 }
513 if( isset( $limits['ip'] ) ) {
514 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
515 }
516 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
517 $subnet = $matches[1];
518 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
519 }
520 }
521
522 $triggered = false;
523 foreach( $keys as $key => $limit ) {
524 list( $max, $period ) = $limit;
525 $summary = "(limit $max in {$period}s)";
526 $count = $wgMemc->get( $key );
527 if( $count ) {
528 if( $count > $max ) {
529 wfDebug( "$fname: tripped! $key at $count $summary\n" );
530 if( $wgRateLimitLog ) {
531 @error_log( wfTimestamp( TS_MW ) . ' ' . $wgDBname . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
532 }
533 $triggered = true;
534 } else {
535 wfDebug( "$fname: ok. $key at $count $summary\n" );
536 }
537 } else {
538 wfDebug( "$fname: adding record for $key $summary\n" );
539 $wgMemc->add( $key, 1, intval( $period ) );
540 }
541 $wgMemc->incr( $key );
542 }
543
544 wfProfileOut( $fname );
545 return $triggered;
546 }
547
548 /**
549 * Check if user is blocked
550 * @return bool True if blocked, false otherwise
551 */
552 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
553 wfDebug( "User::isBlocked: enter\n" );
554 $this->getBlockedStatus( $bFromSlave );
555 return $this->mBlockedby !== 0;
556 }
557
558 /**
559 * Check if user is blocked from editing a particular article
560 */
561 function isBlockedFrom( $title, $bFromSlave = false ) {
562 global $wgBlockAllowsUTEdit;
563 $fname = 'User::isBlockedFrom';
564 wfProfileIn( $fname );
565 wfDebug( "$fname: enter\n" );
566
567 if ( $wgBlockAllowsUTEdit && $title->getText() === $this->getName() &&
568 $title->getNamespace() == NS_USER_TALK )
569 {
570 $blocked = false;
571 wfDebug( "$fname: self-talk page, ignoring any blocks\n" );
572 } else {
573 wfDebug( "$fname: asking isBlocked()\n" );
574 $blocked = $this->isBlocked( $bFromSlave );
575 }
576 wfProfileOut( $fname );
577 return $blocked;
578 }
579
580 /**
581 * Get name of blocker
582 * @return string name of blocker
583 */
584 function blockedBy() {
585 $this->getBlockedStatus();
586 return $this->mBlockedby;
587 }
588
589 /**
590 * Get blocking reason
591 * @return string Blocking reason
592 */
593 function blockedFor() {
594 $this->getBlockedStatus();
595 return $this->mBlockreason;
596 }
597
598 /**
599 * Initialise php session
600 */
601 function SetupSession() {
602 global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain;
603 if( $wgSessionsInMemcached ) {
604 require_once( 'MemcachedSessions.php' );
605 } elseif( 'files' != ini_get( 'session.save_handler' ) ) {
606 # If it's left on 'user' or another setting from another
607 # application, it will end up failing. Try to recover.
608 ini_set ( 'session.save_handler', 'files' );
609 }
610 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain );
611 session_cache_limiter( 'private, must-revalidate' );
612 @session_start();
613 }
614
615 /**
616 * Create a new user object using data from session
617 * @static
618 */
619 function loadFromSession() {
620 global $wgMemc, $wgDBname;
621
622 if ( isset( $_SESSION['wsUserID'] ) ) {
623 if ( 0 != $_SESSION['wsUserID'] ) {
624 $sId = $_SESSION['wsUserID'];
625 } else {
626 return new User();
627 }
628 } else if ( isset( $_COOKIE["{$wgDBname}UserID"] ) ) {
629 $sId = intval( $_COOKIE["{$wgDBname}UserID"] );
630 $_SESSION['wsUserID'] = $sId;
631 } else {
632 return new User();
633 }
634 if ( isset( $_SESSION['wsUserName'] ) ) {
635 $sName = $_SESSION['wsUserName'];
636 } else if ( isset( $_COOKIE["{$wgDBname}UserName"] ) ) {
637 $sName = $_COOKIE["{$wgDBname}UserName"];
638 $_SESSION['wsUserName'] = $sName;
639 } else {
640 return new User();
641 }
642
643 $passwordCorrect = FALSE;
644 $user = $wgMemc->get( $key = "$wgDBname:user:id:$sId" );
645 if( !is_object( $user ) || $user->mVersion < MW_USER_VERSION ) {
646 # Expire old serialized objects; they may be corrupt.
647 $user = false;
648 }
649 if($makenew = !$user) {
650 wfDebug( "User::loadFromSession() unable to load from memcached\n" );
651 $user = new User();
652 $user->mId = $sId;
653 $user->loadFromDatabase();
654 } else {
655 wfDebug( "User::loadFromSession() got from cache!\n" );
656 }
657
658 if ( isset( $_SESSION['wsToken'] ) ) {
659 $passwordCorrect = $_SESSION['wsToken'] == $user->mToken;
660 } else if ( isset( $_COOKIE["{$wgDBname}Token"] ) ) {
661 $passwordCorrect = $user->mToken == $_COOKIE["{$wgDBname}Token"];
662 } else {
663 return new User(); # Can't log in from session
664 }
665
666 if ( ( $sName == $user->mName ) && $passwordCorrect ) {
667 if($makenew) {
668 if($wgMemc->set( $key, $user ))
669 wfDebug( "User::loadFromSession() successfully saved user\n" );
670 else
671 wfDebug( "User::loadFromSession() unable to save to memcached\n" );
672 }
673 return $user;
674 }
675 return new User(); # Can't log in from session
676 }
677
678 /**
679 * Load a user from the database
680 */
681 function loadFromDatabase() {
682 $fname = "User::loadFromDatabase";
683
684 # Counter-intuitive, breaks various things, use User::setLoaded() if you want to suppress
685 # loading in a command line script, don't assume all command line scripts need it like this
686 #if ( $this->mDataLoaded || $wgCommandLineMode ) {
687 if ( $this->mDataLoaded ) {
688 return;
689 }
690
691 # Paranoia
692 $this->mId = intval( $this->mId );
693
694 /** Anonymous user */
695 if( !$this->mId ) {
696 /** Get rights */
697 $this->mRights = $this->getGroupPermissions( array( '*' ) );
698 $this->mDataLoaded = true;
699 return;
700 } # the following stuff is for non-anonymous users only
701
702 $dbr =& wfGetDB( DB_SLAVE );
703 $s = $dbr->selectRow( 'user', array( 'user_name','user_password','user_newpassword','user_email',
704 'user_email_authenticated',
705 'user_real_name','user_options','user_touched', 'user_token', 'user_registration' ),
706 array( 'user_id' => $this->mId ), $fname );
707
708 if ( $s !== false ) {
709 $this->mName = $s->user_name;
710 $this->mEmail = $s->user_email;
711 $this->mEmailAuthenticated = wfTimestampOrNull( TS_MW, $s->user_email_authenticated );
712 $this->mRealName = $s->user_real_name;
713 $this->mPassword = $s->user_password;
714 $this->mNewpassword = $s->user_newpassword;
715 $this->decodeOptions( $s->user_options );
716 $this->mTouched = wfTimestamp(TS_MW,$s->user_touched);
717 $this->mToken = $s->user_token;
718 $this->mRegistration = wfTimestampOrNull( TS_MW, $s->user_registration );
719
720 $res = $dbr->select( 'user_groups',
721 array( 'ug_group' ),
722 array( 'ug_user' => $this->mId ),
723 $fname );
724 $this->mGroups = array();
725 while( $row = $dbr->fetchObject( $res ) ) {
726 $this->mGroups[] = $row->ug_group;
727 }
728 $implicitGroups = array( '*', 'user' );
729
730 global $wgAutoConfirmAge;
731 $accountAge = time() - wfTimestampOrNull( TS_UNIX, $this->mRegistration );
732 if( $accountAge >= $wgAutoConfirmAge ) {
733 $implicitGroups[] = 'autoconfirmed';
734 }
735
736 $effectiveGroups = array_merge( $implicitGroups, $this->mGroups );
737 $this->mRights = $this->getGroupPermissions( $effectiveGroups );
738 }
739
740 $this->mDataLoaded = true;
741 }
742
743 function getID() { return $this->mId; }
744 function setID( $v ) {
745 $this->mId = $v;
746 $this->mDataLoaded = false;
747 }
748
749 function getName() {
750 $this->loadFromDatabase();
751 if ( $this->mName === false ) {
752 $this->mName = wfGetIP();
753 }
754 return $this->mName;
755 }
756
757 function setName( $str ) {
758 $this->loadFromDatabase();
759 $this->mName = $str;
760 }
761
762
763 /**
764 * Return the title dbkey form of the name, for eg user pages.
765 * @return string
766 * @access public
767 */
768 function getTitleKey() {
769 return str_replace( ' ', '_', $this->getName() );
770 }
771
772 function getNewtalk() {
773 $this->loadFromDatabase();
774
775 # Load the newtalk status if it is unloaded (mNewtalk=-1)
776 if( $this->mNewtalk === -1 ) {
777 $this->mNewtalk = false; # reset talk page status
778
779 # Check memcached separately for anons, who have no
780 # entire User object stored in there.
781 if( !$this->mId ) {
782 global $wgDBname, $wgMemc;
783 $key = "$wgDBname:newtalk:ip:" . $this->getName();
784 $newtalk = $wgMemc->get( $key );
785 if( is_integer( $newtalk ) ) {
786 $this->mNewtalk = (bool)$newtalk;
787 } else {
788 $this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName() );
789 $wgMemc->set( $key, $this->mNewtalk, time() ); // + 1800 );
790 }
791 } else {
792 $this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
793 }
794 }
795
796 return (bool)$this->mNewtalk;
797 }
798
799 /**
800 * Perform a user_newtalk check on current slaves; if the memcached data
801 * is funky we don't want newtalk state to get stuck on save, as that's
802 * damn annoying.
803 *
804 * @param string $field
805 * @param mixed $id
806 * @return bool
807 * @access private
808 */
809 function checkNewtalk( $field, $id ) {
810 $fname = 'User::checkNewtalk';
811 $dbr =& wfGetDB( DB_SLAVE );
812 $ok = $dbr->selectField( 'user_newtalk', $field,
813 array( $field => $id ), $fname );
814 return $ok !== false;
815 }
816
817 /**
818 * Add or update the
819 * @param string $field
820 * @param mixed $id
821 * @access private
822 */
823 function updateNewtalk( $field, $id ) {
824 $fname = 'User::updateNewtalk';
825 if( $this->checkNewtalk( $field, $id ) ) {
826 wfDebug( "$fname already set ($field, $id), ignoring\n" );
827 return false;
828 }
829 $dbw =& wfGetDB( DB_MASTER );
830 $dbw->insert( 'user_newtalk',
831 array( $field => $id ),
832 $fname,
833 'IGNORE' );
834 wfDebug( "$fname: set on ($field, $id)\n" );
835 return true;
836 }
837
838 /**
839 * Clear the new messages flag for the given user
840 * @param string $field
841 * @param mixed $id
842 * @access private
843 */
844 function deleteNewtalk( $field, $id ) {
845 $fname = 'User::deleteNewtalk';
846 if( !$this->checkNewtalk( $field, $id ) ) {
847 wfDebug( "$fname: already gone ($field, $id), ignoring\n" );
848 return false;
849 }
850 $dbw =& wfGetDB( DB_MASTER );
851 $dbw->delete( 'user_newtalk',
852 array( $field => $id ),
853 $fname );
854 wfDebug( "$fname: killed on ($field, $id)\n" );
855 return true;
856 }
857
858 /**
859 * Update the 'You have new messages!' status.
860 * @param bool $val
861 */
862 function setNewtalk( $val ) {
863 if( wfReadOnly() ) {
864 return;
865 }
866
867 $this->loadFromDatabase();
868 $this->mNewtalk = $val;
869
870 $fname = 'User::setNewtalk';
871
872 if( $this->isAnon() ) {
873 $field = 'user_ip';
874 $id = $this->getName();
875 } else {
876 $field = 'user_id';
877 $id = $this->getId();
878 }
879
880 if( $val ) {
881 $changed = $this->updateNewtalk( $field, $id );
882 } else {
883 $changed = $this->deleteNewtalk( $field, $id );
884 }
885
886 if( $changed ) {
887 if( $this->isAnon() ) {
888 // Anons have a separate memcached space, since
889 // user records aren't kept for them.
890 global $wgDBname, $wgMemc;
891 $key = "$wgDBname:newtalk:ip:$val";
892 $wgMemc->set( $key, $val ? 1 : 0 );
893 } else {
894 if( $val ) {
895 // Make sure the user page is watched, so a notification
896 // will be sent out if enabled.
897 $this->addWatch( $this->getTalkPage() );
898 }
899 }
900 $this->invalidateCache();
901 $this->saveSettings();
902 }
903 }
904
905 function invalidateCache() {
906 global $wgClockSkewFudge;
907 $this->loadFromDatabase();
908 $this->mTouched = wfTimestamp(TS_MW, time() + $wgClockSkewFudge );
909 # Don't forget to save the options after this or
910 # it won't take effect!
911 }
912
913 function validateCache( $timestamp ) {
914 $this->loadFromDatabase();
915 return ($timestamp >= $this->mTouched);
916 }
917
918 /**
919 * Encrypt a password.
920 * It can eventuall salt a password @see User::addSalt()
921 * @param string $p clear Password.
922 * @return string Encrypted password.
923 */
924 function encryptPassword( $p ) {
925 return wfEncryptPassword( $this->mId, $p );
926 }
927
928 # Set the password and reset the random token
929 function setPassword( $str ) {
930 $this->loadFromDatabase();
931 $this->setToken();
932 $this->mPassword = $this->encryptPassword( $str );
933 $this->mNewpassword = '';
934 }
935
936 # Set the random token (used for persistent authentication)
937 function setToken( $token = false ) {
938 global $wgSecretKey, $wgProxyKey, $wgDBname;
939 if ( !$token ) {
940 if ( $wgSecretKey ) {
941 $key = $wgSecretKey;
942 } elseif ( $wgProxyKey ) {
943 $key = $wgProxyKey;
944 } else {
945 $key = microtime();
946 }
947 $this->mToken = md5( $key . mt_rand( 0, 0x7fffffff ) . $wgDBname . $this->mId );
948 } else {
949 $this->mToken = $token;
950 }
951 }
952
953
954 function setCookiePassword( $str ) {
955 $this->loadFromDatabase();
956 $this->mCookiePassword = md5( $str );
957 }
958
959 function setNewpassword( $str ) {
960 $this->loadFromDatabase();
961 $this->mNewpassword = $this->encryptPassword( $str );
962 }
963
964 function getEmail() {
965 $this->loadFromDatabase();
966 return $this->mEmail;
967 }
968
969 function getEmailAuthenticationTimestamp() {
970 $this->loadFromDatabase();
971 return $this->mEmailAuthenticated;
972 }
973
974 function setEmail( $str ) {
975 $this->loadFromDatabase();
976 $this->mEmail = $str;
977 }
978
979 function getRealName() {
980 $this->loadFromDatabase();
981 return $this->mRealName;
982 }
983
984 function setRealName( $str ) {
985 $this->loadFromDatabase();
986 $this->mRealName = $str;
987 }
988
989 /**
990 * @param string $oname The option to check
991 * @return string
992 */
993 function getOption( $oname ) {
994 $this->loadFromDatabase();
995 if ( array_key_exists( $oname, $this->mOptions ) ) {
996 return trim( $this->mOptions[$oname] );
997 } else {
998 return '';
999 }
1000 }
1001
1002 /**
1003 * @param string $oname The option to check
1004 * @return bool False if the option is not selected, true if it is
1005 */
1006 function getBoolOption( $oname ) {
1007 return (bool)$this->getOption( $oname );
1008 }
1009
1010 function setOption( $oname, $val ) {
1011 $this->loadFromDatabase();
1012 if ( $oname == 'skin' ) {
1013 # Clear cached skin, so the new one displays immediately in Special:Preferences
1014 unset( $this->mSkin );
1015 }
1016 $this->mOptions[$oname] = $val;
1017 $this->invalidateCache();
1018 }
1019
1020 function getRights() {
1021 $this->loadFromDatabase();
1022 return $this->mRights;
1023 }
1024
1025 /**
1026 * Get the list of explicit group memberships this user has.
1027 * The implicit * and user groups are not included.
1028 * @return array of strings
1029 */
1030 function getGroups() {
1031 $this->loadFromDatabase();
1032 return $this->mGroups;
1033 }
1034
1035 /**
1036 * Get the list of implicit group memberships this user has.
1037 * This includes all explicit groups, plus 'user' if logged in
1038 * and '*' for all accounts.
1039 * @return array of strings
1040 */
1041 function getEffectiveGroups() {
1042 $base = array( '*' );
1043 if( $this->isLoggedIn() ) {
1044 $base[] = 'user';
1045 }
1046 return array_merge( $base, $this->getGroups() );
1047 }
1048
1049 /**
1050 * Add the user to the given group.
1051 * This takes immediate effect.
1052 * @string $group
1053 */
1054 function addGroup( $group ) {
1055 $dbw =& wfGetDB( DB_MASTER );
1056 $dbw->insert( 'user_groups',
1057 array(
1058 'ug_user' => $this->getID(),
1059 'ug_group' => $group,
1060 ),
1061 'User::addGroup',
1062 array( 'IGNORE' ) );
1063
1064 $this->mGroups = array_merge( $this->mGroups, array( $group ) );
1065 $this->mRights = User::getGroupPermissions( $this->getEffectiveGroups() );
1066
1067 $this->invalidateCache();
1068 $this->saveSettings();
1069 }
1070
1071 /**
1072 * Remove the user from the given group.
1073 * This takes immediate effect.
1074 * @string $group
1075 */
1076 function removeGroup( $group ) {
1077 $dbw =& wfGetDB( DB_MASTER );
1078 $dbw->delete( 'user_groups',
1079 array(
1080 'ug_user' => $this->getID(),
1081 'ug_group' => $group,
1082 ),
1083 'User::removeGroup' );
1084
1085 $this->mGroups = array_diff( $this->mGroups, array( $group ) );
1086 $this->mRights = User::getGroupPermissions( $this->getEffectiveGroups() );
1087
1088 $this->invalidateCache();
1089 $this->saveSettings();
1090 }
1091
1092
1093 /**
1094 * A more legible check for non-anonymousness.
1095 * Returns true if the user is not an anonymous visitor.
1096 *
1097 * @return bool
1098 */
1099 function isLoggedIn() {
1100 return( $this->getID() != 0 );
1101 }
1102
1103 /**
1104 * A more legible check for anonymousness.
1105 * Returns true if the user is an anonymous visitor.
1106 *
1107 * @return bool
1108 */
1109 function isAnon() {
1110 return !$this->isLoggedIn();
1111 }
1112
1113 /**
1114 * Check if a user is sysop
1115 * @deprecated
1116 */
1117 function isSysop() {
1118 return $this->isAllowed( 'protect' );
1119 }
1120
1121 /** @deprecated */
1122 function isDeveloper() {
1123 return $this->isAllowed( 'siteadmin' );
1124 }
1125
1126 /** @deprecated */
1127 function isBureaucrat() {
1128 return $this->isAllowed( 'makesysop' );
1129 }
1130
1131 /**
1132 * Whether the user is a bot
1133 * @todo need to be migrated to the new user level management sytem
1134 */
1135 function isBot() {
1136 $this->loadFromDatabase();
1137 return in_array( 'bot', $this->mRights );
1138 }
1139
1140 /**
1141 * Check if user is allowed to access a feature / make an action
1142 * @param string $action Action to be checked (see $wgAvailableRights in Defines.php for possible actions).
1143 * @return boolean True: action is allowed, False: action should not be allowed
1144 */
1145 function isAllowed($action='') {
1146 if ( $action === '' )
1147 // In the spirit of DWIM
1148 return true;
1149
1150 $this->loadFromDatabase();
1151 return in_array( $action , $this->mRights );
1152 }
1153
1154 /**
1155 * Load a skin if it doesn't exist or return it
1156 * @todo FIXME : need to check the old failback system [AV]
1157 */
1158 function &getSkin() {
1159 global $IP, $wgRequest;
1160 if ( ! isset( $this->mSkin ) ) {
1161 $fname = 'User::getSkin';
1162 wfProfileIn( $fname );
1163
1164 # get the user skin
1165 $userSkin = $this->getOption( 'skin' );
1166 $userSkin = $wgRequest->getVal('useskin', $userSkin);
1167
1168 $this->mSkin =& Skin::newFromKey( $userSkin );
1169 wfProfileOut( $fname );
1170 }
1171 return $this->mSkin;
1172 }
1173
1174 /**#@+
1175 * @param string $title Article title to look at
1176 */
1177
1178 /**
1179 * Check watched status of an article
1180 * @return bool True if article is watched
1181 */
1182 function isWatched( $title ) {
1183 $wl = WatchedItem::fromUserTitle( $this, $title );
1184 return $wl->isWatched();
1185 }
1186
1187 /**
1188 * Watch an article
1189 */
1190 function addWatch( $title ) {
1191 $wl = WatchedItem::fromUserTitle( $this, $title );
1192 $wl->addWatch();
1193 $this->invalidateCache();
1194 }
1195
1196 /**
1197 * Stop watching an article
1198 */
1199 function removeWatch( $title ) {
1200 $wl = WatchedItem::fromUserTitle( $this, $title );
1201 $wl->removeWatch();
1202 $this->invalidateCache();
1203 }
1204
1205 /**
1206 * Clear the user's notification timestamp for the given title.
1207 * If e-notif e-mails are on, they will receive notification mails on
1208 * the next change of the page if it's watched etc.
1209 */
1210 function clearNotification( &$title ) {
1211 global $wgUser, $wgUseEnotif;
1212
1213 if ($title->getNamespace() == NS_USER_TALK &&
1214 $title->getText() == $this->getName() ) {
1215 $this->setNewtalk( false );
1216 }
1217
1218 if( !$wgUseEnotif ) {
1219 return;
1220 }
1221
1222 if( $this->isAnon() ) {
1223 // Nothing else to do...
1224 return;
1225 }
1226
1227 // Only update the timestamp if the page is being watched.
1228 // The query to find out if it is watched is cached both in memcached and per-invocation,
1229 // and when it does have to be executed, it can be on a slave
1230 // If this is the user's newtalk page, we always update the timestamp
1231 if ($title->getNamespace() == NS_USER_TALK &&
1232 $title->getText() == $wgUser->getName())
1233 {
1234 $watched = true;
1235 } elseif ( $this->getID() == $wgUser->getID() ) {
1236 $watched = $title->userIsWatching();
1237 } else {
1238 $watched = true;
1239 }
1240
1241 // If the page is watched by the user (or may be watched), update the timestamp on any
1242 // any matching rows
1243 if ( $watched ) {
1244 $dbw =& wfGetDB( DB_MASTER );
1245 $success = $dbw->update( 'watchlist',
1246 array( /* SET */
1247 'wl_notificationtimestamp' => NULL
1248 ), array( /* WHERE */
1249 'wl_title' => $title->getDBkey(),
1250 'wl_namespace' => $title->getNamespace(),
1251 'wl_user' => $this->getID()
1252 ), 'User::clearLastVisited'
1253 );
1254 }
1255 }
1256
1257 /**#@-*/
1258
1259 /**
1260 * Resets all of the given user's page-change notification timestamps.
1261 * If e-notif e-mails are on, they will receive notification mails on
1262 * the next change of any watched page.
1263 *
1264 * @param int $currentUser user ID number
1265 * @access public
1266 */
1267 function clearAllNotifications( $currentUser ) {
1268 global $wgUseEnotif;
1269 if ( !$wgUseEnotif ) {
1270 $this->setNewtalk( false );
1271 return;
1272 }
1273 if( $currentUser != 0 ) {
1274
1275 $dbw =& wfGetDB( DB_MASTER );
1276 $success = $dbw->update( 'watchlist',
1277 array( /* SET */
1278 'wl_notificationtimestamp' => 0
1279 ), array( /* WHERE */
1280 'wl_user' => $currentUser
1281 ), 'UserMailer::clearAll'
1282 );
1283
1284 # we also need to clear here the "you have new message" notification for the own user_talk page
1285 # This is cleared one page view later in Article::viewUpdates();
1286 }
1287 }
1288
1289 /**
1290 * @access private
1291 * @return string Encoding options
1292 */
1293 function encodeOptions() {
1294 $a = array();
1295 foreach ( $this->mOptions as $oname => $oval ) {
1296 array_push( $a, $oname.'='.$oval );
1297 }
1298 $s = implode( "\n", $a );
1299 return $s;
1300 }
1301
1302 /**
1303 * @access private
1304 */
1305 function decodeOptions( $str ) {
1306 $a = explode( "\n", $str );
1307 foreach ( $a as $s ) {
1308 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
1309 $this->mOptions[$m[1]] = $m[2];
1310 }
1311 }
1312 }
1313
1314 function setCookies() {
1315 global $wgCookieExpiration, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgDBname;
1316 if ( 0 == $this->mId ) return;
1317 $this->loadFromDatabase();
1318 $exp = time() + $wgCookieExpiration;
1319
1320 $_SESSION['wsUserID'] = $this->mId;
1321 setcookie( $wgDBname.'UserID', $this->mId, $exp, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1322
1323 $_SESSION['wsUserName'] = $this->getName();
1324 setcookie( $wgDBname.'UserName', $this->getName(), $exp, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1325
1326 $_SESSION['wsToken'] = $this->mToken;
1327 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
1328 setcookie( $wgDBname.'Token', $this->mToken, $exp, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1329 } else {
1330 setcookie( $wgDBname.'Token', '', time() - 3600 );
1331 }
1332 }
1333
1334 /**
1335 * Logout user
1336 * It will clean the session cookie
1337 */
1338 function logout() {
1339 global $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgDBname;
1340 $this->loadDefaults();
1341 $this->setLoaded( true );
1342
1343 $_SESSION['wsUserID'] = 0;
1344
1345 setcookie( $wgDBname.'UserID', '', time() - 3600, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1346 setcookie( $wgDBname.'Token', '', time() - 3600, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1347
1348 # Remember when user logged out, to prevent seeing cached pages
1349 setcookie( $wgDBname.'LoggedOut', wfTimestampNow(), time() + 86400, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1350 }
1351
1352 /**
1353 * Save object settings into database
1354 */
1355 function saveSettings() {
1356 global $wgMemc, $wgDBname, $wgUseEnotif;
1357 $fname = 'User::saveSettings';
1358
1359 if ( wfReadOnly() ) { return; }
1360 if ( 0 == $this->mId ) { return; }
1361
1362 $dbw =& wfGetDB( DB_MASTER );
1363 $dbw->update( 'user',
1364 array( /* SET */
1365 'user_name' => $this->mName,
1366 'user_password' => $this->mPassword,
1367 'user_newpassword' => $this->mNewpassword,
1368 'user_real_name' => $this->mRealName,
1369 'user_email' => $this->mEmail,
1370 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
1371 'user_options' => $this->encodeOptions(),
1372 'user_touched' => $dbw->timestamp($this->mTouched),
1373 'user_token' => $this->mToken
1374 ), array( /* WHERE */
1375 'user_id' => $this->mId
1376 ), $fname
1377 );
1378 $wgMemc->delete( "$wgDBname:user:id:$this->mId" );
1379 }
1380
1381
1382 /**
1383 * Checks if a user with the given name exists, returns the ID
1384 */
1385 function idForName() {
1386 $fname = 'User::idForName';
1387
1388 $gotid = 0;
1389 $s = trim( $this->getName() );
1390 if ( 0 == strcmp( '', $s ) ) return 0;
1391
1392 $dbr =& wfGetDB( DB_SLAVE );
1393 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), $fname );
1394 if ( $id === false ) {
1395 $id = 0;
1396 }
1397 return $id;
1398 }
1399
1400 /**
1401 * Add user object to the database
1402 */
1403 function addToDatabase() {
1404 $fname = 'User::addToDatabase';
1405 $dbw =& wfGetDB( DB_MASTER );
1406 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
1407 $dbw->insert( 'user',
1408 array(
1409 'user_id' => $seqVal,
1410 'user_name' => $this->mName,
1411 'user_password' => $this->mPassword,
1412 'user_newpassword' => $this->mNewpassword,
1413 'user_email' => $this->mEmail,
1414 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
1415 'user_real_name' => $this->mRealName,
1416 'user_options' => $this->encodeOptions(),
1417 'user_token' => $this->mToken,
1418 'user_registration' => $dbw->timestamp( $this->mRegistration ),
1419 ), $fname
1420 );
1421 $this->mId = $dbw->insertId();
1422 }
1423
1424 function spreadBlock() {
1425 # If the (non-anonymous) user is blocked, this function will block any IP address
1426 # that they successfully log on from.
1427 $fname = 'User::spreadBlock';
1428
1429 wfDebug( "User:spreadBlock()\n" );
1430 if ( $this->mId == 0 ) {
1431 return;
1432 }
1433
1434 $userblock = Block::newFromDB( '', $this->mId );
1435 if ( !$userblock->isValid() ) {
1436 return;
1437 }
1438
1439 # Check if this IP address is already blocked
1440 $ipblock = Block::newFromDB( wfGetIP() );
1441 if ( $ipblock->isValid() ) {
1442 # If the user is already blocked. Then check if the autoblock would
1443 # excede the user block. If it would excede, then do nothing, else
1444 # prolong block time
1445 if ($userblock->mExpiry &&
1446 ($userblock->mExpiry < Block::getAutoblockExpiry($ipblock->mTimestamp))) {
1447 return;
1448 }
1449 # Just update the timestamp
1450 $ipblock->updateTimestamp();
1451 return;
1452 }
1453
1454 # Make a new block object with the desired properties
1455 wfDebug( "Autoblocking {$this->mName}@" . wfGetIP() . "\n" );
1456 $ipblock->mAddress = wfGetIP();
1457 $ipblock->mUser = 0;
1458 $ipblock->mBy = $userblock->mBy;
1459 $ipblock->mReason = wfMsg( 'autoblocker', $this->getName(), $userblock->mReason );
1460 $ipblock->mTimestamp = wfTimestampNow();
1461 $ipblock->mAuto = 1;
1462 # If the user is already blocked with an expiry date, we don't
1463 # want to pile on top of that!
1464 if($userblock->mExpiry) {
1465 $ipblock->mExpiry = min ( $userblock->mExpiry, Block::getAutoblockExpiry( $ipblock->mTimestamp ));
1466 } else {
1467 $ipblock->mExpiry = Block::getAutoblockExpiry( $ipblock->mTimestamp );
1468 }
1469
1470 # Insert it
1471 $ipblock->insert();
1472
1473 }
1474
1475 /**
1476 * Generate a string which will be different for any combination of
1477 * user options which would produce different parser output.
1478 * This will be used as part of the hash key for the parser cache,
1479 * so users will the same options can share the same cached data
1480 * safely.
1481 *
1482 * Extensions which require it should install 'PageRenderingHash' hook,
1483 * which will give them a chance to modify this key based on their own
1484 * settings.
1485 *
1486 * @return string
1487 */
1488 function getPageRenderingHash() {
1489 global $wgContLang;
1490 if( $this->mHash ){
1491 return $this->mHash;
1492 }
1493
1494 // stubthreshold is only included below for completeness,
1495 // it will always be 0 when this function is called by parsercache.
1496
1497 $confstr = $this->getOption( 'math' );
1498 $confstr .= '!' . $this->getOption( 'stubthreshold' );
1499 $confstr .= '!' . $this->getOption( 'date' );
1500 $confstr .= '!' . ($this->getOption( 'numberheadings' ) ? '1' : '');
1501 $confstr .= '!' . $this->getOption( 'language' );
1502 $confstr .= '!' . $this->getOption( 'thumbsize' );
1503 // add in language specific options, if any
1504 $extra = $wgContLang->getExtraHashOptions();
1505 $confstr .= $extra;
1506
1507 // Give a chance for extensions to modify the hash, if they have
1508 // extra options or other effects on the parser cache.
1509 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
1510
1511 $this->mHash = $confstr;
1512 return $confstr;
1513 }
1514
1515 function isAllowedToCreateAccount() {
1516 return $this->isAllowed( 'createaccount' ) && !$this->isBlocked();
1517 }
1518
1519 /**
1520 * Set mDataLoaded, return previous value
1521 * Use this to prevent DB access in command-line scripts or similar situations
1522 */
1523 function setLoaded( $loaded ) {
1524 return wfSetVar( $this->mDataLoaded, $loaded );
1525 }
1526
1527 /**
1528 * Get this user's personal page title.
1529 *
1530 * @return Title
1531 * @access public
1532 */
1533 function getUserPage() {
1534 return Title::makeTitle( NS_USER, $this->getName() );
1535 }
1536
1537 /**
1538 * Get this user's talk page title.
1539 *
1540 * @return Title
1541 * @access public
1542 */
1543 function getTalkPage() {
1544 $title = $this->getUserPage();
1545 return $title->getTalkPage();
1546 }
1547
1548 /**
1549 * @static
1550 */
1551 function getMaxID() {
1552 static $res; // cache
1553
1554 if ( isset( $res ) )
1555 return $res;
1556 else {
1557 $dbr =& wfGetDB( DB_SLAVE );
1558 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
1559 }
1560 }
1561
1562 /**
1563 * Determine whether the user is a newbie. Newbies are either
1564 * anonymous IPs, or the most recently created accounts.
1565 * @return bool True if it is a newbie.
1566 */
1567 function isNewbie() {
1568 return !$this->isAllowed( 'autoconfirmed' );
1569 }
1570
1571 /**
1572 * Check to see if the given clear-text password is one of the accepted passwords
1573 * @param string $password User password.
1574 * @return bool True if the given password is correct otherwise False.
1575 */
1576 function checkPassword( $password ) {
1577 global $wgAuth, $wgMinimalPasswordLength;
1578 $this->loadFromDatabase();
1579
1580 // Even though we stop people from creating passwords that
1581 // are shorter than this, doesn't mean people wont be able
1582 // to. Certain authentication plugins do NOT want to save
1583 // domain passwords in a mysql database, so we should
1584 // check this (incase $wgAuth->strict() is false).
1585 if( strlen( $password ) < $wgMinimalPasswordLength ) {
1586 return false;
1587 }
1588
1589 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
1590 return true;
1591 } elseif( $wgAuth->strict() ) {
1592 /* Auth plugin doesn't allow local authentication */
1593 return false;
1594 }
1595 $ep = $this->encryptPassword( $password );
1596 if ( 0 == strcmp( $ep, $this->mPassword ) ) {
1597 return true;
1598 } elseif ( ($this->mNewpassword != '') && (0 == strcmp( $ep, $this->mNewpassword )) ) {
1599 return true;
1600 } elseif ( function_exists( 'iconv' ) ) {
1601 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
1602 # Check for this with iconv
1603 $cp1252hash = $this->encryptPassword( iconv( 'UTF-8', 'WINDOWS-1252', $password ) );
1604 if ( 0 == strcmp( $cp1252hash, $this->mPassword ) ) {
1605 return true;
1606 }
1607 }
1608 return false;
1609 }
1610
1611 /**
1612 * Initialize (if necessary) and return a session token value
1613 * which can be used in edit forms to show that the user's
1614 * login credentials aren't being hijacked with a foreign form
1615 * submission.
1616 *
1617 * @param mixed $salt - Optional function-specific data for hash.
1618 * Use a string or an array of strings.
1619 * @return string
1620 * @access public
1621 */
1622 function editToken( $salt = '' ) {
1623 if( !isset( $_SESSION['wsEditToken'] ) ) {
1624 $token = $this->generateToken();
1625 $_SESSION['wsEditToken'] = $token;
1626 } else {
1627 $token = $_SESSION['wsEditToken'];
1628 }
1629 if( is_array( $salt ) ) {
1630 $salt = implode( '|', $salt );
1631 }
1632 return md5( $token . $salt );
1633 }
1634
1635 /**
1636 * Generate a hex-y looking random token for various uses.
1637 * Could be made more cryptographically sure if someone cares.
1638 * @return string
1639 */
1640 function generateToken( $salt = '' ) {
1641 $token = dechex( mt_rand() ) . dechex( mt_rand() );
1642 return md5( $token . $salt );
1643 }
1644
1645 /**
1646 * Check given value against the token value stored in the session.
1647 * A match should confirm that the form was submitted from the
1648 * user's own login session, not a form submission from a third-party
1649 * site.
1650 *
1651 * @param string $val - the input value to compare
1652 * @param string $salt - Optional function-specific data for hash
1653 * @return bool
1654 * @access public
1655 */
1656 function matchEditToken( $val, $salt = '' ) {
1657 global $wgMemc;
1658
1659 /*
1660 if ( !isset( $_SESSION['wsEditToken'] ) ) {
1661 $logfile = '/home/wikipedia/logs/session_debug/session.log';
1662 $mckey = memsess_key( session_id() );
1663 $uname = @posix_uname();
1664 $msg = "wsEditToken not set!\n" .
1665 'apache server=' . $uname['nodename'] . "\n" .
1666 'session_id = ' . session_id() . "\n" .
1667 '$_SESSION=' . var_export( $_SESSION, true ) . "\n" .
1668 '$_COOKIE=' . var_export( $_COOKIE, true ) . "\n" .
1669 "mc get($mckey) = " . var_export( $wgMemc->get( $mckey ), true ) . "\n\n\n";
1670
1671 @error_log( $msg, 3, $logfile );
1672 }
1673 */
1674 return ( $val == $this->editToken( $salt ) );
1675 }
1676
1677 /**
1678 * Generate a new e-mail confirmation token and send a confirmation
1679 * mail to the user's given address.
1680 *
1681 * @return mixed True on success, a WikiError object on failure.
1682 */
1683 function sendConfirmationMail() {
1684 global $wgContLang;
1685 $url = $this->confirmationTokenUrl( $expiration );
1686 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
1687 wfMsg( 'confirmemail_body',
1688 wfGetIP(),
1689 $this->getName(),
1690 $url,
1691 $wgContLang->timeanddate( $expiration, false ) ) );
1692 }
1693
1694 /**
1695 * Send an e-mail to this user's account. Does not check for
1696 * confirmed status or validity.
1697 *
1698 * @param string $subject
1699 * @param string $body
1700 * @param strong $from Optional from address; default $wgPasswordSender will be used otherwise.
1701 * @return mixed True on success, a WikiError object on failure.
1702 */
1703 function sendMail( $subject, $body, $from = null ) {
1704 if( is_null( $from ) ) {
1705 global $wgPasswordSender;
1706 $from = $wgPasswordSender;
1707 }
1708
1709 require_once( 'UserMailer.php' );
1710 $to = new MailAddress( $this );
1711 $sender = new MailAddress( $from );
1712 $error = userMailer( $to, $sender, $subject, $body );
1713
1714 if( $error == '' ) {
1715 return true;
1716 } else {
1717 return new WikiError( $error );
1718 }
1719 }
1720
1721 /**
1722 * Generate, store, and return a new e-mail confirmation code.
1723 * A hash (unsalted since it's used as a key) is stored.
1724 * @param &$expiration mixed output: accepts the expiration time
1725 * @return string
1726 * @access private
1727 */
1728 function confirmationToken( &$expiration ) {
1729 $fname = 'User::confirmationToken';
1730
1731 $now = time();
1732 $expires = $now + 7 * 24 * 60 * 60;
1733 $expiration = wfTimestamp( TS_MW, $expires );
1734
1735 $token = $this->generateToken( $this->mId . $this->mEmail . $expires );
1736 $hash = md5( $token );
1737
1738 $dbw =& wfGetDB( DB_MASTER );
1739 $dbw->update( 'user',
1740 array( 'user_email_token' => $hash,
1741 'user_email_token_expires' => $dbw->timestamp( $expires ) ),
1742 array( 'user_id' => $this->mId ),
1743 $fname );
1744
1745 return $token;
1746 }
1747
1748 /**
1749 * Generate and store a new e-mail confirmation token, and return
1750 * the URL the user can use to confirm.
1751 * @param &$expiration mixed output: accepts the expiration time
1752 * @return string
1753 * @access private
1754 */
1755 function confirmationTokenUrl( &$expiration ) {
1756 $token = $this->confirmationToken( $expiration );
1757 $title = Title::makeTitle( NS_SPECIAL, 'Confirmemail/' . $token );
1758 return $title->getFullUrl();
1759 }
1760
1761 /**
1762 * Mark the e-mail address confirmed and save.
1763 */
1764 function confirmEmail() {
1765 $this->loadFromDatabase();
1766 $this->mEmailAuthenticated = wfTimestampNow();
1767 $this->saveSettings();
1768 return true;
1769 }
1770
1771 /**
1772 * Is this user allowed to send e-mails within limits of current
1773 * site configuration?
1774 * @return bool
1775 */
1776 function canSendEmail() {
1777 return $this->isEmailConfirmed();
1778 }
1779
1780 /**
1781 * Is this user allowed to receive e-mails within limits of current
1782 * site configuration?
1783 * @return bool
1784 */
1785 function canReceiveEmail() {
1786 return $this->canSendEmail() && !$this->getOption( 'disablemail' );
1787 }
1788
1789 /**
1790 * Is this user's e-mail address valid-looking and confirmed within
1791 * limits of the current site configuration?
1792 *
1793 * If $wgEmailAuthentication is on, this may require the user to have
1794 * confirmed their address by returning a code or using a password
1795 * sent to the address from the wiki.
1796 *
1797 * @return bool
1798 */
1799 function isEmailConfirmed() {
1800 global $wgEmailAuthentication;
1801 $this->loadFromDatabase();
1802 if( $this->isAnon() )
1803 return false;
1804 if( !$this->isValidEmailAddr( $this->mEmail ) )
1805 return false;
1806 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
1807 return false;
1808 return true;
1809 }
1810
1811 /**
1812 * @param array $groups list of groups
1813 * @return array list of permission key names for given groups combined
1814 * @static
1815 */
1816 function getGroupPermissions( $groups ) {
1817 global $wgGroupPermissions;
1818 $rights = array();
1819 foreach( $groups as $group ) {
1820 if( isset( $wgGroupPermissions[$group] ) ) {
1821 $rights = array_merge( $rights,
1822 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
1823 }
1824 }
1825 return $rights;
1826 }
1827
1828 /**
1829 * @param string $group key name
1830 * @return string localized descriptive name, if provided
1831 * @static
1832 */
1833 function getGroupName( $group ) {
1834 $key = "group-$group-name";
1835 $name = wfMsg( $key );
1836 if( $name == '' || $name == "&lt;$key&gt;" ) {
1837 return $group;
1838 } else {
1839 return $name;
1840 }
1841 }
1842
1843 /**
1844 * Return the set of defined explicit groups.
1845 * The * and 'user' groups are not included.
1846 * @return array
1847 * @static
1848 */
1849 function getAllGroups() {
1850 global $wgGroupPermissions;
1851 return array_diff(
1852 array_keys( $wgGroupPermissions ),
1853 array( '*', 'user', 'autoconfirmed' ) );
1854 }
1855 }
1856
1857 ?>