Standardised file description headers; first path
[lhc/web/wiklou.git] / includes / specials / SpecialAllmessages.php
index fbf9e83..afbeaa2 100644 (file)
@@ -1,6 +1,29 @@
 <?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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * 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
  */
@@ -14,9 +37,11 @@ class SpecialAllmessages extends SpecialPage {
        }
 
        /**
-        * Execute
+        * Show the special page
+        *
+        * @param $par Mixed: parameter passed to the page or null
         */
-       function execute( $par ) {
+       public function execute( $par ) {
                global $wgOut, $wgRequest;
 
                $this->setHeaders();
@@ -32,9 +57,11 @@ class SpecialAllmessages extends SpecialPage {
                $this->filter = $wgRequest->getVal( 'filter', 'all' );
                $this->prefix = $wgRequest->getVal( 'prefix', '' );
 
-               $this->table = new AllmessagesTablePager( $this,
-                                                                                       $conds=array(),
-                                                                                       wfGetLangObj( $wgRequest->getVal( 'lang', false ) ) );
+               $this->table = new AllmessagesTablePager(
+                       $this,
+                       $conds = array(),
+                       wfGetLangObj( $wgRequest->getVal( 'lang', $par ) )
+               );
 
                $this->langCode = $this->table->lang->getCode();
 
@@ -49,51 +76,70 @@ class SpecialAllmessages extends SpecialPage {
        function buildForm() {
                global $wgScript;
 
-               $action = htmlspecialchars( $wgScript );
                $languages = Language::getLanguageNames( false );
                ksort( $languages );
 
-               $out  = "<form method=\"get\" action=\"$action\"><fieldset>\n" .
+               $out  = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript, 'id' => 'mw-allmessages-form' ) ) .
+                       Xml::fieldset( wfMsg( 'allmessages-filter-legend' ) ) .
                        Xml::hidden( 'title', $this->getTitle() ) .
-                                       Xml::element( 'legend', null, wfMsg( 'allmessages' ) ) . "<table><tr>\n" .
-                               "<td class=\"mw-label\">" .
-                                       Xml::label( wfMsg('allmessages-prefix'), 'am-form-prefix' ) .
-                               "</td>\n<td class=\"mw-input\">" .
-                                       Xml::input( 'prefix', 20, str_replace('_',' ',$this->prefix), array( 'id' => 'am-form-prefix' ) ) .
-                               "</select>" .
-                               "</td>\n</tr><tr>\n<td class='mw-label'>" .
-                                       Xml::label( wfMsg('allmessages-filter'), 'am-form-filter' ) .
-                               "</td>\n<td class='mw-input'>" .
-                                       Xml::radioLabel( wfMsg('allmessages-filter-unmodified'),
+                       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' ) ) .
+                               "</td>\n
+                       </tr>
+                       <tr>\n
+                               <td class='mw-label'>" .
+                                       wfMsg( 'allmessages-filter' ) .
+                               "</td>\n
+                               <td class='mw-input'>" .
+                                       Xml::radioLabel( wfMsg( 'allmessages-filter-unmodified' ),
                                                'filter',
                                                'unmodified',
-                                               'am-form-filter-unmodified',
+                                               'mw-allmessages-form-filter-unmodified',
                                                ( $this->filter == 'unmodified' ? true : false )
                                        ) .
-                                       Xml::radioLabel( wfMsg('allmessages-filter-all'),
+                                       Xml::radioLabel( wfMsg( 'allmessages-filter-all' ),
                                                'filter',
                                                'all',
-                                               'am-form-filter-all',
+                                               'mw-allmessages-form-filter-all',
                                                ( $this->filter == 'all' ? true : false )
                                        ) .
-                                       Xml::radioLabel( wfMsg('allmessages-filter-modified'),
+                                       Xml::radioLabel( wfMsg( 'allmessages-filter-modified' ),
                                                'filter',
                                                'modified',
-                                               'am-form-filter-modified',
+                                               'mw-allmessages-form-filter-modified',
                                        ( $this->filter == 'modified' ? true : false )
                                ) .
-                               "</td>\n</tr><tr>\n<td class=\"mw-label\">" .
-                                       Xml::label( wfMsg('yourlanguage'), 'am-form-lang' ) .
-                               "</td>\n<td class=\"mw-input\">" .
-                                       Xml::openElement( 'select', array( 'id' => 'am-form-lang', 'name' => 'lang' ) );
+                               "</td>\n
+                       </tr>
+                       <tr>\n
+                               <td class=\"mw-label\">" .
+                                       Xml::label( wfMsg( 'allmessages-language' ), 'mw-allmessages-form-lang' ) .
+                               "</td>\n
+                               <td class=\"mw-input\">" .
+                                       Xml::openElement( 'select', array( 'id' => 'mw-allmessages-form-lang', 'name' => 'lang' ) );
+
                foreach( $languages as $lang => $name ) {
-                       $selected = $lang == $this->langCode ? 'selected="selected"' : '';
-                       $out .= "<option value=\"$lang\" $selected>$name</option>\n";
+                       $selected = $lang == $this->langCode ? true : false;
+                       $out .= Xml::option( $lang . ' - ' . $name, $lang, $selected ) . "\n";
                }
-               $out .= "</td>\n</tr><tr>\n<td></td><td>" . Xml::submitButton( wfMsg('allpagessubmit') ) .
-                               "</table>" .
-                                       $this->table->getHiddenFields( array( 'title', 'prefix', 'filter', 'lang' ) ) .
-                               "</fieldset></form>";
+               $out .= Xml::closeElement( 'select' ) .
+                               "</td>\n
+                       </tr>
+                       <tr>\n
+                               <td></td>
+                               <td>" .
+                                       Xml::submitButton( wfMsg( 'allmessages-filter-submit' ) ) .
+                               "</td>\n
+                       </tr>" .
+                       Xml::closeElement( 'table' ) .
+                       $this->table->getHiddenFields( array( 'title', 'prefix', 'filter', 'lang' ) ) .
+                       Xml::closeElement( 'fieldset' ) .
+                       Xml::closeElement( 'form' );
                return $out;
        }
 }
@@ -103,41 +149,44 @@ class SpecialAllmessages extends SpecialPage {
  */
 class AllmessagesTablePager extends TablePager {
 
-       var $messages  = NULL;
-       var $talkPages = NULL;
+       public $mLimitsShown;
 
-       function __construct( $page, $conds, $langObj = NULL ) {
+       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->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 = $wgLang->lc( htmlspecialchars( wfMsg( 'talkpagelinktext' ) ) );
+               $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
+                       $this->custom = null; // So won't match in either case
                } else {
-                       $this->custom = $wgRequest->getVal( 'filter' ) == 'unmodified' ? 1 : 0;
+                       $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 ){
+               $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'
+               // 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 {
@@ -145,115 +194,112 @@ class AllmessagesTablePager extends TablePager {
                }
        }
 
-       function getAllMessages( $desc ){
-
-               wfProfileIn( __METHOD__ . '-cache' );
-
-               # Make sure all extension messages are available
-               global $wgMessageCache;
-               $wgMessageCache->loadAllMessages( 'en' );
-               $sortedArray = Language::getMessagesFor( 'en' );
-               if( $desc ){
-                       krsort( $sortedArray );
+       function getAllMessages( $descending ) {
+               wfProfileIn( __METHOD__ );
+               $messageNames = Language::getLocalisationCache()->getSubitemList( 'en', 'messages' );
+               if( $descending ){
+                       rsort( $messageNames );
                } else {
-                       ksort( $sortedArray );
+                       asort( $messageNames );
                }
 
-               $this->messages = array();
-               foreach( $sortedArray as $key => $value ) {
-                       // All messages start with lowercase, but wikis might have both
-                       // upper and lowercase MediaWiki: pages if $wgCapitalLinks=false.
-                       $ukey = $this->lang->ucfirst( $key );
+               // Normalise message names so they look like page titles
+               $messageNames = array_map( array( $this->lang, 'ucfirst' ), $messageNames );
+               wfProfileIn( __METHOD__ );
 
-                       // The value without any overrides from the MediaWiki: namespace
-                       $this->messages[$ukey]['default'] = wfMsgGetKey( $key, /*useDB*/false, $this->langcode, false );
-
-                       // The message that's actually used by the site
-                       $this->messages[$ukey]['actual'] = wfMsgGetKey( $key, /*useDB*/true, $this->langcode, false );
-
-                       $this->messages[$ukey]['customised'] = 0; //for now
-
-                       $sortedArray[$key] = NULL; // trade bytes from $sortedArray to this
-               }
-
-               wfProfileOut( __METHOD__ . '-cache' );
-
-               return true;
+               return $messageNames;
        }
 
-       # We only need a list of which messages have *been* customised;
-       # their content is already in the message cache.
-       function markCustomisedMessages(){
-               $this->talkPages = array();
-
-               wfProfileIn( __METHOD__ . "-db" );
+       /**
+        * 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.
+        */
+       function getCustomisedStatuses( $messageNames ) {
+               wfProfileIn( __METHOD__ . '-db' );
 
                $dbr = wfGetDB( DB_SLAVE );
                $res = $dbr->select( 'page',
                        array( 'page_namespace', 'page_title' ),
-                       array( 'page_namespace' => array(NS_MEDIAWIKI,NS_MEDIAWIKI_TALK) ),
+                       array( 'page_namespace' => array( NS_MEDIAWIKI, NS_MEDIAWIKI_TALK ) ),
                        __METHOD__,
                        array( 'USE INDEX' => 'name_title' )
                );
+               $xNames = array_flip( $messageNames );
 
+               $pageFlags = $talkFlags = array();
+               
                while( $s = $dbr->fetchObject( $res ) ) {
-                       if( $s->page_namespace == NS_MEDIAWIKI ){
-                               if( $this->foreign ){
+                       if( $s->page_namespace == NS_MEDIAWIKI ) {
+                               if( $this->foreign ) {
                                        $title = explode( '/', $s->page_title );
-                                       if( count($title) === 2 && $this->langcode == $title[1] && array_key_exists( $title[0], $this->messages ) ){
-                                               $this->messages["{$title[0]}"]['customised'] = 1;
+                                       if( count( $title ) === 2 && $this->langcode == $title[1] 
+                                               && isset( $xNames[$title[0]] ) )
+                                       {
+                                               $pageFlags["{$title[0]}"] = true;
                                        }
-                               } else if( array_key_exists( $s->page_title , $this->messages ) ){
-                                       $this->messages[$s->page_title]['customised'] = 1;
+                               } elseif( isset( $xNames[$s->page_title] ) ) {
+                                       $pageFlags[$s->page_title] = true;
                                }
                        } else if( $s->page_namespace == NS_MEDIAWIKI_TALK ){
-                               $this->talkPages[$s->page_title] = 1;
+                               $talkFlags[$s->page_title] = true;
                        }
                }
-               $dbr->freeResult( $res );
 
-               wfProfileOut( __METHOD__ . "-db" );
+               wfProfileOut( __METHOD__ . '-db' );
 
-               return true;
+               return array( 'pages' => $pageFlags, 'talks' => $talkFlags );
        }
 
        /* 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 ){
-               $mResult = new FakeResultWrapper( array() );
+       function reallyDoQuery( $offset, $limit, $descending ) {
+               $result = new FakeResultWrapper( array() );
 
-               if( !$this->messages ) $this->getAllMessages( $descending );
-               if( $this->talkPages === NULL ) $this->markCustomisedMessages();
+               $messageNames = $this->getAllMessages( $descending );
+               $statuses = $this->getCustomisedStatuses( $messageNames );
 
                $count = 0;
-               foreach( $this->messages as $key => $value ){
-                       if( $value['customised'] !== $this->custom &&
+               foreach( $messageNames as $key ) {
+                       $customised = isset( $statuses['pages'][$key] );
+                       if( $customised !== $this->custom &&
                                ( $descending && ( $key < $offset || !$offset ) || !$descending && $key > $offset ) &&
-                               (( $this->prefix && preg_match( $this->prefix, $key ) ) || $this->prefix === false )
+                               ( ( $this->prefix && preg_match( $this->prefix, $key ) ) || $this->prefix === false )
                        ){
-                               $mResult->result[] = array(
+                               $result->result[] = array(
                                        'am_title'      => $key,
-                                       'am_actual'     => $value['actual'],
-                                       'am_default'    => $value['default'],
-                                       'am_customised' => $value['customised'],
+                                       'am_actual'     => wfMsgGetKey( $key, /*useDB*/true, $this->langcode, false ),
+                                       'am_default'    => wfMsgGetKey( $key, /*useDB*/false, $this->langcode, false ),
+                                       'am_customised' => $customised,
+                                       'am_talk_exists' => isset( $statuses['talks'][$key] )
                                );
-                               unset( $this->messages[$key] ); // save a few bytes
                                $count++;
                        }
                        if( $count == $limit ) break;
                }
-               unset( $this->messages ); //no longer needed, free up some memory
-               return $mResult;
+               return $result;
        }
 
        function getStartBody() {
-               return "<table border=\"1\" class=\"TablePager\" style=\"width:100%;\" id=\"allmessagestable\"><thead>\n<tr>" .
-                       "<th rowspan=\"2\">" . wfMsg('allmessagesname') . "</th><th>" . wfMsg('allmessagesdefault') .
-                       "</tr>\n<tr><th>" . wfMsg('allmessagescurrent') . "</th></tr>\n";
+               return Xml::openElement( 'table', array( 'class' => 'TablePager', 'id' => 'mw-allmessagestable' ) ) . "\n" .
+                       "<thead><tr>
+                               <th rowspan=\"2\">" .
+                                       wfMsg( 'allmessagesname' ) . "
+                               </th>
+                               <th>" .
+                                       wfMsg( 'allmessagesdefault' ) .
+                               "</th>
+                       </tr>\n
+                       <tr>
+                               <th>" .
+                                       wfMsg( 'allmessagescurrent' ) .
+                               "</th>
+                       </tr></thead><tbody>\n";
        }
 
-       function formatValue( $field , $value ){
+       function formatValue( $field, $value ){
                global $wgLang;
                switch( $field ){
 
@@ -265,20 +311,24 @@ class AllmessagesTablePager extends TablePager {
                                if( $this->mCurrentRow->am_customised ){
                                        $title = $this->mSkin->linkKnown( $title, $wgLang->lcfirst( $value ) );
                                } else {
-                                       $title = $this->mSkin->link( $title,
-                                                                                               $wgLang->lcfirst( $value ),
-                                                                                               array(),
-                                                                                               array(),
-                                                                                               array( 'broken' ) );
+                                       $title = $this->mSkin->link(
+                                               $title,
+                                               $wgLang->lcfirst( $value ),
+                                               array(),
+                                               array(),
+                                               array( 'broken' )
+                                       );
                                }
-                               if( array_key_exists( $talk->getDBkey() , $this->talkPages ) ) {
+                               if ( $this->mCurrentRow->am_talk_exists ) {
                                        $talk = $this->mSkin->linkKnown( $talk , $this->talk );
                                } else {
-                                       $talk = $this->mSkin->link( $talk,
-                                                                                               $this->talk,
-                                                                                               array(),
-                                                                                               array(),
-                                                                                               array( 'broken' ) );
+                                       $talk = $this->mSkin->link(
+                                               $talk,
+                                               $this->talk,
+                                               array(),
+                                               array(),
+                                               array( 'broken' )
+                                       );
                                }
                                return $title . ' (' . $talk . ')';
 
@@ -291,15 +341,15 @@ class AllmessagesTablePager extends TablePager {
        }
 
        function formatRow( $row ){
-               //Do all the normal stuff
+               // Do all the normal stuff
                $s = parent::formatRow( $row );
 
-               //But if there's a customised message, add that too.
+               // But if there's a customised message, add that too.
                if( $row->am_customised ){
                        $s .= Xml::openElement( 'tr', $this->getRowAttrs( $row, true ) );
                        $formatted = strval( $this->formatValue( 'am_actual', $row->am_actual ) );
                        if ( $formatted == '' ) {
-                               $formatted = '&nbsp;';
+                               $formatted = '&#160;';
                        }
                        $s .= Xml::tags( 'td', $this->getCellAttrs( 'am_actual', $row->am_actual ), $formatted )
                                . "</tr>\n";
@@ -307,11 +357,11 @@ class AllmessagesTablePager extends TablePager {
                return $s;
        }
 
-       function getRowAttrs( $row, $isSecond=false ){
+       function getRowAttrs( $row, $isSecond = false ){
                $arr = array();
                global $wgLang;
                if( $row->am_customised ){
-                       $arr['class'] =  'allmessages-customised';
+                       $arr['class'] = 'allmessages-customised';
                }
                if( !$isSecond ){
                        $arr['id'] = Sanitizer::escapeId( 'msg_' . $wgLang->lcfirst( $row->am_title ) );
@@ -329,8 +379,10 @@ class AllmessagesTablePager extends TablePager {
 
        // This is not actually used, as getStartBody is overridden above
        function getFieldNames() {
-               return array( 'am_title' => wfMsg('allmessagesname'),
-                       'am_default' => wfMsg('allmessagesdefault') );
+               return array(
+                       'am_title' => wfMsg( 'allmessagesname' ),
+                       'am_default' => wfMsg( 'allmessagesdefault' )
+               );
        }
        function getTitle() {
                return SpecialPage::getTitleFor( 'Allmessages', false );
@@ -345,43 +397,4 @@ class AllmessagesTablePager extends TablePager {
                return '';
        }
 }
-/* Overloads the relevant methods of the real ResultsWrapper so it
- * doesn't go anywhere near an actual database.
- */
-class FakeResultWrapper extends ResultWrapper {
 
-       var $result     = array();
-       var $db         = NULL;         //And it's going to stay that way :D
-       var $pos        = 0;
-       var $currentRow = NULL;
-
-       function __construct( $array ){
-               $this->result = $array;
-       }
-
-       function numRows() {
-               return count( $this->result );
-       }
-
-       function fetchRow() {
-               $this->currentRow = $this->result[$this->pos++];
-               return $this->currentRow;
-       }
-
-       function seek( $row ) {
-               $this->pos = $row;
-       }
-
-       function free() {}
-
-       // Callers want to be able to access fields with $this->fieldName
-       function fetchObject(){
-               $this->currentRow = $this->result[$this->pos++];
-               return (object)$this->currentRow;
-       }
-
-       function rewind() {
-               $this->pos = 0;
-               $this->currentRow = NULL;
-       }
-}