Go to the documentation of this file.
36 parent::__construct( $main, $action,
'lg' );
52 'result' =>
'Aborted',
53 'reason' =>
'Cannot log in when using a callback',
64 if ( session_id() ==
'' ) {
73 'wpPassword' =>
$params[
'password'],
74 'wpDomain' =>
$params[
'domain'],
75 'wpLoginToken' =>
$params[
'token'],
84 $authRes = $loginForm->authenticateUserData();
104 $result[
'sessionid'] = session_id();
108 $result[
'result'] =
'NeedToken';
109 $result[
'token'] = $loginForm->getLoginToken();
111 $result[
'sessionid'] = session_id();
115 $result[
'result'] =
'WrongToken';
127 $result[
'result'] =
'WrongPluginPass';
131 $result[
'result'] =
'NotExists';
138 $result[
'result'] =
'WrongPass';
142 $result[
'result'] =
'EmptyPass';
146 $result[
'result'] =
'CreateBlocked';
147 $result[
'details'] =
'Your IP address is blocked from account creation';
151 $result[
'result'] =
'Throttled';
152 $result[
'wait'] = intval( $wgPasswordAttemptThrottle[
'seconds'] );
161 $result[
'reason'] = $loginForm->mAbortLoginErrorMsg;
190 'name' =>
'User Name',
191 'password' =>
'Password',
192 'domain' =>
'Domain (optional)',
193 'token' =>
'Login token obtained in first request',
221 'lgusername' =>
array(
229 'cookieprefix' =>
array(
233 'sessionid' =>
array(
259 'Log in and get the authentication tokens.',
260 'In the event of a successful log-in, a cookie will be attached to your session.',
261 'In the event of a failed log-in, you will not be able to attempt another log-in',
262 'through this method for 5 seconds. This is to prevent password guessing by',
263 'automated password crackers.'
268 return array_merge( parent::getPossibleErrors(),
array(
270 'code' =>
'NeedToken',
'info' =>
'You need to resubmit your ' .
271 'login with the specified token. See ' .
272 'https://bugzilla.wikimedia.org/show_bug.cgi?id=23076'
274 array(
'code' =>
'WrongToken',
'info' =>
'You specified an invalid token' ),
275 array(
'code' =>
'NoName',
'info' =>
'You didn\'t set the lgname parameter' ),
276 array(
'code' =>
'Illegal',
'info' =>
'You provided an illegal username' ),
277 array(
'code' =>
'NotExists',
'info' =>
'The username you provided doesn\'t exist' ),
279 'code' =>
'EmptyPass',
280 'info' =>
'You didn\'t set the lgpassword parameter or you left it empty'
282 array(
'code' =>
'WrongPass',
'info' =>
'The password you provided is incorrect' ),
284 'code' =>
'WrongPluginPass',
285 'info' =>
'Same as "WrongPass", returned when an authentication ' .
286 'plugin rather than MediaWiki itself rejected the password'
289 'code' =>
'CreateBlocked',
290 'info' =>
'The wiki tried to automatically create a new account ' .
291 'for you, but your IP address has been blocked from account creation'
293 array(
'code' =>
'Throttled',
'info' =>
'You\'ve logged in too many times in a short time' ),
294 array(
'code' =>
'Blocked',
'info' =>
'User is blocked' ),
300 'api.php?action=login&lgname=user&lgpassword=password'
305 return 'https://www.mediawiki.org/wiki/API:Login';
Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base reque...
isReadMode()
Indicates whether this module requires read rights.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
getContext()
Get the RequestContext object.
execute()
Executes the log-in attempt using the parameters passed.
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
wfSetupSession( $sessionId=false)
Initialise php session.
mustBePosted()
Indicates whether this module must be called with a POST request.
getResult()
Get the result object.
if( $wgRCFilterByAge) if( $wgSkipSkin) if( $wgLocalInterwiki) if( $wgSharedPrefix===false) if(! $wgCookiePrefix) $wgCookiePrefix
getDescription()
Returns the description string for this module.
getPossibleErrors()
Returns a list of all possible errors returned by the module.
getRequest()
Get the WebRequest object.
This abstract class implements many basic API functions, and is the base of all API classes.
getParamDescription()
Returns an array of parameter descriptions.
An IContextSource implementation which will inherit context from another source but allow individual ...
wfRunHooks( $event, array $args=array(), $deprecatedVersion=null)
Call hook functions defined in $wgHooks.
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
when a variable name is used in a it is silently declared as a new masking the global
__construct( $main, $action)
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getUser()
Get the User object.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
getResultProperties()
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
getExamples()
Returns usage examples for this module.
getMain()
Get the main module.
Unit to authenticate log-in attempts to the current wiki.
static dieDebug( $method, $message)
Internal code errors should be reported with this method.