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 ) {
39 $miserMode = $this->getConfig()->get( 'MiserMode' );
42 $this->getOutput()->addModuleStyles( 'mediawiki.special' );
44 $this->edits
= SiteStats
::edits();
45 $this->good
= SiteStats
::articles();
46 $this->images
= SiteStats
::images();
47 $this->total
= SiteStats
::pages();
48 $this->users
= SiteStats
::users();
49 $this->activeUsers
= SiteStats
::activeUsers();
52 $text = Xml
::openElement( 'table', array( 'class' => 'wikitable mw-statistics-table' ) );
55 $text .= $this->getPageStats();
58 $text .= $this->getEditStats();
61 $text .= $this->getUserStats();
63 # Statistic - usergroups
64 $text .= $this->getGroupStats();
67 $extraStats = array();
68 if ( Hooks
::run( 'SpecialStatsAddExtra', array( &$extraStats, $this->getContext() ) ) ) {
69 $text .= $this->getOtherStats( $extraStats );
72 $text .= Xml
::closeElement( 'table' );
75 $footer = $this->msg( 'statistics-footer' );
76 if ( !$footer->isBlank() ) {
77 $text .= "\n" . $footer->parse();
80 $this->getOutput()->addHTML( $text );
85 * @param string $text Description of the row
86 * @param float $number A statistical number
87 * @param array $trExtraParams Params to table row, see Html::elememt
88 * @param string $descMsg Message key
89 * @param array|string $descMsgParam Message parameters
90 * @return string Table row in HTML format
92 private function formatRow( $text, $number, $trExtraParams = array(),
93 $descMsg = '', $descMsgParam = ''
96 $msg = $this->msg( $descMsg, $descMsgParam );
97 if ( !$msg->isDisabled() ) {
98 $descriptionHtml = $this->msg( 'parentheses' )->rawParams( $msg->parse() )
100 $text .= "<br />" . Html
::rawElement( 'small', array( 'class' => 'mw-statistic-desc' ),
101 " $descriptionHtml" );
105 return Html
::rawElement( 'tr', $trExtraParams,
106 Html
::rawElement( 'td', array(), $text ) .
107 Html
::rawElement( 'td', array( 'class' => 'mw-statistics-numbers' ), $number )
112 * Each of these methods is pretty self-explanatory, get a particular
113 * row for the table of statistics
116 private function getPageStats() {
117 $pageStatsHtml = Xml
::openElement( 'tr' ) .
118 Xml
::tags( 'th', array( 'colspan' => '2' ), $this->msg( 'statistics-header-pages' )
120 Xml
::closeElement( 'tr' ) .
121 $this->formatRow( Linker
::linkKnown( SpecialPage
::getTitleFor( 'Allpages' ),
122 $this->msg( 'statistics-articles' )->parse() ),
123 $this->getLanguage()->formatNum( $this->good
),
124 array( 'class' => 'mw-statistics-articles' ),
125 'statistics-articles-desc' ) .
126 $this->formatRow( $this->msg( 'statistics-pages' )->parse(),
127 $this->getLanguage()->formatNum( $this->total
),
128 array( 'class' => 'mw-statistics-pages' ),
129 'statistics-pages-desc' );
131 // Show the image row only, when there are files or upload is possible
132 if ( $this->images
!== 0 ||
$this->getConfig()->get( 'EnableUploads' ) ) {
133 $pageStatsHtml .= $this->formatRow(
134 Linker
::linkKnown( SpecialPage
::getTitleFor( 'MediaStatistics' ),
135 $this->msg( 'statistics-files' )->parse() ),
136 $this->getLanguage()->formatNum( $this->images
),
137 array( 'class' => 'mw-statistics-files' ) );
140 return $pageStatsHtml;
143 private function getEditStats() {
144 return Xml
::openElement( 'tr' ) .
145 Xml
::tags( 'th', array( 'colspan' => '2' ),
146 $this->msg( 'statistics-header-edits' )->parse() ) .
147 Xml
::closeElement( 'tr' ) .
148 $this->formatRow( $this->msg( 'statistics-edits' )->parse(),
149 $this->getLanguage()->formatNum( $this->edits
),
150 array( 'class' => 'mw-statistics-edits' )
152 $this->formatRow( $this->msg( 'statistics-edits-average' )->parse(),
154 ->formatNum( sprintf( '%.2f', $this->total ?
$this->edits
/ $this->total
: 0 ) ),
155 array( 'class' => 'mw-statistics-edits-average' )
159 private function getUserStats() {
160 return Xml
::openElement( 'tr' ) .
161 Xml
::tags( 'th', array( 'colspan' => '2' ),
162 $this->msg( 'statistics-header-users' )->parse() ) .
163 Xml
::closeElement( 'tr' ) .
164 $this->formatRow( $this->msg( 'statistics-users' )->parse(),
165 $this->getLanguage()->formatNum( $this->users
),
166 array( 'class' => 'mw-statistics-users' )
168 $this->formatRow( $this->msg( 'statistics-users-active' )->parse() . ' ' .
170 SpecialPage
::getTitleFor( 'Activeusers' ),
171 $this->msg( 'listgrouprights-members' )->escaped()
173 $this->getLanguage()->formatNum( $this->activeUsers
),
174 array( 'class' => 'mw-statistics-users-active' ),
175 'statistics-users-active-desc',
176 $this->getLanguage()->formatNum( $this->getConfig()->get( 'ActiveUserDays' ) )
180 private function getGroupStats() {
182 foreach ( $this->getConfig()->get( 'GroupPermissions' ) as $group => $permissions ) {
183 # Skip generic * and implicit groups
184 if ( in_array( $group, $this->getConfig()->get( 'ImplicitGroups' ) ) ||
$group == '*' ) {
187 $groupname = htmlspecialchars( $group );
188 $msg = $this->msg( 'group-' . $groupname );
189 if ( $msg->isBlank() ) {
190 $groupnameLocalized = $groupname;
192 $groupnameLocalized = $msg->text();
194 $msg = $this->msg( 'grouppage-' . $groupname )->inContentLanguage();
195 if ( $msg->isBlank() ) {
196 $grouppageLocalized = MWNamespace
::getCanonicalName( NS_PROJECT
) . ':' . $groupname;
198 $grouppageLocalized = $msg->text();
200 $linkTarget = Title
::newFromText( $grouppageLocalized );
203 $grouppage = Linker
::link(
205 htmlspecialchars( $groupnameLocalized )
208 $grouppage = htmlspecialchars( $groupnameLocalized );
211 $grouplink = Linker
::linkKnown(
212 SpecialPage
::getTitleFor( 'Listusers' ),
213 $this->msg( 'listgrouprights-members' )->escaped(),
215 array( 'group' => $group )
217 # Add a class when a usergroup contains no members to allow hiding these rows
219 $countUsers = SiteStats
::numberingroup( $groupname );
220 if ( $countUsers == 0 ) {
221 $classZero = ' statistics-group-zero';
223 $text .= $this->formatRow( $grouppage . ' ' . $grouplink,
224 $this->getLanguage()->formatNum( $countUsers ),
225 array( 'class' => 'statistics-group-' . Sanitizer
::escapeClass( $group ) .
233 * Conversion of external statistics into an internal representation
234 * Following a ([<header-message>][<item-message>] = number) pattern
236 * @param array $stats
239 private function getOtherStats( array $stats ) {
242 foreach ( $stats as $header => $items ) {
243 // Identify the structure used
244 if ( is_array( $items ) ) {
246 // Ignore headers that are recursively set as legacy header
247 if ( $header !== 'statistics-header-hooks' ) {
248 $return .= $this->formatRowHeader( $header );
251 // Collect all items that belong to the same header
252 foreach ( $items as $key => $value ) {
253 if ( is_array( $value ) ) {
254 $name = $value['name'];
255 $number = $value['number'];
257 $name = $this->msg( $key )->parse();
261 $return .= $this->formatRow(
263 $this->getLanguage()->formatNum( htmlspecialchars( $number ) ),
264 array( 'class' => 'mw-statistics-hook', 'id' => 'mw-' . $key )
268 // Create the legacy header only once
269 if ( $return === '' ) {
270 $return .= $this->formatRowHeader( 'statistics-header-hooks' );
273 // Recursively remap the legacy structure
274 $return .= $this->getOtherStats( array( 'statistics-header-hooks' =>
275 array( $header => $items ) ) );
285 * @param string $header
288 private function formatRowHeader( $header ) {
289 return Xml
::openElement( 'tr' ) .
290 Xml
::tags( 'th', array( 'colspan' => '2' ), $this->msg( $header )->parse() ) .
291 Xml
::closeElement( 'tr' );
294 protected function getGroupName() {