MediaWiki  1.30.0
SpecialGadgetUsage.php
Go to the documentation of this file.
1 <?php
32  function __construct( $name = 'GadgetUsage' ) {
33  parent::__construct( $name );
34  $this->limit = 1000; // Show all gadgets
35  $this->shownavigation = false;
36  $this->activeUsers = $this->getConfig()->get( 'SpecialGadgetUsageActiveUsers' );
37  }
38 
44  public $activeUsers;
45 
46  public function isExpensive() {
47  return true;
48  }
49 
69  public function getQueryInfo() {
70  $dbr = wfGetDB( DB_SLAVE );
71  if ( !$this->activeUsers ) {
72  return [
73  'tables' => [ 'user_properties' ],
74  'fields' => [
75  'title' => 'up_property',
76  'value' => 'SUM( up_value )',
77  'namespace' => NS_GADGET
78  ],
79  'conds' => [
80  'up_property' . $dbr->buildLike( 'gadget-', $dbr->anyString() )
81  ],
82  'options' => [
83  'GROUP BY' => [ 'up_property' ]
84  ]
85  ];
86  } else {
87  return [
88  'tables' => [ 'user_properties', 'user', 'querycachetwo' ],
89  'fields' => [
90  'title' => 'up_property',
91  'value' => 'SUM( up_value )',
92  // Need to pick fields existing in the querycache table so that the results are cachable
93  'namespace' => 'COUNT( qcc_title )'
94  ],
95  'conds' => [
96  'up_property' . $dbr->buildLike( 'gadget-', $dbr->anyString() )
97  ],
98  'options' => [
99  'GROUP BY' => [ 'up_property' ]
100  ],
101  'join_conds' => [
102  'user' => [
103  'LEFT JOIN', [
104  'up_user = user_id'
105  ]
106  ],
107  'querycachetwo' => [
108  'LEFT JOIN', [
109  'user_name = qcc_title',
110  'qcc_type = "activeusers"',
111  'up_value = 1'
112  ]
113  ]
114  ]
115  ];
116  }
117  }
118 
119  public function getOrderFields() {
120  return [ 'value' ];
121  }
122 
127  protected function outputTableStart() {
128  $html = Html::openElement( 'table', [ 'class' => [ 'sortable', 'wikitable' ] ] );
129  $html .= Html::openElement( 'tr', [] );
130  $headers = [ 'gadgetusage-gadget', 'gadgetusage-usercount' ];
131  if ( $this->activeUsers ) {
132  $headers[] = 'gadgetusage-activeusers';
133  }
134  foreach ( $headers as $h ) {
135  if ( $h == 'gadgetusage-gadget' ) {
136  $html .= Html::element( 'th', [], $this->msg( $h )->text() );
137  } else {
138  $html .= Html::element( 'th', [ 'data-sort-type' => 'number' ],
139  $this->msg( $h )->text() );
140  }
141  }
142  $html .= Html::closeElement( 'tr' );
143  $this->getOutput()->addHTML( $html );
144  }
145 
151  public function formatResult( $skin, $result ) {
152  $gadgetTitle = substr( $result->title, 7 );
153  $gadgetUserCount = $this->getLanguage()->formatNum( $result->value );
154  if ( $gadgetTitle ) {
155  $html = Html::openElement( 'tr', [] );
156  $html .= Html::element( 'td', [], $gadgetTitle );
157  $html .= Html::element( 'td', [], $gadgetUserCount );
158  if ( $this->activeUsers == true ) {
159  $activeUserCount = $this->getLanguage()->formatNum( $result->namespace );
160  $html .= Html::element( 'td', [], $activeUserCount );
161  }
162  $html .= Html::closeElement( 'tr' );
163  return $html;
164  }
165  return false;
166  }
167 
174  protected function getDefaultGadgets( $gadgetRepo, $gadgetIds ) {
175  $gadgetsList = [];
176  foreach ( $gadgetIds as $g ) {
177  $gadget = $gadgetRepo->getGadget( $g );
178  if ( $gadget->isOnByDefault() ) {
179  $gadgetsList[] = $gadget->getName();
180  }
181  }
182  asort( $gadgetsList, SORT_STRING | SORT_FLAG_CASE );
183  return $gadgetsList;
184  }
185 
197  protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) {
198  $gadgetRepo = GadgetRepo::singleton();
199  $gadgetIds = $gadgetRepo->getGadgetIds();
200  $defaultGadgets = $this->getDefaultGadgets( $gadgetRepo, $gadgetIds );
201  if ( $this->activeUsers ) {
202  $out->addHtml(
203  $this->msg( 'gadgetusage-intro' )
204  ->numParams( $this->getConfig()->get( 'ActiveUserDays' ) )->parseAsBlock()
205  );
206  } else {
207  $out->addHtml(
208  $this->msg( 'gadgetusage-intro-noactive' )->parseAsBlock()
209  );
210  }
211  if ( $num > 0 ) {
212  $this->outputTableStart();
213  // Append default gadgets to the table with 'default' in the total and active user fields
214  foreach ( $defaultGadgets as $default ) {
215  $html = Html::openElement( 'tr', [] );
216  $html .= Html::element( 'td', [], $default );
217  $html .= Html::element( 'td', [], $this->msg( 'gadgetusage-default' )->text() );
218  if ( $this->activeUsers ) {
219  $html .= Html::element( 'td', [], $this->msg( 'gadgetusage-default' )->text() );
220  }
221  $html .= Html::closeElement( 'tr' );
222  $out->addHTML( $html );
223  }
224  foreach ( $res as $row ) {
225  // Remove the 'gadget-' part of the result string and compare if it's present
226  // in $defaultGadgets, if not we format it and add it to the output
227  if ( !in_array( substr( $row->title, 7 ), $defaultGadgets ) ) {
228  // Only pick gadgets which are in the list $gadgetIds to make sure they exist
229  if ( in_array( substr( $row->title, 7 ), $gadgetIds ) ) {
230  $line = $this->formatResult( $skin, $row );
231  if ( $line ) {
232  $out->addHTML( $line );
233  }
234  }
235  }
236  }
237  // Close table element
238  $out->addHtml( Html::closeElement( 'table' ) );
239  } else {
240  $out->addHtml(
241  $this->msg( 'gadgetusage-noresults' )->parseAsBlock()
242  );
243  }
244  }
245 
246  protected function getGroupName() {
247  return 'wiki';
248  }
249 }
SpecialGadgetUsage\getOrderFields
getOrderFields()
Subclasses return an array of fields to order by here.
Definition: SpecialGadgetUsage.php:119
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:746
SpecialGadgetUsage\__construct
__construct( $name='GadgetUsage')
Definition: SpecialGadgetUsage.php:32
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:675
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
SpecialGadgetUsage\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialGadgetUsage.php:246
$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
SpecialGadgetUsage\outputResults
outputResults( $out, $skin, $dbr, $res, $num, $offset)
Format and output report results using the given information plus OutputPage.
Definition: SpecialGadgetUsage.php:197
SpecialGadgetUsage\outputTableStart
outputTableStart()
Output the start of the table Including opening.
Definition: SpecialGadgetUsage.php:127
DB_SLAVE
const DB_SLAVE
Definition: Defines.php:37
$res
$res
Definition: database.txt:21
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:705
QueryPage
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:34
QueryPage\$offset
int $offset
The offset and limit in use, as passed to the query() function.
Definition: QueryPage.php:39
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
SpecialGadgetUsage\getQueryInfo
getQueryInfo()
Define the database query that is used to generate the stats table.
Definition: SpecialGadgetUsage.php:69
Html\closeElement
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:309
SpecialGadgetUsage\$activeUsers
$activeUsers
Flag for holding the value of config variable SpecialGadgetUsageActiveUsers.
Definition: SpecialGadgetUsage.php:44
$html
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:1965
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:714
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2856
GadgetRepo\singleton
static singleton()
Get the configured default GadgetRepo.
Definition: GadgetRepo.php:53
$line
$line
Definition: cdb.php:58
SpecialGadgetUsage\isExpensive
isExpensive()
Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.
Definition: SpecialGadgetUsage.php:46
SpecialGadgetUsage
Special:GadgetUsage - Lists all the gadgets on the wiki along with number of users.
Definition: SpecialGadgetUsage.php:31
SpecialGadgetUsage\getDefaultGadgets
getDefaultGadgets( $gadgetRepo, $gadgetIds)
Get a list of default gadgets.
Definition: SpecialGadgetUsage.php:174
$dbr
if(! $regexes) $dbr
Definition: cleanup.php:94
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
SpecialGadgetUsage\formatResult
formatResult( $skin, $result)
Definition: SpecialGadgetUsage.php:151
Html\openElement
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:251
$skin
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:1965
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:781