MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
35  public function __construct( $name = 'GadgetUsage' ) {
36  parent::__construct( $name );
37  $this->limit = 1000; // Show all gadgets
38  $this->shownavigation = false;
39  $this->activeUsers = $this->getConfig()->get( 'SpecialGadgetUsageActiveUsers' );
40  }
47  public $activeUsers;
49  public function isExpensive() {
50  return true;
51  }
72  public function getQueryInfo() {
73  $dbr = wfGetDB( DB_REPLICA );
74  if ( !$this->activeUsers ) {
75  return [
76  'tables' => [ 'user_properties' ],
77  'fields' => [
78  'title' => 'up_property',
79  'value' => 'SUM( up_value )',
80  'namespace' => NS_GADGET
81  ],
82  'conds' => [
83  'up_property' . $dbr->buildLike( 'gadget-', $dbr->anyString() )
84  ],
85  'options' => [
86  'GROUP BY' => [ 'up_property' ]
87  ]
88  ];
89  } else {
90  return [
91  'tables' => [ 'user_properties', 'user', 'querycachetwo' ],
92  'fields' => [
93  'title' => 'up_property',
94  'value' => 'SUM( up_value )',
95  // Need to pick fields existing in the querycache table so that the results are cachable
96  'namespace' => 'COUNT( qcc_title )'
97  ],
98  'conds' => [
99  'up_property' . $dbr->buildLike( 'gadget-', $dbr->anyString() )
100  ],
101  'options' => [
102  'GROUP BY' => [ 'up_property' ]
103  ],
104  'join_conds' => [
105  'user' => [
106  'LEFT JOIN', [
107  'up_user = user_id'
108  ]
109  ],
110  'querycachetwo' => [
111  'LEFT JOIN', [
112  'user_name = qcc_title',
113  'qcc_type = "activeusers"',
114  'up_value = 1'
115  ]
116  ]
117  ]
118  ];
119  }
120  }
122  public function getOrderFields() {
123  return [ 'value' ];
124  }
131  protected function outputTableStart() {
132  $html = Html::openElement( 'table', [ 'class' => [ 'sortable', 'wikitable' ] ] );
133  $html .= Html::openElement( 'thead', [] );
134  $html .= Html::openElement( 'tr', [] );
135  $headers = [ 'gadgetusage-gadget', 'gadgetusage-usercount' ];
136  if ( $this->activeUsers ) {
137  $headers[] = 'gadgetusage-activeusers';
138  }
139  foreach ( $headers as $h ) {
140  if ( $h == 'gadgetusage-gadget' ) {
141  $html .= Html::element( 'th', [], $this->msg( $h )->text() );
142  } else {
143  $html .= Html::element( 'th', [ 'data-sort-type' => 'number' ],
144  $this->msg( $h )->text() );
145  }
146  }
147  $html .= Html::closeElement( 'tr' );
148  $html .= Html::closeElement( 'thead' );
149  $html .= Html::openElement( 'tbody', [] );
150  $this->getOutput()->addHTML( $html );
151  }
157  protected function outputTableEnd() {
158  $this->getOutput()->addHTML(
159  Html::closeElement( 'tbody' ) .
160  Html::closeElement( 'table' )
161  );
162  }
169  public function formatResult( $skin, $result ) {
170  $gadgetTitle = substr( $result->title, 7 );
171  $gadgetUserCount = $this->getLanguage()->formatNum( $result->value );
172  if ( $gadgetTitle ) {
173  $html = Html::openElement( 'tr', [] );
174  $html .= Html::element( 'td', [], $gadgetTitle );
175  $html .= Html::element( 'td', [], $gadgetUserCount );
176  if ( $this->activeUsers == true ) {
177  $activeUserCount = $this->getLanguage()->formatNum( $result->namespace );
178  $html .= Html::element( 'td', [], $activeUserCount );
179  }
180  $html .= Html::closeElement( 'tr' );
181  return $html;
182  }
183  return false;
184  }
192  protected function getDefaultGadgets( $gadgetRepo, $gadgetIds ) {
193  $gadgetsList = [];
194  foreach ( $gadgetIds as $g ) {
195  $gadget = $gadgetRepo->getGadget( $g );
196  if ( $gadget->isOnByDefault() ) {
197  $gadgetsList[] = $gadget->getName();
198  }
199  }
200  asort( $gadgetsList, SORT_STRING | SORT_FLAG_CASE );
201  return $gadgetsList;
202  }
215  protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) {
216  $gadgetRepo = GadgetRepo::singleton();
217  $gadgetIds = $gadgetRepo->getGadgetIds();
218  $defaultGadgets = $this->getDefaultGadgets( $gadgetRepo, $gadgetIds );
219  if ( $this->activeUsers ) {
220  $out->addHtml(
221  $this->msg( 'gadgetusage-intro' )
222  ->numParams( $this->getConfig()->get( 'ActiveUserDays' ) )->parseAsBlock()
223  );
224  } else {
225  $out->addHtml(
226  $this->msg( 'gadgetusage-intro-noactive' )->parseAsBlock()
227  );
228  }
229  if ( $num > 0 ) {
230  $this->outputTableStart();
231  // Append default gadgets to the table with 'default' in the total and active user fields
232  foreach ( $defaultGadgets as $default ) {
233  $html = Html::openElement( 'tr', [] );
234  $html .= Html::element( 'td', [], $default );
235  $html .= Html::element( 'td', [ 'data-sort-value' => 'Infinity' ],
236  $this->msg( 'gadgetusage-default' )->text() );
237  if ( $this->activeUsers ) {
238  $html .= Html::element( 'td', [ 'data-sort-value' => 'Infinity' ],
239  $this->msg( 'gadgetusage-default' )->text() );
240  }
241  $html .= Html::closeElement( 'tr' );
242  $out->addHTML( $html );
243  }
244  foreach ( $res as $row ) {
245  // Remove the 'gadget-' part of the result string and compare if it's present
246  // in $defaultGadgets, if not we format it and add it to the output
247  if ( !in_array( substr( $row->title, 7 ), $defaultGadgets ) ) {
248  // Only pick gadgets which are in the list $gadgetIds to make sure they exist
249  if ( in_array( substr( $row->title, 7 ), $gadgetIds ) ) {
250  $line = $this->formatResult( $skin, $row );
251  if ( $line ) {
252  $out->addHTML( $line );
253  }
254  }
255  }
256  }
257  // Close table element
258  $this->outputTableEnd();
259  } else {
260  $out->addHtml(
261  $this->msg( 'gadgetusage-noresults' )->parseAsBlock()
262  );
263  }
264  }
266  protected function getGroupName() {
267  return 'wiki';
268  }
269 }
Subclasses return an array of fields to order by here.
Definition: SpecialGadgetUsage.php:122
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:796
__construct( $name='GadgetUsage')
Definition: SpecialGadgetUsage.php:35
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:725
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialGadgetUsage.php:266
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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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. '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 '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 since 1.28! 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:1983
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:780
Output the end of the table </tbody>
Definition: SpecialGadgetUsage.php:157
outputResults( $out, $skin, $dbr, $res, $num, $offset)
Format and output report results using the given information plus OutputPage.
Definition: SpecialGadgetUsage.php:215
Output the start of the table Including opening.
Definition: SpecialGadgetUsage.php:131
Definition: database.txt:21
Shortcut to get user's language.
Definition: SpecialPage.php:755
This is a class for doing query pages; since they're almost all the same, we factor out some of the f...
Definition: QueryPage.php:35
int $offset
The offset and limit in use, as passed to the query() function.
Definition: QueryPage.php:40
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
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
Define the database query that is used to generate the stats table.
Definition: SpecialGadgetUsage.php:72
Definition: testCompression.php:50
Flag for holding the value of config variable SpecialGadgetUsageActiveUsers.
Definition: SpecialGadgetUsage.php:47
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 just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1985
Shortcut to get main config object.
Definition: SpecialPage.php:764
Result wrapper for grabbing data queried from an IDatabase object.
Definition: IResultWrapper.php:24
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2636
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
Definition: MIT-LICENSE.txt:10
Definition: defines.php:25
static singleton()
Get the configured default GadgetRepo.
Definition: GadgetRepo.php:88
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
Definition: cdb.php:59
Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.
Definition: SpecialGadgetUsage.php:49
Special:GadgetUsage - Lists all the gadgets on the wiki along with number of users.
Definition: SpecialGadgetUsage.php:34
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
Definition: All_system_messages.txt:1267
getDefaultGadgets( $gadgetRepo, $gadgetIds)
Get a list of default gadgets.
Definition: SpecialGadgetUsage.php:192
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
formatResult( $skin, $result)
Definition: SpecialGadgetUsage.php:169
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 just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition: hooks.txt:1985