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
{
34 public function __construct($main, $action) {
35 parent
:: __construct($main, $action, 'lg');
38 public function execute() {
39 $name = $password = $domain = null;
40 extract($this->extractRequestParams());
42 $params = new FauxRequest(array (
44 'wpPassword' => $password,
45 'wpDomain' => $domain,
51 $loginForm = new LoginForm($params);
52 switch ($loginForm->authenticateUserData()) {
53 case LoginForm
:: SUCCESS
:
56 $wgUser->setOption('rememberpassword', 1);
57 $wgUser->setCookies();
59 $result['result'] = 'Success';
60 $result['lguserid'] = $_SESSION['wsUserID'];
61 $result['lgusername'] = $_SESSION['wsUserName'];
62 $result['lgtoken'] = $_SESSION['wsToken'];
65 case LoginForm
:: NO_NAME
:
66 $result['result'] = 'NoName';
68 case LoginForm
:: ILLEGAL
:
69 $result['result'] = 'Illegal';
71 case LoginForm
:: WRONG_PLUGIN_PASS
:
72 $result['result'] = 'WrongPluginPass';
74 case LoginForm
:: NOT_EXISTS
:
75 $result['result'] = 'NotExists';
77 case LoginForm
:: WRONG_PASS
:
78 $result['result'] = 'WrongPass';
80 case LoginForm
:: EMPTY_PASS
:
81 $result['result'] = 'EmptyPass';
84 ApiBase
:: dieDebug(__METHOD__
, 'Unhandled case value');
87 $this->getResult()->addValue(null, 'login', $result);
90 protected function getAllowedParams() {
98 protected function getParamDescription() {
100 'name' => 'User Name',
101 'password' => 'Password',
102 'domain' => 'Domain (optional)'
106 protected function getDescription() {
108 'This module is used to login and get the authentication tokens.'
112 protected function getExamples() {
114 'api.php?action=login&lgname=user&lgpassword=password'
118 public function getVersion() {
119 return __CLASS__
. ': $Id$';