includes/api/ApiLogin.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Sep 19, 2006
   6  *
   7  * API for MediaWiki 1.8+
   8  *
   9  * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.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 class ApiLogin extends ApiBase {
  33
  34         public function __construct($main, $action) {
  35                 parent :: __construct($main);
  36         }
  37
  38         public function Execute() {
  39                 $lgname = $lgpassword = $lgdomain = null;
  40                 extract($this->ExtractRequestParams());
  41
  42                 $params = new FauxRequest(array (
  43                         'wpName' => $lgname,
  44                         'wpPassword' => $lgpassword,
  45                         'wpDomain' => $lgdomain,
  46                         'wpRemember' => ''
  47                 ));
  48
  49                 $result = array();
  50
  51                 $loginForm = new LoginForm($params);
  52                 switch ($loginForm->authenticateUserData())
  53                 {
  54                         case (AuthSuccess):
  55                                 $result['result'] = 'Success';
  56                                 $result['lguserid'] = $_SESSION['wsUserID'];
  57                                 $result['lgusername'] = $_SESSION['wsUserName'];
  58                                 $result['lgtoken'] = $_SESSION['wsToken'];
  59                                 break;
  60
  61                         case (AuthNoName):
  62                                 $result['result'] = 'AuthNoName';
  63                                 break;
  64                         case (AuthIllegal):
  65                                 $result['result'] = 'AuthIllegal';
  66                                 break;
  67                         case (AuthWrongPluginPass):
  68                                 $result['result'] = 'AuthWrongPluginPass';
  69                                 break;
  70                         case (AuthNotExists):
  71                                 $result['result'] = 'AuthNotExists';
  72                                 break;
  73                         case (AuthWrongPass):
  74                                 $result['result'] = 'AuthWrongPass';
  75                                 break;
  76                         case (AuthEmptyPass):
  77                                 $result['result'] = 'AuthEmptyPass';
  78                                 break;
  79                         default:
  80                                 $this->DieDebug( "Unhandled case value" );
  81                 }
  82
  83                 $this->GetResult()->AddMessage('login', null, $result);
  84         }
  85
  86         protected function GetAllowedParams() {
  87                 return array (
  88                         'lgname' => '',
  89                         'lgpassword' => '',
  90                         'lgdomain' => null
  91                 );
  92         }
  93
  94         protected function GetParamDescription() {
  95                 return array (
  96                         'lgname' => 'User Name',
  97                         'lgpassword' => 'Password',
  98                         'lgdomain' => 'Domain (optional)'
  99                 );
 100         }
 101
 102         protected function GetDescription() {
 103                 return array('This module is used to login and get the authentication tokens.');
 104         }
 105 }
 106 ?>