MediaWiki  master
SpecialStatistics.php
Go to the documentation of this file.
1 <?php
33 
34  public function __construct() {
35  parent::__construct( 'Statistics' );
36  }
37 
38  public function execute( $par ) {
39  $this->setHeaders();
40  $this->getOutput()->addModuleStyles( 'mediawiki.special' );
41 
42  $this->edits = SiteStats::edits();
43  $this->good = SiteStats::articles();
44  $this->images = SiteStats::images();
45  $this->total = SiteStats::pages();
46  $this->users = SiteStats::users();
47  $this->activeUsers = SiteStats::activeUsers();
48  $this->hook = '';
49 
50  $text = Xml::openElement( 'table', [ 'class' => 'wikitable mw-statistics-table' ] );
51 
52  # Statistic - pages
53  $text .= $this->getPageStats();
54 
55  # Statistic - edits
56  $text .= $this->getEditStats();
57 
58  # Statistic - users
59  $text .= $this->getUserStats();
60 
61  # Statistic - usergroups
62  $text .= $this->getGroupStats();
63 
64  # Statistic - other
65  $extraStats = [];
66  if ( Hooks::run( 'SpecialStatsAddExtra', [ &$extraStats, $this->getContext() ] ) ) {
67  $text .= $this->getOtherStats( $extraStats );
68  }
69 
70  $text .= Xml::closeElement( 'table' );
71 
72  # Customizable footer
73  $footer = $this->msg( 'statistics-footer' );
74  if ( !$footer->isBlank() ) {
75  $text .= "\n" . $footer->parse();
76  }
77 
78  $this->getOutput()->addHTML( $text );
79  }
80 
90  private function formatRow( $text, $number, $trExtraParams = [],
91  $descMsg = '', $descMsgParam = ''
92  ) {
93  if ( $descMsg ) {
94  $msg = $this->msg( $descMsg, $descMsgParam );
95  if ( !$msg->isDisabled() ) {
96  $descriptionHtml = $this->msg( 'parentheses' )->rawParams( $msg->parse() )
97  ->escaped();
98  $text .= "<br />" . Html::rawElement(
99  'small',
100  [ 'class' => 'mw-statistic-desc' ],
101  " $descriptionHtml"
102  );
103  }
104  }
105 
106  return Html::rawElement( 'tr', $trExtraParams,
107  Html::rawElement( 'td', [], $text ) .
108  Html::rawElement( 'td', [ 'class' => 'mw-statistics-numbers' ], $number )
109  );
110  }
111 
117  private function getPageStats() {
118  $linkRenderer = $this->getLinkRenderer();
119 
120  $specialAllPagesTitle = SpecialPage::getTitleFor( 'Allpages' );
121  $pageStatsHtml = Xml::openElement( 'tr' ) .
122  Xml::tags( 'th', [ 'colspan' => '2' ], $this->msg( 'statistics-header-pages' )
123  ->parse() ) .
124  Xml::closeElement( 'tr' ) .
125  $this->formatRow( $linkRenderer->makeKnownLink(
126  $specialAllPagesTitle,
127  $this->msg( 'statistics-articles' )->text(),
128  [], [ 'hideredirects' => 1 ] ),
129  $this->getLanguage()->formatNum( $this->good ),
130  [ 'class' => 'mw-statistics-articles' ],
131  'statistics-articles-desc' ) .
132  $this->formatRow( $linkRenderer->makeKnownLink( $specialAllPagesTitle,
133  $this->msg( 'statistics-pages' )->text() ),
134  $this->getLanguage()->formatNum( $this->total ),
135  [ 'class' => 'mw-statistics-pages' ],
136  'statistics-pages-desc' );
137 
138  // Show the image row only, when there are files or upload is possible
139  if ( $this->images !== 0 || $this->getConfig()->get( 'EnableUploads' ) ) {
140  $pageStatsHtml .= $this->formatRow(
141  $linkRenderer->makeKnownLink( SpecialPage::getTitleFor( 'MediaStatistics' ),
142  $this->msg( 'statistics-files' )->text() ),
143  $this->getLanguage()->formatNum( $this->images ),
144  [ 'class' => 'mw-statistics-files' ] );
145  }
146 
147  return $pageStatsHtml;
148  }
149 
150  private function getEditStats() {
151  return Xml::openElement( 'tr' ) .
152  Xml::tags( 'th', [ 'colspan' => '2' ],
153  $this->msg( 'statistics-header-edits' )->parse() ) .
154  Xml::closeElement( 'tr' ) .
155  $this->formatRow( $this->msg( 'statistics-edits' )->parse(),
156  $this->getLanguage()->formatNum( $this->edits ),
157  [ 'class' => 'mw-statistics-edits' ]
158  ) .
159  $this->formatRow( $this->msg( 'statistics-edits-average' )->parse(),
160  $this->getLanguage()->formatNum(
161  sprintf( '%.2f', $this->total ? $this->edits / $this->total : 0 )
162  ), [ 'class' => 'mw-statistics-edits-average' ]
163  );
164  }
165 
166  private function getUserStats() {
167  return Xml::openElement( 'tr' ) .
168  Xml::tags( 'th', [ 'colspan' => '2' ],
169  $this->msg( 'statistics-header-users' )->parse() ) .
170  Xml::closeElement( 'tr' ) .
171  $this->formatRow( $this->msg( 'statistics-users' )->parse() . ' ' .
172  $this->getLinkRenderer()->makeKnownLink(
173  SpecialPage::getTitleFor( 'Listusers' ),
174  $this->msg( 'listgrouprights-members' )->text()
175  ),
176  $this->getLanguage()->formatNum( $this->users ),
177  [ 'class' => 'mw-statistics-users' ]
178  ) .
179  $this->formatRow( $this->msg( 'statistics-users-active' )->parse() . ' ' .
180  $this->getLinkRenderer()->makeKnownLink(
181  SpecialPage::getTitleFor( 'Activeusers' ),
182  $this->msg( 'listgrouprights-members' )->text()
183  ),
184  $this->getLanguage()->formatNum( $this->activeUsers ),
185  [ 'class' => 'mw-statistics-users-active' ],
186  'statistics-users-active-desc',
187  $this->getLanguage()->formatNum(
188  $this->getConfig()->get( 'ActiveUserDays' ) )
189  );
190  }
191 
192  private function getGroupStats() {
193  $linkRenderer = $this->getLinkRenderer();
194  $text = '';
195  foreach ( $this->getConfig()->get( 'GroupPermissions' ) as $group => $permissions ) {
196  # Skip generic * and implicit groups
197  if ( in_array( $group, $this->getConfig()->get( 'ImplicitGroups' ) )
198  || $group == '*' ) {
199  continue;
200  }
201  $groupname = htmlspecialchars( $group );
202  $msg = $this->msg( 'group-' . $groupname );
203  if ( $msg->isBlank() ) {
204  $groupnameLocalized = $groupname;
205  } else {
206  $groupnameLocalized = $msg->text();
207  }
208  $msg = $this->msg( 'grouppage-' . $groupname )->inContentLanguage();
209  if ( $msg->isBlank() ) {
210  $grouppageLocalized = MWNamespace::getCanonicalName( NS_PROJECT ) .
211  ':' . $groupname;
212  } else {
213  $grouppageLocalized = $msg->text();
214  }
215  $linkTarget = Title::newFromText( $grouppageLocalized );
216 
217  if ( $linkTarget ) {
218  $grouppage = $linkRenderer->makeLink(
219  $linkTarget,
220  $groupnameLocalized
221  );
222  } else {
223  $grouppage = htmlspecialchars( $groupnameLocalized );
224  }
225 
226  $grouplink = $linkRenderer->makeKnownLink(
227  SpecialPage::getTitleFor( 'Listusers' ),
228  $this->msg( 'listgrouprights-members' )->text(),
229  [],
230  [ 'group' => $group ]
231  );
232  # Add a class when a usergroup contains no members to allow hiding these rows
233  $classZero = '';
234  $countUsers = SiteStats::numberingroup( $groupname );
235  if ( $countUsers == 0 ) {
236  $classZero = ' statistics-group-zero';
237  }
238  $text .= $this->formatRow( $grouppage . ' ' . $grouplink,
239  $this->getLanguage()->formatNum( $countUsers ),
240  [ 'class' => 'statistics-group-' . Sanitizer::escapeClass( $group ) .
241  $classZero ] );
242  }
243 
244  return $text;
245  }
246 
254  private function getOtherStats( array $stats ) {
255  $return = '';
256 
257  foreach ( $stats as $header => $items ) {
258  // Identify the structure used
259  if ( is_array( $items ) ) {
260  // Ignore headers that are recursively set as legacy header
261  if ( $header !== 'statistics-header-hooks' ) {
262  $return .= $this->formatRowHeader( $header );
263  }
264 
265  // Collect all items that belong to the same header
266  foreach ( $items as $key => $value ) {
267  if ( is_array( $value ) ) {
268  $name = $value['name'];
269  $number = $value['number'];
270  } else {
271  $name = $this->msg( $key )->parse();
272  $number = $value;
273  }
274 
275  $return .= $this->formatRow(
276  $name,
277  $this->getLanguage()->formatNum( htmlspecialchars( $number ) ),
278  [ 'class' => 'mw-statistics-hook', 'id' => 'mw-' . $key ]
279  );
280  }
281  } else {
282  // Create the legacy header only once
283  if ( $return === '' ) {
284  $return .= $this->formatRowHeader( 'statistics-header-hooks' );
285  }
286 
287  // Recursively remap the legacy structure
288  $return .= $this->getOtherStats( [ 'statistics-header-hooks' =>
289  [ $header => $items ] ] );
290  }
291  }
292 
293  return $return;
294  }
295 
302  private function formatRowHeader( $header ) {
303  return Xml::openElement( 'tr' ) .
304  Xml::tags( 'th', [ 'colspan' => '2' ], $this->msg( $header )->parse() ) .
305  Xml::closeElement( 'tr' );
306  }
307 
308  protected function getGroupName() {
309  return 'wiki';
310  }
311 }
getPageStats()
Each of these methods is pretty self-explanatory, get a particular row for the table of statistics...
the array() calling protocol came about after MediaWiki 1.4rc1.
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2610
getContext()
Gets the context this SpecialPage is executed in.
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name If you don't need a full Title object...
Definition: SpecialPage.php:82
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
$value
static escapeClass($class)
Given a value, escape it so that it can be used as a CSS class and return it.
Definition: Sanitizer.php:1372
static activeUsers()
Definition: SiteStats.php:130
getOutput()
Get the OutputPage being used for this instance.
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
formatRowHeader($header)
Format row header.
static edits()
Definition: SiteStats.php:94
static closeElement($element)
Shortcut to close an XML element.
Definition: Xml.php:118
const NS_PROJECT
Definition: Defines.php:69
static getCanonicalName($index)
Returns the canonical (English) name for a given index.
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a hook
Definition: hooks.txt:23
static openElement($element, $attribs=null)
This opens an XML element.
Definition: Xml.php:109
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs which is used to update link tables of transcluding pages after edits
Definition: deferred.txt:11
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
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
Special page lists various statistics, including the contents of site_stats, plus page view details i...
msg($key)
Wrapper around wfMessage that sets the current context.
$header
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
static images()
Definition: SiteStats.php:139
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
static tags($element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:131
getOtherStats(array $stats)
Conversion of external statistics into an internal representation Following a ([][
static articles()
Definition: SiteStats.php:103
formatRow($text, $number, $trExtraParams=[], $descMsg= '', $descMsgParam= '')
Format a row.
static pages()
Definition: SiteStats.php:112
getConfig()
Shortcut to get main config object.
getLanguage()
Shortcut to get user's language.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
static numberingroup($group)
Find the number of users in a given user group.
Definition: SiteStats.php:150
$footer
static users()
Definition: SiteStats.php:121
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66