3 * Implements Special:Statistics
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * Special page lists various statistics, including the contents of
26 * `site_stats`, plus page view details if enabled
28 * @ingroup SpecialPage
30 class SpecialStatistics
extends SpecialPage
{
31 private $edits, $good, $images, $total, $users,
34 public function __construct() {
35 parent
::__construct( 'Statistics' );
38 public function execute( $par ) {
40 $this->getOutput()->addModuleStyles( 'mediawiki.special' );
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();
50 $text = Xml
::openElement( 'table', [ 'class' => 'wikitable mw-statistics-table' ] );
53 $text .= $this->getPageStats();
56 $text .= $this->getEditStats();
59 $text .= $this->getUserStats();
61 # Statistic - usergroups
62 $text .= $this->getGroupStats();
66 if ( Hooks
::run( 'SpecialStatsAddExtra', [ &$extraStats, $this->getContext() ] ) ) {
67 $text .= $this->getOtherStats( $extraStats );
70 $text .= Xml
::closeElement( 'table' );
73 $footer = $this->msg( 'statistics-footer' );
74 if ( !$footer->isBlank() ) {
75 $text .= "\n" . $footer->parse();
78 $this->getOutput()->addHTML( $text );
83 * @param string $text Description of the row
84 * @param float $number A statistical number
85 * @param array $trExtraParams Params to table row, see Html::elememt
86 * @param string $descMsg Message key
87 * @param array|string $descMsgParam Message parameters
88 * @return string Table row in HTML format
90 private function formatRow( $text, $number, $trExtraParams = [],
91 $descMsg = '', $descMsgParam = ''
94 $msg = $this->msg( $descMsg, $descMsgParam );
95 if ( !$msg->isDisabled() ) {
96 $descriptionHtml = $this->msg( 'parentheses' )->rawParams( $msg->parse() )
98 $text .= "<br />" . Html
::rawElement(
100 [ 'class' => 'mw-statistic-desc' ],
106 return Html
::rawElement( 'tr', $trExtraParams,
107 Html
::rawElement( 'td', [], $text ) .
108 Html
::rawElement( 'td', [ 'class' => 'mw-statistics-numbers' ], $number )
113 * Each of these methods is pretty self-explanatory, get a particular
114 * row for the table of statistics
117 private function getPageStats() {
118 $linkRenderer = $this->getLinkRenderer();
120 $specialAllPagesTitle = SpecialPage
::getTitleFor( 'Allpages' );
121 $pageStatsHtml = Xml
::openElement( 'tr' ) .
122 Xml
::tags( 'th', [ 'colspan' => '2' ], $this->msg( 'statistics-header-pages' )
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' );
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' ] );
147 return $pageStatsHtml;
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' ]
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' ]
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()
176 $this->getLanguage()->formatNum( $this->users
),
177 [ 'class' => 'mw-statistics-users' ]
179 $this->formatRow( $this->msg( 'statistics-users-active' )->parse() . ' ' .
180 $this->getLinkRenderer()->makeKnownLink(
181 SpecialPage
::getTitleFor( 'Activeusers' ),
182 $this->msg( 'listgrouprights-members' )->text()
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' ) )
192 private function getGroupStats() {
193 $linkRenderer = $this->getLinkRenderer();
195 foreach ( $this->getConfig()->get( 'GroupPermissions' ) as $group => $permissions ) {
196 # Skip generic * and implicit groups
197 if ( in_array( $group, $this->getConfig()->get( 'ImplicitGroups' ) )
201 $groupname = htmlspecialchars( $group );
202 $msg = $this->msg( 'group-' . $groupname );
203 if ( $msg->isBlank() ) {
204 $groupnameLocalized = $groupname;
206 $groupnameLocalized = $msg->text();
208 $msg = $this->msg( 'grouppage-' . $groupname )->inContentLanguage();
209 if ( $msg->isBlank() ) {
210 $grouppageLocalized = MWNamespace
::getCanonicalName( NS_PROJECT
) .
213 $grouppageLocalized = $msg->text();
215 $linkTarget = Title
::newFromText( $grouppageLocalized );
218 $grouppage = $linkRenderer->makeLink(
223 $grouppage = htmlspecialchars( $groupnameLocalized );
226 $grouplink = $linkRenderer->makeKnownLink(
227 SpecialPage
::getTitleFor( 'Listusers' ),
228 $this->msg( 'listgrouprights-members' )->text(),
230 [ 'group' => $group ]
232 # Add a class when a usergroup contains no members to allow hiding these rows
234 $countUsers = SiteStats
::numberingroup( $groupname );
235 if ( $countUsers == 0 ) {
236 $classZero = ' statistics-group-zero';
238 $text .= $this->formatRow( $grouppage . ' ' . $grouplink,
239 $this->getLanguage()->formatNum( $countUsers ),
240 [ 'class' => 'statistics-group-' . Sanitizer
::escapeClass( $group ) .
248 * Conversion of external statistics into an internal representation
249 * Following a ([<header-message>][<item-message>] = number) pattern
251 * @param array $stats
254 private function getOtherStats( array $stats ) {
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 );
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'];
271 $name = $this->msg( $key )->parse();
275 $return .= $this->formatRow(
277 $this->getLanguage()->formatNum( htmlspecialchars( $number ) ),
278 [ 'class' => 'mw-statistics-hook', 'id' => 'mw-' . $key ]
282 // Create the legacy header only once
283 if ( $return === '' ) {
284 $return .= $this->formatRowHeader( 'statistics-header-hooks' );
287 // Recursively remap the legacy structure
288 $return .= $this->getOtherStats( [ 'statistics-header-hooks' =>
289 [ $header => $items ] ] );
299 * @param string $header
302 private function formatRowHeader( $header ) {
303 return Xml
::openElement( 'tr' ) .
304 Xml
::tags( 'th', [ 'colspan' => '2' ], $this->msg( $header )->parse() ) .
305 Xml
::closeElement( 'tr' );
308 protected function getGroupName() {