Go to the documentation of this file.
42 parent::__construct(
$query, $moduleName,
'ui' );
49 if ( !is_null( $this->params[
'prop'] ) ) {
50 $this->prop = array_flip( $this->params[
'prop'] );
71 $vals[
'blockid'] = $block->
getId();
73 $vals[
'blockedbyid'] = $block->
getBy();
74 $vals[
'blockreason'] = $block->mReason;
75 $vals[
'blockedtimestamp'] =
wfTimestamp( TS_ISO_8601, $block->mTimestamp );
96 $providerIds = array_keys( $config->get(
'CentralIdLookupProviders' ) );
100 'attachedlocal' => [],
104 if ( $attachedWiki ) {
105 $ret[
'attachedwiki'] = [];
110 foreach ( $providerIds
as $providerId ) {
112 $ret[
'centralids'][$providerId] = $provider->centralIdFromName(
$name );
113 $ret[
'attachedlocal'][$providerId] = $provider->isAttached(
$user );
114 if ( $attachedWiki ) {
115 $ret[
'attachedwiki'][$providerId] = $provider->isAttached(
$user, $attachedWiki );
125 $vals[
'id'] = intval(
$user->getId() );
126 $vals[
'name'] =
$user->getName();
128 if (
$user->isAnon() ) {
129 $vals[
'anon'] =
true;
132 if ( isset( $this->prop[
'blockinfo'] ) &&
$user->isBlocked() ) {
133 $vals = array_merge( $vals, self::getBlockInfo(
$user->getBlock() ) );
136 if ( isset( $this->prop[
'hasmsg'] ) ) {
137 $vals[
'messages'] =
$user->getNewtalk();
140 if ( isset( $this->prop[
'groups'] ) ) {
141 $vals[
'groups'] =
$user->getEffectiveGroups();
146 if ( isset( $this->prop[
'groupmemberships'] ) ) {
147 $ugms =
$user->getGroupMemberships();
148 $vals[
'groupmemberships'] = [];
149 foreach ( $ugms
as $group => $ugm ) {
150 $vals[
'groupmemberships'][] = [
159 if ( isset( $this->prop[
'implicitgroups'] ) ) {
160 $vals[
'implicitgroups'] =
$user->getAutomaticGroups();
165 if ( isset( $this->prop[
'rights'] ) ) {
167 $vals[
'rights'] = array_values( array_unique(
$user->getRights() ) );
172 if ( isset( $this->prop[
'changeablegroups'] ) ) {
173 $vals[
'changeablegroups'] =
$user->changeableGroups();
180 if ( isset( $this->prop[
'options'] ) ) {
181 $vals[
'options'] =
$user->getOptions();
185 if ( isset( $this->prop[
'preferencestoken'] ) &&
187 $user->isAllowed(
'editmyoptions' )
192 if ( isset( $this->prop[
'editcount'] ) ) {
195 $vals[
'editcount'] = intval(
$user->getEditCount() );
198 if ( isset( $this->prop[
'ratelimits'] ) ) {
202 if ( isset( $this->prop[
'realname'] ) &&
203 !in_array(
'realname', $this->
getConfig()->
get(
'HiddenPrefs' ) )
205 $vals[
'realname'] =
$user->getRealName();
208 if (
$user->isAllowed(
'viewmyprivateinfo' ) ) {
209 if ( isset( $this->prop[
'email'] ) ) {
210 $vals[
'email'] =
$user->getEmail();
211 $auth =
$user->getEmailAuthenticationTimestamp();
212 if ( !is_null( $auth ) ) {
213 $vals[
'emailauthenticated'] =
wfTimestamp( TS_ISO_8601, $auth );
218 if ( isset( $this->prop[
'registrationdate'] ) ) {
219 $regDate =
$user->getRegistration();
220 if ( $regDate !==
false ) {
221 $vals[
'registrationdate'] =
wfTimestamp( TS_ISO_8601, $regDate );
225 if ( isset( $this->prop[
'acceptlang'] ) ) {
226 $langs = $this->
getRequest()->getAcceptLang();
228 foreach ( $langs
as $lang => $val ) {
229 $r = [
'q' => $val ];
234 $vals[
'acceptlang'] = $acceptLang;
237 if ( isset( $this->prop[
'unreadcount'] ) ) {
238 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
239 $unreadNotifications = $store->countUnreadNotifications(
241 self::WL_UNREAD_LIMIT
244 if ( $unreadNotifications ===
true ) {
245 $vals[
'unreadcount'] = self::WL_UNREAD_LIMIT .
'+';
247 $vals[
'unreadcount'] = $unreadNotifications;
251 if ( isset( $this->prop[
'centralids'] ) ) {
266 if ( !
$user->isPingLimitable() ) {
272 if (
$user->isAnon() ) {
273 $categories[] =
'anon';
275 $categories[] =
'user';
277 if (
$user->isNewbie() ) {
278 $categories[] =
'ip';
279 $categories[] =
'subnet';
280 if ( !
$user->isAnon() ) {
281 $categories[] =
'newbie';
284 $categories = array_merge( $categories,
$user->getGroups() );
287 foreach ( $this->
getConfig()->get(
'RateLimits' )
as $action => $limits ) {
288 foreach ( $categories
as $cat ) {
289 if ( isset( $limits[$cat] ) && !is_null( $limits[$cat] ) ) {
290 $retval[$action][$cat][
'hits'] = intval( $limits[$cat][0] );
291 $retval[$action][$cat][
'seconds'] = intval( $limits[$cat][1] );
324 'apihelp-query+userinfo-paramvalue-prop-unreadcount',
325 self::WL_UNREAD_LIMIT - 1,
326 self::WL_UNREAD_LIMIT .
'+',
330 'preferencestoken' => [
331 'apiwarn-deprecation-withreplacement',
333 'action=query&meta=tokens',
337 'attachedwiki' =>
null,
343 'action=query&meta=userinfo'
344 =>
'apihelp-query+userinfo-example-simple',
345 'action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg'
346 =>
'apihelp-query+userinfo-example-data',
351 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Userinfo';
getConfig()
Get the Config 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
getSystemBlockType()
Get the system block type, if any.
This is the main query class.
if(!isset( $args[0])) $lang
getBy()
Get the user id of the blocking sysop.
const META_TYPE
Key for the 'type' metadata item.
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. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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. '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) '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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. 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
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Query module to get information about the currently logged-in user.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
getResult()
Get the result object.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Allows to change the fields on the form that will be generated $name
getRequest()
Get the WebRequest object.
getUser()
Get the User object.
const PARAM_DEPRECATED_VALUES
(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
getExamplesMessages()
Returns usage examples for this module.
This is a base class for all Query modules.
const META_BC_BOOLS
Key for the 'BC bools' metadata item.
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
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 incomplete not yet checked for validity & $retval
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
__construct(ApiQuery $query, $moduleName)
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
getModuleName()
Get the name of the module being executed by this instance.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
static formatExpiry( $expiry, $infinity='infinity')
Format an expiry timestamp for API output.
getMain()
Get the main module.
static getCentralUserInfo(Config $config, User $user, $attachedWiki=null)
Get central user info.
getByName()
Get the username of the blocking sysop.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
static factory( $providerId=null)
Fetch a CentralIdLookup.
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
getHelpUrls()
Return links to more detailed help pages about the module.
static getBlockInfo(Block $block)
Get basic info about a given block.