includes/api/ApiLogin.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 19, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006-2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
   9  * Daniel Cannon (cannon dot danielc at gmail dot com)
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along
  22  * with this program; if not, write to the Free Software Foundation, Inc.,
  23  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  * http://www.gnu.org/copyleft/gpl.html
  25  */
  26
  27 if (!defined('MEDIAWIKI')) {
  28         // Eclipse helper - will be ignored in production
  29         require_once ('ApiBase.php');
  30 }
  31
  32 /**
  33  * Unit to authenticate log-in attempts to the current wiki.
  34  *
  35  * @ingroup API
  36  */
  37 class ApiLogin extends ApiBase {
  38
  39         public function __construct($main, $action) {
  40                 parent :: __construct($main, $action, 'lg');
  41         }
  42
  43         /**
  44          * Executes the log-in attempt using the parameters passed. If
  45          * the log-in succeeeds, it attaches a cookie to the session
  46          * and outputs the user id, username, and session token. If a
  47          * log-in fails, as the result of a bad password, a nonexistent
  48          * user, or any other reason, the host is cached with an expiry
  49          * and no log-in attempts will be accepted until that expiry
  50          * is reached. The expiry is $this->mLoginThrottle.
  51          *
  52          * @access public
  53          */
  54         public function execute() {
  55                 $params = $this->extractRequestParams();
  56
  57                 $result = array ();
  58
  59                 $req = new FauxRequest(array (
  60                         'wpName' => $params['name'],
  61                         'wpPassword' => $params['password'],
  62                         'wpDomain' => $params['domain'],
  63                         'wpRemember' => ''
  64                 ));
  65
  66                 // Init session if necessary
  67                 if( session_id() == '' ) {
  68                         wfSetupSession();
  69                 }
  70
  71                 $loginForm = new LoginForm($req);
  72                 switch ($authRes = $loginForm->authenticateUserData()) {
  73                         case LoginForm :: SUCCESS :
  74                                 global $wgUser, $wgCookiePrefix;
  75
  76                                 $wgUser->setOption('rememberpassword', 1);
  77                                 $wgUser->setCookies();
  78
  79                                 // Run hooks. FIXME: split back and frontend from this hook.
  80                                 // FIXME: This hook should be placed in the backend
  81                                 $injected_html = '';
  82                                 wfRunHooks('UserLoginComplete', array(&$wgUser, &$injected_html));
  83
  84                                 $result['result'] = 'Success';
  85                                 $result['lguserid'] = intval($wgUser->getId());
  86                                 $result['lgusername'] = $wgUser->getName();
  87                                 $result['lgtoken'] = $wgUser->getToken();
  88                                 $result['cookieprefix'] = $wgCookiePrefix;
  89                                 $result['sessionid'] = session_id();
  90                                 break;
  91
  92                         case LoginForm :: NO_NAME :
  93                                 $result['result'] = 'NoName';
  94                                 break;
  95                         case LoginForm :: ILLEGAL :
  96                                 $result['result'] = 'Illegal';
  97                                 break;
  98                         case LoginForm :: WRONG_PLUGIN_PASS :
  99                                 $result['result'] = 'WrongPluginPass';
 100                                 break;
 101                         case LoginForm :: NOT_EXISTS :
 102                                 $result['result'] = 'NotExists';
 103                                 break;
 104                         case LoginForm :: WRONG_PASS :
 105                                 $result['result'] = 'WrongPass';
 106                                 break;
 107                         case LoginForm :: EMPTY_PASS :
 108                                 $result['result'] = 'EmptyPass';
 109                                 break;
 110                         case LoginForm :: CREATE_BLOCKED :
 111                                 $result['result'] = 'CreateBlocked';
 112                                 $result['details'] = 'Your IP address is blocked from account creation';
 113                                 break;
 114                         case LoginForm :: THROTTLED :
 115                                 global $wgPasswordAttemptThrottle;
 116                                 $result['result'] = 'Throttled';
 117                                 $result['wait'] = intval($wgPasswordAttemptThrottle['seconds']);
 118                                 break;
 119                         default :
 120                                 ApiBase :: dieDebug(__METHOD__, "Unhandled case value: {$authRes}");
 121                 }
 122
 123                 $this->getResult()->addValue(null, 'login', $result);
 124         }
 125
 126         public function mustBePosted() { return true; }
 127
 128         public function isReadMode() {
 129                 return false;
 130         }
 131
 132         public function getAllowedParams() {
 133                 return array (
 134                         'name' => null,
 135                         'password' => null,
 136                         'domain' => null
 137                 );
 138         }
 139
 140         public function getParamDescription() {
 141                 return array (
 142                         'name' => 'User Name',
 143                         'password' => 'Password',
 144                         'domain' => 'Domain (optional)'
 145                 );
 146         }
 147
 148         public function getDescription() {
 149                 return array (
 150                         'This module is used to login and get the authentication tokens. ',
 151                         'In the event of a successful log-in, a cookie will be attached',
 152                         'to your session. In the event of a failed log-in, you will not ',
 153                         'be able to attempt another log-in through this method for 5 seconds.',
 154                         'This is to prevent password guessing by automated password crackers.'
 155                 );
 156         }
 157
 158         protected function getExamples() {
 159                 return array(
 160                         'api.php?action=login&lgname=user&lgpassword=password'
 161                 );
 162         }
 163
 164         public function getVersion() {
 165                 return __CLASS__ . ': $Id$';
 166         }
 167 }