Split up TablePager css class, introduce .mw-datatable
[lhc/web/wiklou.git] / includes / specials / SpecialAllmessages.php
index ec6a09e..4a8db66 100644 (file)
@@ -1,5 +1,6 @@
 <?php
 /**
+ * Implements Special:Allmessages
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup SpecialPage
  */
 
 /**
  * Use this special page to get a list of the MediaWiki system messages.
+ *
  * @file
  * @ingroup SpecialPage
  */
 class SpecialAllmessages extends SpecialPage {
 
+       /**
+        * @var AllmessagesTablePager
+        */
+       protected $table;
+
        /**
         * Constructor
         */
@@ -37,37 +47,102 @@ class SpecialAllmessages extends SpecialPage {
         * @param $par Mixed: parameter passed to the page or null
         */
        public function execute( $par ) {
-               global $wgOut, $wgRequest;
+               $request = $this->getRequest();
+               $out = $this->getOutput();
 
                $this->setHeaders();
 
                global $wgUseDatabaseMessages;
                if( !$wgUseDatabaseMessages ) {
-                       $wgOut->addWikiMsg( 'allmessagesnotsupportedDB' );
+                       $out->addWikiMsg( 'allmessagesnotsupportedDB' );
                        return;
                } else {
                        $this->outputHeader( 'allmessagestext' );
                }
 
-               $this->filter = $wgRequest->getVal( 'filter', 'all' );
-               $this->prefix = $wgRequest->getVal( 'prefix', '' );
+               $out->addModuleStyles( 'mediawiki.special' );
+
+               $this->filter = $request->getVal( 'filter', 'all' );
+               $this->prefix = $request->getVal( 'prefix', '' );
 
                $this->table = new AllmessagesTablePager(
                        $this,
-                       $conds = array(),
-                       wfGetLangObj( $wgRequest->getVal( 'lang', $par ) )
+                       array(),
+                       wfGetLangObj( $request->getVal( 'lang', $par ) )
                );
 
-               $this->langCode = $this->table->lang->getCode();
+               $this->langcode = $this->table->lang->getCode();
 
-               $wgOut->addHTML( $this->buildForm() .
+               $out->addHTML( $this->table->buildForm() .
                        $this->table->getNavigationBar() .
-                       $this->table->getLimitForm() .
                        $this->table->getBody() .
                        $this->table->getNavigationBar() );
 
        }
 
+}
+
+/**
+ * Use TablePager for prettified output. We have to pretend that we're
+ * getting data from a table when in fact not all of it comes from the database.
+ */
+class AllmessagesTablePager extends TablePager {
+
+       protected $filter, $prefix, $langcode, $displayPrefix;
+
+       public $mLimitsShown;
+
+       /**
+        * @var Language
+        */
+       public $lang;
+
+       /**
+        * @var null|bool
+        */
+       public $custom;
+
+       function __construct( $page, $conds, $langObj = null ) {
+               parent::__construct();
+               $this->mIndexField = 'am_title';
+               $this->mPage = $page;
+               $this->mConds = $conds;
+               $this->mDefaultDirection = true; // always sort ascending
+               $this->mLimitsShown = array( 20, 50, 100, 250, 500, 5000 );
+
+               global $wgLang, $wgContLang, $wgRequest;
+
+               $this->talk = htmlspecialchars( wfMsg( 'talkpagelinktext' ) );
+
+               $this->lang = ( $langObj ? $langObj : $wgContLang );
+               $this->langcode = $this->lang->getCode();
+               $this->foreign  = $this->langcode != $wgContLang->getCode();
+
+               if( $wgRequest->getVal( 'filter', 'all' ) === 'all' ){
+                       $this->custom = null; // So won't match in either case
+               } else {
+                       $this->custom = ($wgRequest->getVal( 'filter' ) == 'unmodified');
+               }
+
+               $prefix = $wgLang->ucfirst( $wgRequest->getVal( 'prefix', '' ) );
+               $prefix = $prefix != '' ? Title::makeTitleSafe( NS_MEDIAWIKI, $wgRequest->getVal( 'prefix', null ) ) : null;
+               if( $prefix !== null ){
+                       $this->displayPrefix = $prefix->getDBkey();
+                       $this->prefix = '/^' . preg_quote( $this->displayPrefix ) . '/i';
+               } else {
+                       $this->displayPrefix = false;
+                       $this->prefix = false;
+               }
+
+               // The suffix that may be needed for message names if we're in a
+               // different language (eg [[MediaWiki:Foo/fr]]: $suffix = '/fr'
+               if( $this->foreign ) {
+                       $this->suffix = '/' . $this->langcode;
+               } else {
+                       $this->suffix = '';
+               }
+       }
+
        function buildForm() {
                global $wgScript;
 
@@ -76,14 +151,14 @@ class SpecialAllmessages extends SpecialPage {
 
                $out  = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript, 'id' => 'mw-allmessages-form' ) ) .
                        Xml::fieldset( wfMsg( 'allmessages-filter-legend' ) ) .
-                       Xml::hidden( 'title', $this->getTitle() ) .
+                       Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) .
                        Xml::openElement( 'table', array( 'class' => 'mw-allmessages-table' ) ) . "\n" .
                        '<tr>
                                <td class="mw-label">' .
                                        Xml::label( wfMsg( 'allmessages-prefix' ), 'mw-allmessages-form-prefix' ) .
                                "</td>\n
                                <td class=\"mw-input\">" .
-                                       Xml::input( 'prefix', 20, str_replace( '_', ' ', $this->prefix ), array( 'id' => 'mw-allmessages-form-prefix' ) ) .
+                                       Xml::input( 'prefix', 20, str_replace( '_', ' ', $this->displayPrefix ), array( 'id' => 'mw-allmessages-form-prefix' ) ) .
                                "</td>\n
                        </tr>
                        <tr>\n
@@ -95,19 +170,19 @@ class SpecialAllmessages extends SpecialPage {
                                                'filter',
                                                'unmodified',
                                                'mw-allmessages-form-filter-unmodified',
-                                               ( $this->filter == 'unmodified' ? true : false )
+                                               ( $this->filter == 'unmodified' )
                                        ) .
                                        Xml::radioLabel( wfMsg( 'allmessages-filter-all' ),
                                                'filter',
                                                'all',
                                                'mw-allmessages-form-filter-all',
-                                               ( $this->filter == 'all' ? true : false )
+                                               ( $this->filter == 'all' )
                                        ) .
                                        Xml::radioLabel( wfMsg( 'allmessages-filter-modified' ),
                                                'filter',
                                                'modified',
                                                'mw-allmessages-form-filter-modified',
-                                       ( $this->filter == 'modified' ? true : false )
+                                       ( $this->filter == 'modified' )
                                ) .
                                "</td>\n
                        </tr>
@@ -119,75 +194,33 @@ class SpecialAllmessages extends SpecialPage {
                                        Xml::openElement( 'select', array( 'id' => 'mw-allmessages-form-lang', 'name' => 'lang' ) );
 
                foreach( $languages as $lang => $name ) {
-                       $selected = $lang == $this->langCode ? true : false;
+                       $selected = $lang == $this->langcode;
                        $out .= Xml::option( $lang . ' - ' . $name, $lang, $selected ) . "\n";
                }
                $out .= Xml::closeElement( 'select' ) .
                                "</td>\n
-                       </tr>
-                       <tr>\n
+                       </tr>" .
+
+                       '<tr>
+                               <td class="mw-label">' .
+                                       Xml::label( wfMsg( 'table_pager_limit_label'), 'mw-table_pager_limit_label' ) .
+                               '</td>
+                               <td class="mw-input">' .
+                                       $this->getLimitSelect() .
+                               '</td>
+                       <tr>
                                <td></td>
-                               <td>" .
+                               <td>' .
                                        Xml::submitButton( wfMsg( 'allmessages-filter-submit' ) ) .
                                "</td>\n
                        </tr>" .
+
                        Xml::closeElement( 'table' ) .
-                       $this->table->getHiddenFields( array( 'title', 'prefix', 'filter', 'lang' ) ) .
+                       $this->getHiddenFields( array( 'title', 'prefix', 'filter', 'lang', 'limit' ) ) .
                        Xml::closeElement( 'fieldset' ) .
                        Xml::closeElement( 'form' );
                return $out;
        }
-}
-
-/* use TablePager for prettified output. We have to pretend that we're
- * getting data from a table when in fact not all of it comes from the database.
- */
-class AllmessagesTablePager extends TablePager {
-
-       public $mLimitsShown;
-
-       function __construct( $page, $conds, $langObj = null ) {
-               parent::__construct();
-               $this->mIndexField = 'am_title';
-               $this->mPage = $page;
-               $this->mConds = $conds;
-               $this->mDefaultDirection = true; // always sort ascending
-               // We want to have an option for people to view *all* the messages, 
-               // so they can use Ctrl+F to search them.  5000 is the maximum that 
-               // will get through WebRequest::getLimitOffset().
-               $this->mLimitsShown = array( 20, 50, 100, 250, 500, 5000 );
-
-               global $wgLang, $wgContLang, $wgRequest;
-
-               $this->talk = htmlspecialchars( wfMsg( 'talkpagelinktext' ) );
-
-               $this->lang = ( $langObj ? $langObj : $wgContLang );
-               $this->langcode = $this->lang->getCode();
-               $this->foreign  = $this->langcode != $wgContLang->getCode();
-
-               if( $wgRequest->getVal( 'filter', 'all' ) === 'all' ){
-                       $this->custom = null; // So won't match in either case
-               } else {
-                       $this->custom = ($wgRequest->getVal( 'filter' ) == 'unmodified');
-               }
-
-               $prefix = $wgLang->ucfirst( $wgRequest->getVal( 'prefix', '' ) );
-               $prefix = $prefix != '' ? Title::makeTitleSafe( NS_MEDIAWIKI, $wgRequest->getVal( 'prefix', null ) ) : null;
-               if( $prefix !== null ){
-                       $this->prefix = '/^' . preg_quote( $prefix->getDBkey() ) . '/i';
-               } else {
-                       $this->prefix = false;
-               }
-               $this->getSkin();
-
-               // The suffix that may be needed for message names if we're in a
-               // different language (eg [[MediaWiki:Foo/fr]]: $suffix = '/fr'
-               if( $this->foreign ) {
-                       $this->suffix = '/' . $this->langcode;
-               } else {
-                       $this->suffix = '';
-               }
-       }
 
        function getAllMessages( $descending ) {
                wfProfileIn( __METHOD__ );
@@ -200,18 +233,22 @@ class AllmessagesTablePager extends TablePager {
 
                // Normalise message names so they look like page titles
                $messageNames = array_map( array( $this->lang, 'ucfirst' ), $messageNames );
-               wfProfileIn( __METHOD__ );
 
+               wfProfileOut( __METHOD__ );
                return $messageNames;
        }
 
        /**
-        * Determine which of the MediaWiki and MediaWiki_talk namespace pages exist. 
-        * Returns array( 'pages' => ..., 'talks' => ... ), where the subarrays have 
-        * an entry for each existing page, with the key being the message name and 
+        * Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.
+        * Returns array( 'pages' => ..., 'talks' => ... ), where the subarrays have
+        * an entry for each existing page, with the key being the message name and
         * value arbitrary.
+        *
+        * @param array $messageNames
+        * @param string $langcode What language code
+        * @param bool $foreign Whether the $langcode is not the content language
         */
-       function getCustomisedStatuses( $messageNames ) {
+       public static function getCustomisedStatuses( $messageNames, $langcode = 'en', $foreign = false ) {
                wfProfileIn( __METHOD__ . '-db' );
 
                $dbr = wfGetDB( DB_SLAVE );
@@ -224,38 +261,37 @@ class AllmessagesTablePager extends TablePager {
                $xNames = array_flip( $messageNames );
 
                $pageFlags = $talkFlags = array();
-               
-               while( $s = $dbr->fetchObject( $res ) ) {
+
+               foreach ( $res as $s ) {
                        if( $s->page_namespace == NS_MEDIAWIKI ) {
-                               if( $this->foreign ) {
+                               if( $foreign ) {
                                        $title = explode( '/', $s->page_title );
-                                       if( count( $title ) === 2 && $this->langcode == $title[1] 
-                                               && isset( $xNames[$title[0]] ) )
-                                       {
+                                       if( count( $title ) === 2 && $langcode == $title[1]
+                                               && isset( $xNames[$title[0]] ) ) {
                                                $pageFlags["{$title[0]}"] = true;
                                        }
                                } elseif( isset( $xNames[$s->page_title] ) ) {
                                        $pageFlags[$s->page_title] = true;
                                }
-                       } else if( $s->page_namespace == NS_MEDIAWIKI_TALK ){
+                       } elseif( $s->page_namespace == NS_MEDIAWIKI_TALK ){
                                $talkFlags[$s->page_title] = true;
                        }
                }
-               $dbr->freeResult( $res );
 
                wfProfileOut( __METHOD__ . '-db' );
 
                return array( 'pages' => $pageFlags, 'talks' => $talkFlags );
        }
 
-       /* This function normally does a database query to get the results; we need
+       /**
+        *  This function normally does a database query to get the results; we need
         * to make a pretend result using a FakeResultWrapper.
         */
        function reallyDoQuery( $offset, $limit, $descending ) {
                $result = new FakeResultWrapper( array() );
 
                $messageNames = $this->getAllMessages( $descending );
-               $statuses = $this->getCustomisedStatuses( $messageNames );
+               $statuses = self::getCustomisedStatuses( $messageNames, $this->langcode, $this->foreign );
 
                $count = 0;
                foreach( $messageNames as $key ) {
@@ -263,23 +299,27 @@ class AllmessagesTablePager extends TablePager {
                        if( $customised !== $this->custom &&
                                ( $descending && ( $key < $offset || !$offset ) || !$descending && $key > $offset ) &&
                                ( ( $this->prefix && preg_match( $this->prefix, $key ) ) || $this->prefix === false )
-                       ){
+                       ) {
+                               $actual = wfMessage( $key )->inLanguage( $this->langcode )->plain();
+                               $default = wfMessage( $key )->inLanguage( $this->langcode )->useDatabase( false )->plain();
                                $result->result[] = array(
                                        'am_title'      => $key,
-                                       'am_actual'     => wfMsgGetKey( $key, /*useDB*/true, $this->langcode, false ),
-                                       'am_default'    => wfMsgGetKey( $key, /*useDB*/false, $this->langcode, false ),
+                                       'am_actual'     => $actual,
+                                       'am_default'    => $default,
                                        'am_customised' => $customised,
                                        'am_talk_exists' => isset( $statuses['talks'][$key] )
                                );
                                $count++;
                        }
-                       if( $count == $limit ) break;
+                       if( $count == $limit ) {
+                               break;
+                       }
                }
                return $result;
        }
 
        function getStartBody() {
-               return Xml::openElement( 'table', array( 'class' => 'TablePager', 'id' => 'mw-allmessagestable' ) ) . "\n" .
+               return Xml::openElement( 'table', array( 'class' => 'mw-datatable TablePager', 'id' => 'mw-allmessagestable' ) ) . "\n" .
                        "<thead><tr>
                                <th rowspan=\"2\">" .
                                        wfMsg( 'allmessagesname' ) . "
@@ -305,9 +345,9 @@ class AllmessagesTablePager extends TablePager {
                                $talk  = Title::makeTitle( NS_MEDIAWIKI_TALK, $value . $this->suffix );
 
                                if( $this->mCurrentRow->am_customised ){
-                                       $title = $this->mSkin->linkKnown( $title, $wgLang->lcfirst( $value ) );
+                                       $title = Linker::linkKnown( $title, $wgLang->lcfirst( $value ) );
                                } else {
-                                       $title = $this->mSkin->link(
+                                       $title = Linker::link(
                                                $title,
                                                $wgLang->lcfirst( $value ),
                                                array(),
@@ -316,9 +356,9 @@ class AllmessagesTablePager extends TablePager {
                                        );
                                }
                                if ( $this->mCurrentRow->am_talk_exists ) {
-                                       $talk = $this->mSkin->linkKnown( $talk , $this->talk );
+                                       $talk = Linker::linkKnown( $talk , $this->talk );
                                } else {
-                                       $talk = $this->mSkin->link(
+                                       $talk = Linker::link(
                                                $talk,
                                                $this->talk,
                                                array(),
@@ -329,7 +369,6 @@ class AllmessagesTablePager extends TablePager {
                                return $title . ' (' . $talk . ')';
 
                        case 'am_default' :
-                               return Sanitizer::escapeHtmlAllowEntities( $value, ENT_QUOTES );
                        case 'am_actual' :
                                return Sanitizer::escapeHtmlAllowEntities( $value, ENT_QUOTES );
                }
@@ -366,7 +405,9 @@ class AllmessagesTablePager extends TablePager {
        }
 
        function getCellAttrs( $field, $value ){
-               if( $this->mCurrentRow->am_customised && $field == 'am_title' ){
+               if( $field != 'am_title' ) {
+                       return array( 'lang' => $this->langcode, 'dir' => $this->lang->getDir() );
+               } elseif( $this->mCurrentRow->am_customised && $field == 'am_title' ) {
                        return array( 'rowspan' => '2', 'class' => $field );
                } else {
                        return array( 'class' => $field );
@@ -380,15 +421,19 @@ class AllmessagesTablePager extends TablePager {
                        'am_default' => wfMsg( 'allmessagesdefault' )
                );
        }
+
        function getTitle() {
                return SpecialPage::getTitleFor( 'Allmessages', false );
        }
+
        function isFieldSortable( $x ){
                return false;
        }
+
        function getDefaultSort(){
                return '';
        }
+
        function getQueryInfo(){
                return '';
        }