5 * Created on Sep 19, 2006
7 * API for MediaWiki 1.8+
9 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
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.
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.
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
27 if (!defined('MEDIAWIKI')) {
28 // Eclipse helper - will be ignored in production
29 require_once ("ApiBase.php");
32 class ApiLogin
extends ApiBase
{
37 public function __construct($main, $action) {
38 parent
:: __construct($main);
41 public function Execute() {
42 $lgname = $lgpassword = $lgdomain = null;
43 extract($this->ExtractRequestParams());
45 $params = new FauxRequest(array (
47 'wpPassword' => $lgpassword,
48 'wpDomain' => $lgdomain,
54 $loginForm = new LoginForm($params);
55 switch ($loginForm->authenticateUserData())
58 $result['result'] = 'Success';
59 $result['lguserid'] = $_SESSION['wsUserID'];
60 $result['lgusername'] = $_SESSION['wsUserName'];
61 $result['lgtoken'] = $_SESSION['wsToken'];
65 $result['result'] = 'AuthNoName';
68 $result['result'] = 'AuthIllegal';
70 case (AuthWrongPluginPass
):
71 $result['result'] = 'AuthWrongPluginPass';
74 $result['result'] = 'AuthNotExists';
77 $result['result'] = 'AuthWrongPass';
80 $result['result'] = 'AuthEmptyPass';
83 $this->DieDebug( "Unhandled case value" );
86 $this->GetResult()->AddMessage('login', null, $result);
90 * Returns an array of allowed parameters (keys) => default value for that parameter
92 protected function GetAllowedParams() {
101 * Returns the description string for the given parameter.
103 protected function GetParamDescription() {
105 'lgname' => 'User Name',
106 'lgpassword' => 'Password',
107 'lgdomain' => 'Domain (optional)',
113 * Returns the description string for this module
115 protected function GetDescription() {
116 return array("*Login Module*",
117 "This module is used to login and get the authentication tokens.");