phpcs: More require/include is not a function
[lhc/web/wiklou.git] / maintenance / deleteEqualMessages.php
index 38e6956..1e36363 100644 (file)
@@ -19,7 +19,7 @@
  * @ingroup Maintenance
  */
 
-require_once( __DIR__ . '/Maintenance.php' );
+require_once __DIR__ . '/Maintenance.php';
 
 /**
  * Maintenance script that deletes all pages in the MediaWiki namespace
@@ -31,76 +31,117 @@ class DeleteEqualMessages extends Maintenance {
        public function __construct() {
                parent::__construct();
                $this->mDescription = "Deletes all pages in the MediaWiki namespace that are equal to the default message";
-               $this->addOption( 'delete', 'Actually delete the pages' );
-               $this->addOption( 'delete-talk', 'Don\'t leave orphaned talk pages behind' );
-               $this->addOption( 'lang-code', 'Check for subpages of this lang-code (default: root page against content language)', false, true );
+               $this->addOption( 'delete', 'Actually delete the pages (default: dry run)' );
+               $this->addOption( 'delete-talk', 'Don\'t leave orphaned talk pages behind during deletion' );
+               $this->addOption( 'lang-code', 'Check for subpages of this language code (default: root page against content language). ' .
+                       'Use value "*" to run for all mwfile language code subpages (including the base pages that override content language).', false, true );
        }
 
-       public function execute() {
-               global $wgUser, $wgContLang;
+       /**
+        * @param string|bool $langCode See --lang-code option.
+        */
+       protected function fetchMessageInfo( $langCode, array &$messageInfo ) {
+               global $wgContLang;
 
-               $doDelete = $this->hasOption( 'delete' );
-               $doDeleteTalk = $this->hasOption( 'delete-talk' );
-               $forLangCode = $this->getOption( 'lang-code' );
-
-               if ( $forLangCode ) {
-                       $langObj = Language::factory( $forLangCode );
-                       $langCode = $langObj->getCode();
+               if ( $langCode ) {
+                       $this->output( "\n... fetching message info for language: $langCode" );
                        $nonContLang = true;
                } else {
-                       $langObj = $wgContLang;
+                       $this->output( "\n... fetching message info for content language" );
                        $langCode = $wgContLang->getCode();
                        $nonContLang = false;
                }
 
-               $this->output( "Checking for pages with default message..." );
-
                /* Based on SpecialAllmessages::reallyDoQuery #filter=modified */
 
-               $messageNames = Language::getLocalisationCache()->getSubitemList( 'en', 'messages' );
+               $l10nCache = Language::getLocalisationCache();
+               $messageNames = $l10nCache->getSubitemList( 'en', 'messages' );
                // Normalise message names for NS_MEDIAWIKI page_title
-               $messageNames = array_map( array( $langObj, 'ucfirst' ), $messageNames );
-               // TODO: Do the below for each language code (e.g. delete /xxx subpage if equal to MessagesXxx)
-               // Right now it only takes care of the root override, which is enough since most wikis aren't multi-lang wikis.
+               $messageNames = array_map( array( $wgContLang, 'ucfirst' ), $messageNames );
+
                $statuses = AllmessagesTablePager::getCustomisedStatuses( $messageNames, $langCode, $nonContLang );
+               // getCustomisedStatuses is stripping the sub page from the page titles, add it back
+               $titleSuffix = $nonContLang ? "/$langCode" : '';
 
-               $relevantPages = 0;
-               $equalPages = 0;
-               $equalPagesTalks = 0;
-               $results = array();
                foreach ( $messageNames as $key ) {
                        $customised = isset( $statuses['pages'][$key] );
                        if ( $customised ) {
                                $actual = wfMessage( $key )->inLanguage( $langCode )->plain();
                                $default = wfMessage( $key )->inLanguage( $langCode )->useDatabase( false )->plain();
 
-                               $relevantPages++;
+                               $messageInfo['relevantPages']++;
                                if ( $actual === $default ) {
                                        $hasTalk = isset( $statuses['talks'][$key] );
-                                       $results[] = array(
-                                               'title' => $key,
+                                       $messageInfo['results'][] = array(
+                                               'title' => $key . $titleSuffix,
                                                'hasTalk' => $hasTalk,
                                        );
-                                       $equalPages++;
+                                       $messageInfo['equalPages']++;
                                        if ( $hasTalk ) {
-                                               $equalPagesTalks++;
+                                               $messageInfo['equalPagesTalks']++;
                                        }
                                }
                        }
                }
+       }
+
+       public function execute() {
+               $doDelete = $this->hasOption( 'delete' );
+               $doDeleteTalk = $this->hasOption( 'delete-talk' );
+               $langCode = $this->getOption( 'lang-code' );
+
+               $messageInfo = array(
+                       'relevantPages' => 0,
+                       'equalPages' => 0,
+                       'equalPagesTalks' => 0,
+                       'results' => array(),
+               );
+
+               $this->output( 'Checking for pages with default message...' );
+
+               // Load message information
+               if ( $langCode ) {
+                       $langCodes = Language::fetchLanguageNames( null, 'mwfile' );
+                       if ( $langCode === '*' ) {
+                               // All valid lang-code subpages in NS_MEDIAWIKI that
+                               // override the messsages in that language
+                               foreach ( $langCodes as $key => $value ) {
+                                       $this->fetchMessageInfo( $key, $messageInfo );
+                               }
+                               // Lastly, the base pages in NS_MEDIAWIKI that override
+                               // messages in content language
+                               $this->fetchMessageInfo( false, $messageInfo );
+                       } else {
+                               if ( !isset( $langCodes[$langCode] ) ) {
+                                       $this->error( 'Invalid language code: ' . $langCode, 1 );
+                               }
+                               $this->fetchMessageInfo( $langCode, $messageInfo );
+                       }
+               } else {
+                       $this->fetchMessageInfo( false, $messageInfo );
+               }
 
-               if ( $equalPages === 0 ) {
+               if ( $messageInfo['equalPages'] === 0 ) {
                        // No more equal messages left
-                       $this->output( "done.\n" );
+                       $this->output( "\ndone.\n" );
                        return;
                }
 
-               $this->output( "\n{$relevantPages} pages in the MediaWiki namespace override messages." );
-               $this->output( "\n{$equalPages} pages are equal to the default message ({$equalPagesTalks} talk pages).\n" );
+               $this->output( "\n{$messageInfo['relevantPages']} pages in the MediaWiki namespace override messages." );
+               $this->output( "\n{$messageInfo['equalPages']} pages are equal to the default message (+ {$messageInfo['equalPagesTalks']} talk pages).\n" );
 
                if ( !$doDelete ) {
-                       $this->output( "\nRun the script again with --delete to delete these pages" );
-                       if ( $equalPagesTalks !== 0 ) {
+                       $list = '';
+                       foreach ( $messageInfo['results'] as $result ) {
+                               $title = Title::makeTitle( NS_MEDIAWIKI, $result['title'] );
+                               $list .= "* [[$title]]\n";
+                               if ( $result['hasTalk'] ) {
+                                       $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] );
+                                       $list .= "* [[$title]]\n";
+                               }
+                       }
+                       $this->output( "\nList:\n$list\nRun the script again with --delete to delete these pages" );
+                       if ( $messageInfo['equalPagesTalks'] !== 0 ) {
                                $this->output( " (include --delete-talk to also delete the talk pages)" );
                        }
                        $this->output( "\n" );
@@ -111,33 +152,36 @@ class DeleteEqualMessages extends Maintenance {
                if ( !$user ) {
                        $this->error( "Invalid username", true );
                }
+               global $wgUser;
                $wgUser = $user;
 
                // Hide deletions from RecentChanges
                $user->addGroup( 'bot' );
 
                // Handle deletion
-               $this->output( "\n...deleting equal messages (this may take a long time!)...", 'msg' );
+               $this->output( "\n...deleting equal messages (this may take a long time!)..." );
                $dbw = wfGetDB( DB_MASTER );
-               foreach ( $results as $result ) {
+               foreach ( $messageInfo['results'] as $result ) {
                        wfWaitForSlaves();
                        $dbw->ping();
                        $dbw->begin( __METHOD__ );
                        $title = Title::makeTitle( NS_MEDIAWIKI, $result['title'] );
+                       $this->output( "\n* [[$title]]" );
                        $page = WikiPage::factory( $title );
                        $error = ''; // Passed by ref
                        $page->doDeleteArticle( 'No longer required', false, 0, false, $error, $user );
                        if ( $result['hasTalk'] && $doDeleteTalk ) {
                                $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] );
+                               $this->output( "\n* [[$title]]" );
                                $page = WikiPage::factory( $title );
                                $error = ''; // Passed by ref
                                $page->doDeleteArticle( 'Orphaned talk page of no longer required message', false, 0, false, $error, $user );
                        }
                        $dbw->commit( __METHOD__ );
                }
-               $this->output( "done!\n", 'msg' );
+               $this->output( "\n\ndone!\n" );
        }
 }
 
 $maintClass = "DeleteEqualMessages";
-require_once( RUN_MAINTENANCE_IF_MAIN );
+require_once RUN_MAINTENANCE_IF_MAIN;