SpecialStatistics.php

Go to the documentation of this file.

<?php
class SpecialStatistics extends SpecialPage {

        private $views, $edits, $good, $images, $total, $users,
                        $activeUsers = 0;

        public function __construct() {
                parent::__construct( 'Statistics' );
        }

        public function execute( $par ) {
                global $wgMemc, $wgDisableCounters, $wgMiserMode;

                $this->setHeaders();
                $this->getOutput()->addModuleStyles( 'mediawiki.special' );

                $this->views = SiteStats::views();
                $this->edits = SiteStats::edits();
                $this->good = SiteStats::articles();
                $this->images = SiteStats::images();
                $this->total = SiteStats::pages();
                $this->users = SiteStats::users();
                $this->activeUsers = SiteStats::activeUsers();
                $this->hook = '';

                # Staticic - views
                $viewsStats = '';
                if( !$wgDisableCounters ) {
                        $viewsStats = $this->getViewsStats();
                }

                # Set active user count
                if( !$wgMiserMode ) {
                        $key = wfMemcKey( 'sitestats', 'activeusers-updated' );
                        // Re-calculate the count if the last tally is old...
                        if( !$wgMemc->get($key) ) {
                                $dbw = wfGetDB( DB_MASTER );
                                SiteStatsUpdate::cacheUpdate( $dbw );
                                $wgMemc->set( $key, '1', 24*3600 ); // don't update for 1 day
                        }
                }

                $text = Xml::openElement( 'table', array( 'class' => 'wikitable mw-statistics-table' ) );

                # Statistic - pages
                $text .= $this->getPageStats();

                # Statistic - edits
                $text .= $this->getEditStats();

                # Statistic - users
                $text .= $this->getUserStats();

                # Statistic - usergroups
                $text .= $this->getGroupStats();
                $text .= $viewsStats;

                # Statistic - popular pages
                if( !$wgDisableCounters && !$wgMiserMode ) {
                        $text .= $this->getMostViewedPages();
                }

                # Statistic - other
                $extraStats = array();
                if( wfRunHooks( 'SpecialStatsAddExtra', array( &$extraStats ) ) ) {
                        $text .= $this->getOtherStats( $extraStats );
                }

                $text .= Xml::closeElement( 'table' );

                # Customizable footer
                $footer = $this->msg( 'statistics-footer' );
                if ( !$footer->isBlank() ) {
                        $text .= "\n" . $footer->parse();
                }

                $this->getOutput()->addHTML( $text );
        }

        private function formatRow( $text, $number, $trExtraParams = array(), $descMsg = '', $descMsgParam = '' ) {
                if( $descMsg ) {
                        $msg = $this->msg( $descMsg, $descMsgParam );
                        if ( $msg->exists() ) {
                                $descriptionText = $this->msg( 'parentheses' )->rawParams( $msg->parse() )->escaped();
                                $text .= "<br />" . Xml::element( 'small', array( 'class' => 'mw-statistic-desc'),
                                        " $descriptionText" );
                        }
                }
                return Html::rawElement( 'tr', $trExtraParams,
                        Html::rawElement( 'td', array(), $text ) .
                        Html::rawElement( 'td', array( 'class' => 'mw-statistics-numbers' ), $number )
                );
        }

        private function getPageStats() {
                return Xml::openElement( 'tr' ) .
                        Xml::tags( 'th', array( 'colspan' => '2' ), $this->msg( 'statistics-header-pages' )->parse() ) .
                        Xml::closeElement( 'tr' ) .
                                $this->formatRow( Linker::linkKnown( SpecialPage::getTitleFor( 'Allpages' ),
                                                $this->msg( 'statistics-articles' )->parse() ),
                                                $this->getLanguage()->formatNum( $this->good ),
                                                array( 'class' => 'mw-statistics-articles' ) ) .
                                $this->formatRow( $this->msg( 'statistics-pages' )->parse(),
                                                $this->getLanguage()->formatNum( $this->total ),
                                                array( 'class' => 'mw-statistics-pages' ),
                                                'statistics-pages-desc' ) .
                                $this->formatRow( Linker::linkKnown( SpecialPage::getTitleFor( 'Listfiles' ),
                                                $this->msg( 'statistics-files' )->parse() ),
                                                $this->getLanguage()->formatNum( $this->images ),
                                                array( 'class' => 'mw-statistics-files' ) );
        }
        private function getEditStats() {
                return Xml::openElement( 'tr' ) .
                        Xml::tags( 'th', array( 'colspan' => '2' ), $this->msg( 'statistics-header-edits' )->parse() ) .
                        Xml::closeElement( 'tr' ) .
                                $this->formatRow( $this->msg( 'statistics-edits' )->parse(),
                                                $this->getLanguage()->formatNum( $this->edits ),
                                                array( 'class' => 'mw-statistics-edits' ) ) .
                                $this->formatRow( $this->msg( 'statistics-edits-average' )->parse(),
                                                $this->getLanguage()->formatNum( sprintf( '%.2f', $this->total ? $this->edits / $this->total : 0 ) ),
                                                array( 'class' => 'mw-statistics-edits-average' ) );
        }

