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 Yuri Astrakhan <FirstnameLastname@gmail.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ('ApiBase.php');
  29 }
  30
  31 /**
  32  * @addtogroup API
  33  */
  34 class ApiLogin extends ApiBase {
  35
  36         public function __construct($main, $action) {
  37                 parent :: __construct($main, $action, 'lg');
  38         }
  39
  40         public function execute() {
  41                 $name = $password = $domain = null;
  42                 extract($this->extractRequestParams());
  43
  44                 $params = new FauxRequest(array (
  45                         'wpName' => $name,
  46                         'wpPassword' => $password,
  47                         'wpDomain' => $domain,
  48                         'wpRemember' => ''
  49                 ));
  50
  51                 $result = array ();
  52
  53                 $loginForm = new LoginForm($params);
  54                 switch ($loginForm->authenticateUserData()) {
  55                         case LoginForm :: SUCCESS :
  56                                 global $wgUser;
  57
  58                                 $wgUser->setOption('rememberpassword', 1);
  59                                 $wgUser->setCookies();
  60
  61                                 $result['result'] = 'Success';
  62                                 $result['lguserid'] = $_SESSION['wsUserID'];
  63                                 $result['lgusername'] = $_SESSION['wsUserName'];
  64                                 $result['lgtoken'] = $_SESSION['wsToken'];
  65                                 break;
  66
  67                         case LoginForm :: NO_NAME :
  68                                 $result['result'] = 'NoName';
  69                                 break;
  70                         case LoginForm :: ILLEGAL :
  71                                 $result['result'] = 'Illegal';
  72                                 break;
  73                         case LoginForm :: WRONG_PLUGIN_PASS :
  74                                 $result['result'] = 'WrongPluginPass';
  75                                 break;
  76                         case LoginForm :: NOT_EXISTS :
  77                                 $result['result'] = 'NotExists';
  78                                 break;
  79                         case LoginForm :: WRONG_PASS :
  80                                 $result['result'] = 'WrongPass';
  81                                 break;
  82                         case LoginForm :: EMPTY_PASS :
  83                                 $result['result'] = 'EmptyPass';
  84                                 break;
  85                         default :
  86                                 ApiBase :: dieDebug(__METHOD__, 'Unhandled case value');
  87                 }
  88
  89                 $this->getResult()->addValue(null, 'login', $result);
  90         }
  91
  92         protected function getAllowedParams() {
  93                 return array (
  94                         'name' => null,
  95                         'password' => null,
  96                         'domain' => null
  97                 );
  98         }
  99
 100         protected function getParamDescription() {
 101                 return array (
 102                         'name' => 'User Name',
 103                         'password' => 'Password',
 104                         'domain' => 'Domain (optional)'
 105                 );
 106         }
 107
 108         protected function getDescription() {
 109                 return array (
 110                         'This module is used to login and get the authentication tokens.'
 111                 );
 112         }
 113
 114         protected function getExamples() {
 115                 return array(
 116                         'api.php?action=login&lgname=user&lgpassword=password'
 117                 );
 118         }
 119
 120         public function getVersion() {
 121                 return __CLASS__ . ': $Id$';
 122         }
 123 }
 124 ?>