MediaWiki  1.30.0
ApiQueryGadgets.php
Go to the documentation of this file.
1 <?php
26  private $props;
27 
31  private $categories;
32 
36  private $neededIds;
37 
41  private $listAllowed;
42 
46  private $listEnabled;
47 
48  public function __construct( ApiQuery $queryModule, $moduleName ) {
49  parent::__construct( $queryModule, $moduleName, 'ga' );
50  }
51 
52  public function execute() {
53  $params = $this->extractRequestParams();
54  $this->props = array_flip( $params['prop'] );
55  $this->categories = isset( $params['categories'] )
56  ? array_flip( $params['categories'] )
57  : false;
58  $this->neededIds = isset( $params['ids'] )
59  ? array_flip( $params['ids'] )
60  : false;
61  $this->listAllowed = isset( $params['allowedonly'] ) && $params['allowedonly'];
62  $this->listEnabled = isset( $params['enabledonly'] ) && $params['enabledonly'];
63 
64  $this->getMain()->setCacheMode( $this->listAllowed || $this->listEnabled
65  ? 'anon-public-user-private' : 'public' );
66 
67  $this->applyList( $this->getList() );
68  }
69 
73  private function getList() {
74  $gadgets = GadgetRepo::singleton()->getStructuredList();
75 
76  if ( $gadgets === false ) {
77  return [];
78  }
79 
80  $result = [];
81  foreach ( $gadgets as $category => $list ) {
82  if ( $this->categories && !isset( $this->categories[$category] ) ) {
83  continue;
84  }
85 
86  foreach ( $list as $g ) {
87  if ( $this->isNeeded( $g ) ) {
88  $result[] = $g;
89  }
90  }
91  }
92  return $result;
93  }
94 
98  private function applyList( $gadgets ) {
99  $data = [];
100  $result = $this->getResult();
101 
105  foreach ( $gadgets as $g ) {
106  $row = [];
107  if ( isset( $this->props['id'] ) ) {
108  $row['id'] = $g->getName();
109  }
110 
111  if ( isset( $this->props['metadata'] ) ) {
112  $row['metadata'] = $this->fakeMetadata( $g );
113  $this->setIndexedTagNameForMetadata( $row['metadata'] );
114  }
115 
116  if ( isset( $this->props['desc'] ) ) {
117  $row['desc'] = $g->getDescription();
118  }
119 
120  $data[] = $row;
121  }
122 
123  $result->setIndexedTagName( $data, 'gadget' );
124  $result->addValue( 'query', $this->getModuleName(), $data );
125  }
126 
132  private function isNeeded( Gadget $gadget ) {
133  $user = $this->getUser();
134 
135  return ( $this->neededIds === false || isset( $this->neededIds[$gadget->getName()] ) )
136  && ( !$this->listAllowed || $gadget->isAllowed( $user ) )
137  && ( !$this->listEnabled || $gadget->isEnabled( $user ) );
138  }
139 
144  private function fakeMetadata( Gadget $g ) {
145  return [
146  'settings' => [
147  'rights' => $g->getRequiredRights(),
148  'skins' => $g->getRequiredSkins(),
149  'default' => $g->isOnByDefault(),
150  'hidden' => $g->isHidden(),
151  'shared' => false,
152  'category' => $g->getCategory(),
153  'legacyscripts' => (bool)$g->getLegacyScripts(),
154  ],
155  'module' => [
156  'scripts' => $g->getScripts(),
157  'styles' => $g->getStyles(),
158  'dependencies' => $g->getDependencies(),
159  'peers' => $g->getPeers(),
160  'messages' => $g->getMessages(),
161  ]
162  ];
163  }
164 
165  private function setIndexedTagNameForMetadata( &$metadata ) {
166  static $tagNames = [
167  'rights' => 'right',
168  'skins' => 'skin',
169  'scripts' => 'script',
170  'styles' => 'style',
171  'dependencies' => 'dependency',
172  'peers' => 'peer',
173  'messages' => 'message',
174  ];
175 
176  $result = $this->getResult();
177  foreach ( $metadata as &$data ) {
178  foreach ( $data as $key => &$value ) {
179  if ( is_array( $value ) ) {
180  $tag = isset( $tagNames[$key] ) ? $tagNames[$key] : $key;
181  $result->setIndexedTagName( $value, $tag );
182  }
183  }
184  }
185  }
186 
187  public function getAllowedParams() {
188  return [
189  'prop' => [
190  ApiBase::PARAM_DFLT => 'id|metadata',
191  ApiBase::PARAM_ISMULTI => true,
193  'id',
194  'metadata',
195  'desc',
196  ],
197  ],
198  'categories' => [
199  ApiBase::PARAM_ISMULTI => true,
200  ApiBase::PARAM_TYPE => 'string',
201  ],
202  'ids' => [
203  ApiBase::PARAM_TYPE => 'string',
204  ApiBase::PARAM_ISMULTI => true,
205  ],
206  'allowedonly' => false,
207  'enabledonly' => false,
208  ];
209  }
210 
215  protected function getExamplesMessages() {
216  $params = $this->getAllowedParams();
217  $allProps = implode( '|', $params['prop'][ApiBase::PARAM_TYPE] );
218  return [
219  'action=query&list=gadgets&gaprop=id|desc'
220  => 'apihelp-query+gadgets-example-1',
221  "action=query&list=gadgets&gaprop=$allProps"
222  => 'apihelp-query+gadgets-example-2',
223  'action=query&list=gadgets&gacategories=foo'
224  => 'apihelp-query+gadgets-example-3',
225  'action=query&list=gadgets&gaids=foo|bar&gaprop=id|desc|metadata'
226  => 'apihelp-query+gadgets-example-4',
227  'action=query&list=gadgets&gaenabledonly'
228  => 'apihelp-query+gadgets-example-5',
229  ];
230  }
231 }
ApiQueryGadgets\$props
array $props
Definition: ApiQueryGadgets.php:26
$user
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
Definition: hooks.txt:244
ApiQueryGadgets\applyList
applyList( $gadgets)
Definition: ApiQueryGadgets.php:98
ApiQuery
This is the main query class.
Definition: ApiQuery.php:40
Gadget\isOnByDefault
isOnByDefault()
Definition: Gadgets_body.php:183
Gadget\getStyles
getStyles()
Definition: Gadgets_body.php:227
ApiQueryGadgets\getList
getList()
Definition: ApiQueryGadgets.php:73
Gadget\getRequiredRights
getRequiredRights()
Returns array of permissions required by this gadget.
Definition: Gadgets_body.php:288
Gadget\getMessages
getMessages()
Definition: Gadgets_body.php:280
$result
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
Definition: hooks.txt:1963
ApiQueryGadgets\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryGadgets.php:52
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:91
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:632
$params
$params
Definition: styleTest.css.php:40
Gadget\getScripts
getScripts()
Definition: Gadgets_body.php:220
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:133
php
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
Definition: injection.txt:35
Gadget\getPeers
getPeers()
Get list of extra modules that should be loaded when this gadget is enabled.
Definition: Gadgets_body.php:273
ApiQueryGadgets\isNeeded
isNeeded(Gadget $gadget)
Definition: ApiQueryGadgets.php:132
ApiQueryGadgets\getExamplesMessages
getExamplesMessages()
Definition: ApiQueryGadgets.php:215
ApiQueryGadgets
Created on 15 April 2011 API for Gadgets extension.
Definition: ApiQueryGadgets.php:22
ApiQueryGadgets\fakeMetadata
fakeMetadata(Gadget $g)
Definition: ApiQueryGadgets.php:144
ApiQueryGadgets\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryGadgets.php:187
Gadget\isHidden
isHidden()
Definition: Gadgets_body.php:190
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:37
ApiQueryGadgets\$listEnabled
bool $listEnabled
Definition: ApiQueryGadgets.php:46
Gadget
Wrapper for one gadget.
Definition: Gadgets_body.php:17
ApiQueryGadgets\$neededIds
array bool $neededIds
Definition: ApiQueryGadgets.php:36
GadgetRepo\singleton
static singleton()
Get the configured default GadgetRepo.
Definition: GadgetRepo.php:53
Gadget\getName
getName()
Definition: Gadgets_body.php:121
Gadget\getRequiredSkins
getRequiredSkins()
Returns array of skins where this gadget works.
Definition: Gadgets_body.php:296
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:740
Gadget\isAllowed
isAllowed( $user)
Checks whether given user has permissions to use this gadget.
Definition: Gadgets_body.php:170
$value
$value
Definition: styleTest.css.php:45
Gadget\getLegacyScripts
getLegacyScripts()
Returns list of scripts that don't support ResourceLoader.
Definition: Gadgets_body.php:249
ApiQueryGadgets\setIndexedTagNameForMetadata
setIndexedTagNameForMetadata(&$metadata)
Definition: ApiQueryGadgets.php:165
ApiQueryGadgets\__construct
__construct(ApiQuery $queryModule, $moduleName)
Definition: ApiQueryGadgets.php:48
ApiQueryGadgets\$categories
array bool $categories
Definition: ApiQueryGadgets.php:31
Gadget\isEnabled
isEnabled( $user)
Checks whether this gadget is enabled for given user.
Definition: Gadgets_body.php:160
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:52
as
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
Definition: distributors.txt:9
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:512
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:55
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:528
Gadget\getCategory
getCategory()
Definition: Gadgets_body.php:142
ApiQueryGadgets\$listAllowed
bool $listAllowed
Definition: ApiQueryGadgets.php:41
array
the array() calling protocol came about after MediaWiki 1.4rc1.
Gadget\getDependencies
getDependencies()
Returns names of resources this gadget depends on.
Definition: Gadgets_body.php:260