* Added a new hook, 'AddNewAccount', which is run after account creation
[lhc/web/wiklou.git] / includes / SpecialUserlogin.php
1 <?php
2 /**
3 *
4 * @package MediaWiki
5 * @subpackage SpecialPage
6 */
7
8 /**
9 * constructor
10 */
11 function wfSpecialUserlogin() {
12 global $wgCommandLineMode;
13 global $wgRequest;
14 if( !$wgCommandLineMode && !isset( $_COOKIE[session_name()] ) ) {
15 User::SetupSession();
16 }
17
18 $form = new LoginForm( $wgRequest );
19 $form->execute();
20 }
21
22 /**
23 *
24 * @package MediaWiki
25 * @subpackage SpecialPage
26 */
27 class LoginForm {
28 var $mName, $mPassword, $mRetype, $mReturnto, $mCookieCheck, $mPosted;
29 var $mAction, $mCreateaccount, $mCreateaccountMail, $mMailmypassword;
30 var $mLoginattempt, $mRemember, $mEmail, $mDomain;
31
32 /**
33 * Constructor
34 * @param webrequest $request A webrequest object passed by reference
35 */
36 function LoginForm( &$request ) {
37 global $wgLang, $wgAllowRealName, $wgEnableEmail;
38 global $wgAuth;
39
40 $this->mName = $request->getText( 'wpName' );
41 $this->mPassword = $request->getText( 'wpPassword' );
42 $this->mRetype = $request->getText( 'wpRetype' );
43 $this->mDomain = $request->getText( 'wpDomain' );
44 $this->mReturnto = $request->getVal( 'returnto' );
45 $this->mCookieCheck = $request->getVal( 'wpCookieCheck' );
46 $this->mPosted = $request->wasPosted();
47 $this->mCreateaccount = $request->getCheck( 'wpCreateaccount' );
48 $this->mCreateaccountMail = $request->getCheck( 'wpCreateaccountMail' )
49 && $wgEnableEmail;
50 $this->mMailmypassword = $request->getCheck( 'wpMailmypassword' )
51 && $wgEnableEmail;
52 $this->mLoginattempt = $request->getCheck( 'wpLoginattempt' );
53 $this->mAction = $request->getVal( 'action' );
54 $this->mRemember = $request->getCheck( 'wpRemember' );
55
56 if( $wgEnableEmail ) {
57 $this->mEmail = $request->getText( 'wpEmail' );
58 } else {
59 $this->mEmail = '';
60 }
61 if( $wgAllowRealName ) {
62 $this->mRealName = $request->getText( 'wpRealName' );
63 } else {
64 $this->mRealName = '';
65 }
66
67 if( !$wgAuth->validDomain( $this->mDomain ) ) {
68 $this->mDomain = 'invaliddomain';
69 }
70 $wgAuth->setDomain( $this->mDomain );
71
72 # When switching accounts, it sucks to get automatically logged out
73 if( $this->mReturnto == $wgLang->specialPage( 'Userlogout' ) ) {
74 $this->mReturnto = '';
75 }
76 }
77
78 function execute() {
79 if ( !is_null( $this->mCookieCheck ) ) {
80 $this->onCookieRedirectCheck( $this->mCookieCheck );
81 return;
82 } else if( $this->mPosted ) {
83 if( $this->mCreateaccount ) {
84 return $this->addNewAccount();
85 } else if ( $this->mCreateaccountMail ) {
86 return $this->addNewAccountMailPassword();
87 } else if ( $this->mMailmypassword ) {
88 return $this->mailPassword();
89 } else if ( ( 'submitlogin' == $this->mAction ) || $this->mLoginattempt ) {
90 return $this->processLogin();
91 }
92 }
93 $this->mainLoginForm( '' );
94 }
95
96 /**
97 * @access private
98 */
99 function addNewAccountMailPassword() {
100 global $wgOut;
101
102 if ('' == $this->mEmail) {
103 $this->mainLoginForm( wfMsg( 'noemail', htmlspecialchars( $this->mName ) ) );
104 return;
105 }
106
107 $u = $this->addNewaccountInternal();
108
109 if ($u == NULL) {
110 return;
111 }
112
113 $u->saveSettings();
114 $result = $this->mailPasswordInternal($u);
115
116 $wgOut->setPageTitle( wfMsg( 'accmailtitle' ) );
117 $wgOut->setRobotpolicy( 'noindex,nofollow' );
118 $wgOut->setArticleRelated( false );
119
120 if( WikiError::isError( $result ) ) {
121 $this->mainLoginForm( wfMsg( 'mailerror', $result->getMessage() ) );
122 } else {
123 $wgOut->addWikiText( wfMsg( 'accmailtext', $u->getName(), $u->getEmail() ) );
124 $wgOut->returnToMain( false );
125 }
126 $u = 0;
127 }
128
129
130 /**
131 * @access private
132 */
133 function addNewAccount() {
134 global $wgUser, $wgOut, $wgEmailAuthentication;
135
136 $u = $this->addNewAccountInternal();
137
138 if ($u == NULL) {
139 return;
140 }
141
142 $wgUser = $u;
143 $wgUser->setCookies();
144
145 $wgUser->saveSettings();
146 if( $wgEmailAuthentication && $wgUser->isValidEmailAddr( $wgUser->getEmail() ) ) {
147 $wgUser->sendConfirmationMail();
148 }
149
150 wfRunHooks( 'AddNewAccount', null );
151
152 if( $this->hasSessionCookie() ) {
153 return $this->successfulLogin( wfMsg( 'welcomecreation', $wgUser->getName() ) );
154 } else {
155 return $this->cookieRedirectCheck( 'new' );
156 }
157 }
158
159 /**
160 * @access private
161 */
162 function addNewAccountInternal() {
163 global $wgUser, $wgOut;
164 global $wgUseLatin1, $wgEnableSorbs, $wgProxyWhitelist;
165 global $wgMemc, $wgAccountCreationThrottle, $wgDBname, $wgIP;
166 global $wgAuth;
167
168 // If the user passes an invalid domain, something is fishy
169 if( !$wgAuth->validDomain( $this->mDomain ) ) {
170 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
171 return false;
172 }
173
174 // If we are not allowing users to login locally, we should
175 // be checking to see if the user is actually able to
176 // authenticate to the authentication server before they
177 // create an account (otherwise, they can create a local account
178 // and login as any domain user). We only need to check this for
179 // domains that aren't local.
180 if( 'local' != $this->mDomain && '' != $this->mDomain ) {
181 if( !$wgAuth->canCreateAccounts() && ( !$wgAuth->userExists( $this->mName ) || !$wgAuth->authenticate( $this->mName, $this->mPassword ) ) ) {
182 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
183 return false;
184 }
185 }
186
187 if (!$wgUser->isAllowedToCreateAccount()) {
188 $this->userNotPrivilegedMessage();
189 return false;
190 }
191
192 if ( $wgEnableSorbs && !in_array( $wgIP, $wgProxyWhitelist ) &&
193 $wgUser->inSorbsBlacklist( $wgIP ) )
194 {
195 $this->mainLoginForm( wfMsg( 'sorbs_create_account_reason' ) . ' (' . htmlspecialchars( $wgIP ) . ')' );
196 return;
197 }
198
199
200 if ( 0 != strcmp( $this->mPassword, $this->mRetype ) ) {
201 $this->mainLoginForm( wfMsg( 'badretype' ) );
202 return false;
203 }
204
205 $name = trim( $this->mName );
206 $u = User::newFromName( $name );
207 if ( is_null( $u ) ) {
208 $this->mainLoginForm( wfMsg( 'noname' ) );
209 return false;
210 }
211
212 if ( wfReadOnly() ) {
213 $wgOut->readOnlyPage();
214 return false;
215 }
216
217 if ( 0 != $u->idForName() ) {
218 $this->mainLoginForm( wfMsg( 'userexists' ) );
219 return false;
220 }
221
222 if ( !$wgUser->isValidPassword( $this->mPassword ) ) {
223 $this->mainLoginForm( wfMsg( 'passwordtooshort', $wgMinimalPasswordLength ) );
224 return false;
225 }
226
227 if ( $wgAccountCreationThrottle ) {
228 $key = $wgDBname.':acctcreate:ip:'.$wgIP;
229 $value = $wgMemc->incr( $key );
230 if ( !$value ) {
231 $wgMemc->set( $key, 1, 86400 );
232 }
233 if ( $value > $wgAccountCreationThrottle ) {
234 $this->throttleHit( $wgAccountCreationThrottle );
235 return false;
236 }
237 }
238
239 if( !$wgAuth->addUser( $u, $this->mPassword ) ) {
240 $this->mainLoginForm( wfMsg( 'externaldberror' ) );
241 return false;
242 }
243
244 # Update user count
245 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
246 $ssUpdate->doUpdate();
247
248 return $this->initUser( $u );
249 }
250
251 /**
252 * Actually add a user to the database.
253 * Give it a User object that has been initialised with a name.
254 *
255 * @param User $u
256 * @return User
257 * @access private
258 */
259 function &initUser( &$u ) {
260 $u->addToDatabase();
261 $u->setPassword( $this->mPassword );
262 $u->setEmail( $this->mEmail );
263 $u->setRealName( $this->mRealName );
264 $u->setToken();
265
266 global $wgAuth;
267 $wgAuth->initUser( $u );
268
269 if ( $this->mRemember ) { $r = 1; }
270 else { $r = 0; }
271 $u->setOption( 'rememberpassword', $r );
272
273 return $u;
274 }
275
276 /**
277 * @access private
278 */
279 function processLogin() {
280 global $wgUser;
281 global $wgAuth;
282
283 if ( '' == $this->mName ) {
284 $this->mainLoginForm( wfMsg( 'noname' ) );
285 return;
286 }
287 $u = User::newFromName( $this->mName );
288 if( is_null( $u ) ) {
289 $this->mainLoginForm( wfMsg( 'noname' ) );
290 return;
291 }
292 if ( 0 == $u->getID() ) {
293 global $wgAuth;
294 /**
295 * If the external authentication plugin allows it,
296 * automatically create a new account for users that
297 * are externally defined but have not yet logged in.
298 */
299 if ( $wgAuth->autoCreate() && $wgAuth->userExists( $u->getName() ) ) {
300 if ( $wgAuth->authenticate( $u->getName(), $this->mPassword ) ) {
301 $u =& $this->initUser( $u );
302 } else {
303 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
304 return;
305 }
306 } else {
307 $this->mainLoginForm( wfMsg( 'nosuchuser', $u->getName() ) );
308 return;
309 }
310 } else {
311 $u->loadFromDatabase();
312 }
313
314 if (!$u->checkPassword( $this->mPassword )) {
315 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
316 return;
317 }
318
319 # We've verified now, update the real record
320 #
321 if ( $this->mRemember ) {
322 $r = 1;
323 } else {
324 $r = 0;
325 }
326 $u->setOption( 'rememberpassword', $r );
327
328 $wgAuth->updateUser( $u );
329
330 $wgUser = $u;
331 $wgUser->setCookies();
332
333 $wgUser->saveSettings();
334
335 if( $this->hasSessionCookie() ) {
336 return $this->successfulLogin( wfMsg( 'loginsuccess', $wgUser->getName() ) );
337 } else {
338 return $this->cookieRedirectCheck( 'login' );
339 }
340 }
341
342 /**
343 * @access private
344 */
345 function mailPassword() {
346 global $wgUser, $wgDeferredUpdateList, $wgOutputEncoding;
347 global $wgCookiePath, $wgCookieDomain, $wgDBname;
348
349 if ( '' == $this->mName ) {
350 $this->mainLoginForm( wfMsg( 'noname' ) );
351 return;
352 }
353 $u = User::newFromName( $this->mName );
354 if( is_null( $u ) ) {
355 $this->mainLoginForm( wfMsg( 'noname' ) );
356 return;
357 }
358 if ( 0 == $u->getID() ) {
359 $this->mainLoginForm( wfMsg( 'nosuchuser', $u->getName() ) );
360 return;
361 }
362
363 $u->loadFromDatabase();
364
365 $result = $this->mailPasswordInternal( $u );
366 if( WikiError::isError( $result ) ) {
367 $this->mainLoginForm( wfMsg( 'mailerror', $result->getMessage() ) );
368 } else {
369 $this->mainLoginForm( wfMsg( 'passwordsent', $u->getName() ) );
370 }
371 }
372
373
374 /**
375 * @return mixed true on success, WikiError on failure
376 * @access private
377 */
378 function mailPasswordInternal( $u ) {
379 global $wgPasswordSender, $wgDBname, $wgIP;
380 global $wgCookiePath, $wgCookieDomain;
381
382 if ( '' == $u->getEmail() ) {
383 return wfMsg( 'noemail', $u->getName() );
384 }
385
386 $np = $u->randomPassword();
387 $u->setNewpassword( $np );
388
389 setcookie( "{$wgDBname}Token", '', time() - 3600, $wgCookiePath, $wgCookieDomain );
390
391 $u->saveSettings();
392
393 $ip = $wgIP;
394 if ( '' == $ip ) { $ip = '(Unknown)'; }
395
396 $m = wfMsg( 'passwordremindertext', $ip, $u->getName(), $np );
397
398 $result = $u->sendMail( wfMsg( 'passwordremindertitle' ), $m );
399 return $result;
400 }
401
402
403 /**
404 * @param string $msg Message that will be shown on success.
405 * @access private
406 */
407 function successfulLogin( $msg ) {
408 global $wgUser;
409 global $wgOut;
410
411 # Run any hooks; ignore results
412
413 wfRunHooks('UserLoginComplete', array(&$wgUser));
414
415 $wgOut->setPageTitle( wfMsg( 'loginsuccesstitle' ) );
416 $wgOut->setRobotpolicy( 'noindex,nofollow' );
417 $wgOut->setArticleRelated( false );
418 $wgOut->addWikiText( $msg );
419 $wgOut->returnToMain();
420 }
421
422 /** */
423 function userNotPrivilegedMessage() {
424 global $wgOut;
425
426 $wgOut->setPageTitle( wfMsg( 'whitelistacctitle' ) );
427 $wgOut->setRobotpolicy( 'noindex,nofollow' );
428 $wgOut->setArticleRelated( false );
429
430 $wgOut->addWikiText( wfMsg( 'whitelistacctext' ) );
431
432 $wgOut->returnToMain( false );
433 }
434
435 /**
436 * @access private
437 */
438 function mainLoginForm( $err ) {
439 global $wgUser, $wgOut, $wgLang;
440 global $wgDBname, $wgAllowRealName, $wgEnableEmail;
441 global $wgAuth;
442
443 if ( '' == $this->mName ) {
444 if ( $wgUser->isLoggedIn() ) {
445 $this->mName = $wgUser->getName();
446 } else {
447 $this->mName = @$_COOKIE[$wgDBname.'UserName'];
448 }
449 }
450
451 $q = 'action=submitlogin';
452 if ( !empty( $this->mReturnto ) ) {
453 $q .= '&returnto=' . wfUrlencode( $this->mReturnto );
454 }
455 $titleObj = Title::makeTitle( NS_SPECIAL, 'Userlogin' );
456
457 require_once( 'templates/Userlogin.php' );
458 $template =& new UserloginTemplate();
459
460 $template->set( 'name', $this->mName );
461 $template->set( 'password', $this->mPassword );
462 $template->set( 'retype', $this->mRetype );
463 $template->set( 'email', $this->mEmail );
464 $template->set( 'realname', $this->mRealName );
465 $template->set( 'domain', $this->mDomain );
466
467 $template->set( 'action', $titleObj->getLocalUrl( $q ) );
468 $template->set( 'error', $err );
469 $template->set( 'create', $wgUser->isAllowedToCreateAccount() );
470 $template->set( 'createemail', $wgEnableEmail && $wgUser->isLoggedIn() );
471 $template->set( 'userealname', $wgAllowRealName );
472 $template->set( 'useemail', $wgEnableEmail );
473 $template->set( 'remember', $wgUser->getOption( 'rememberpassword' ) or $this->mRemember );
474 $wgAuth->modifyUITemplate( $template );
475
476 $wgOut->setPageTitle( wfMsg( 'userlogin' ) );
477 $wgOut->setRobotpolicy( 'noindex,nofollow' );
478 $wgOut->setArticleRelated( false );
479 $wgOut->addTemplate( $template );
480 }
481
482 /**
483 * @access private
484 */
485 function hasSessionCookie() {
486 global $wgDisableCookieCheck;
487 return ( $wgDisableCookieCheck ) ? true : ( isset( $_COOKIE[session_name()] ) );
488 }
489
490 /**
491 * @access private
492 */
493 function cookieRedirectCheck( $type ) {
494 global $wgOut, $wgLang;
495
496 $titleObj = Title::makeTitle( NS_SPECIAL, 'Userlogin' );
497 $check = $titleObj->getFullURL( 'wpCookieCheck='.$type );
498
499 return $wgOut->redirect( $check );
500 }
501
502 /**
503 * @access private
504 */
505 function onCookieRedirectCheck( $type ) {
506 global $wgUser;
507
508 if ( !$this->hasSessionCookie() ) {
509 if ( $type == 'new' ) {
510 return $this->mainLoginForm( wfMsg( 'nocookiesnew' ) );
511 } else if ( $type == 'login' ) {
512 return $this->mainLoginForm( wfMsg( 'nocookieslogin' ) );
513 } else {
514 # shouldn't happen
515 return $this->mainLoginForm( wfMsg( 'error' ) );
516 }
517 } else {
518 return $this->successfulLogin( wfMsg( 'loginsuccess', $wgUser->getName() ) );
519 }
520 }
521
522 /**
523 * @access private
524 */
525 function throttleHit( $limit ) {
526 global $wgOut;
527
528 $wgOut->addWikiText( wfMsg( 'acct_creation_throttle_hit', $limit ) );
529 }
530 }
531 ?>