        private function getUserStats() {
                global $wgActiveUserDays;
                return Xml::openElement( 'tr' ) .
                        Xml::tags( 'th', array( 'colspan' => '2' ), $this->msg( 'statistics-header-users' )->parse() ) .
                        Xml::closeElement( 'tr' ) .
                                $this->formatRow( $this->msg( 'statistics-users' )->parse(),
                                                $this->getLanguage()->formatNum( $this->users ),
                                                array( 'class' => 'mw-statistics-users' ) ) .
                                $this->formatRow( $this->msg( 'statistics-users-active' )->parse() . ' ' .
                                                        Linker::linkKnown(
                                                                SpecialPage::getTitleFor( 'Activeusers' ),
                                                                $this->msg( 'listgrouprights-members' )->escaped()
                                                        ),
                                                $this->getLanguage()->formatNum( $this->activeUsers ),
                                                array( 'class' => 'mw-statistics-users-active' ),
                                                'statistics-users-active-desc',
                                                $this->getLanguage()->formatNum( $wgActiveUserDays ) );
        }

        private function getGroupStats() {
                global $wgGroupPermissions, $wgImplicitGroups;
                $text = '';
                foreach( $wgGroupPermissions as $group => $permissions ) {
                        # Skip generic * and implicit groups
                        if ( in_array( $group, $wgImplicitGroups ) || $group == '*' ) {
                                continue;
                        }
                        $groupname = htmlspecialchars( $group );
                        $msg = $this->msg( 'group-' . $groupname );
                        if ( $msg->isBlank() ) {
                                $groupnameLocalized = $groupname;
                        } else {
                                $groupnameLocalized = $msg->text();
                        }
                        $msg = $this->msg( 'grouppage-' . $groupname )->inContentLanguage();
                        if ( $msg->isBlank() ) {
                                $grouppageLocalized = MWNamespace::getCanonicalName( NS_PROJECT ) . ':' . $groupname;
                        } else {
                                $grouppageLocalized = $msg->text();
                        }
                        $linkTarget = Title::newFromText( $grouppageLocalized );
                        $grouppage = Linker::link(
                                $linkTarget,
                                htmlspecialchars( $groupnameLocalized )
                        );
                        $grouplink = Linker::linkKnown(
                                SpecialPage::getTitleFor( 'Listusers' ),
                                $this->msg( 'listgrouprights-members' )->escaped(),
                                array(),
                                array( 'group' => $group )
                        );
                        # Add a class when a usergroup contains no members to allow hiding these rows
                        $classZero = '';
                        $countUsers = SiteStats::numberingroup( $groupname );
                        if( $countUsers == 0 ) {
                                $classZero = ' statistics-group-zero';
                        }
                        $text .= $this->formatRow( $grouppage . ' ' . $grouplink,
                                $this->getLanguage()->formatNum( $countUsers ),
                                array( 'class' => 'statistics-group-' . Sanitizer::escapeClass( $group ) . $classZero )  );
                }
                return $text;
        }

        private function getViewsStats() {
                return Xml::openElement( 'tr' ) .
                        Xml::tags( 'th', array( 'colspan' => '2' ), $this->msg( 'statistics-header-views' )->parse() ) .
                        Xml::closeElement( 'tr' ) .
                                $this->formatRow( $this->msg( 'statistics-views-total' )->parse(),
                                        $this->getLanguage()->formatNum( $this->views ),
                                                array ( 'class' => 'mw-statistics-views-total' ), 'statistics-views-total-desc' ) .
                                $this->formatRow( $this->msg( 'statistics-views-peredit' )->parse(),
                                        $this->getLanguage()->formatNum( sprintf( '%.2f', $this->edits ?
                                                $this->views / $this->edits : 0 ) ),
                                                array ( 'class' => 'mw-statistics-views-peredit' ) );
        }

        private function getMostViewedPages() {
                $text = '';
                $dbr = wfGetDB( DB_SLAVE );
                $res = $dbr->select(
                                'page',
                                array(
                                        'page_namespace',
                                        'page_title',
                                        'page_counter',
                                ),
                                array(
                                        'page_is_redirect' => 0,
                                        'page_counter > 0',
                                ),
                                __METHOD__,
                                array(
                                        'ORDER BY' => 'page_counter DESC',
                                        'LIMIT' => 10,
                                )
                        );
                        if( $res->numRows() > 0 ) {
                                $text .= Xml::openElement( 'tr' );
                                $text .= Xml::tags( 'th', array( 'colspan' => '2' ), $this->msg( 'statistics-mostpopular' )->parse() );
                                $text .= Xml::closeElement( 'tr' );
                                foreach ( $res as $row ) {
                                        $title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
                                        if( $title instanceof Title ) {
                                                $text .= $this->formatRow( Linker::link( $title ),
                                                                $this->getLanguage()->formatNum( $row->page_counter ) );

                                        }
                                }
                                $res->free();
                        }
                return $text;
        }

        private function getOtherStats( $stats ) {
                if ( !count( $stats ) )
                        return '';

                $return = Xml::openElement( 'tr' ) .
                        Xml::tags( 'th', array( 'colspan' => '2' ), $this->msg( 'statistics-header-hooks' )->parse() ) .
                        Xml::closeElement( 'tr' );

                foreach( $stats as $name => $number ) {
                        $name = htmlspecialchars( $name );
                        $number = htmlspecialchars( $number );

                        $return .= $this->formatRow( $name, $this->getLanguage()->formatNum( $number ), array( 'class' => 'mw-statistics-hook' ) );
                }

                return $return;
        }
}