maintenance/deleteEqualMessages.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Maintenance
  20  */
  21
  22 require_once __DIR__ . '/Maintenance.php';
  23
  24 /**
  25  * Maintenance script that deletes all pages in the MediaWiki namespace
  26  * of which the content is equal to the system default.
  27  *
  28  * @ingroup Maintenance
  29  */
  30 class DeleteEqualMessages extends Maintenance {
  31         public function __construct() {
  32                 parent::__construct();
  33                 $this->mDescription = "Deletes all pages in the MediaWiki namespace that are equal to '
  34                         . 'the default message";
  35                 $this->addOption( 'delete', 'Actually delete the pages (default: dry run)' );
  36                 $this->addOption( 'delete-talk', 'Don\'t leave orphaned talk pages behind during deletion' );
  37                 $this->addOption( 'lang-code', 'Check for subpages of this language code (default: root '
  38                         . 'page against content language). Use value "*" to run for all mwfile language code '
  39                         . 'subpages (including the base pages that override content language).', false, true );
  40         }
  41
  42         /**
  43          * @param string|bool $langCode See --lang-code option.
  44          */
  45         protected function fetchMessageInfo( $langCode, array &$messageInfo ) {
  46                 global $wgContLang;
  47
  48                 if ( $langCode ) {
  49                         $this->output( "\n... fetching message info for language: $langCode" );
  50                         $nonContLang = true;
  51                 } else {
  52                         $this->output( "\n... fetching message info for content language" );
  53                         $langCode = $wgContLang->getCode();
  54                         $nonContLang = false;
  55                 }
  56
  57                 /* Based on SpecialAllmessages::reallyDoQuery #filter=modified */
  58
  59                 $l10nCache = Language::getLocalisationCache();
  60                 $messageNames = $l10nCache->getSubitemList( 'en', 'messages' );
  61                 // Normalise message names for NS_MEDIAWIKI page_title
  62                 $messageNames = array_map( array( $wgContLang, 'ucfirst' ), $messageNames );
  63
  64                 $statuses = AllMessagesTablePager::getCustomisedStatuses(
  65                         $messageNames, $langCode, $nonContLang );
  66                 // getCustomisedStatuses is stripping the sub page from the page titles, add it back
  67                 $titleSuffix = $nonContLang ? "/$langCode" : '';
  68
  69                 foreach ( $messageNames as $key ) {
  70                         $customised = isset( $statuses['pages'][$key] );
  71                         if ( $customised ) {
  72                                 $actual = wfMessage( $key )->inLanguage( $langCode )->plain();
  73                                 $default = wfMessage( $key )->inLanguage( $langCode )->useDatabase( false )->plain();
  74
  75                                 $messageInfo['relevantPages']++;
  76
  77                                 if (
  78                                         // Exclude messages that are empty by default, such as sitenotice, specialpage
  79                                         // summaries and accesskeys.
  80                                         $default !== '' && $default !== '-' &&
  81                                                 $actual === $default
  82                                 ) {
  83                                         $hasTalk = isset( $statuses['talks'][$key] );
  84                                         $messageInfo['results'][] = array(
  85                                                 'title' => $key . $titleSuffix,
  86                                                 'hasTalk' => $hasTalk,
  87                                         );
  88                                         $messageInfo['equalPages']++;
  89                                         if ( $hasTalk ) {
  90                                                 $messageInfo['equalPagesTalks']++;
  91                                         }
  92                                 }
  93                         }
  94                 }
  95         }
  96
  97         public function execute() {
  98                 $doDelete = $this->hasOption( 'delete' );
  99                 $doDeleteTalk = $this->hasOption( 'delete-talk' );
 100                 $langCode = $this->getOption( 'lang-code' );
 101
 102                 $messageInfo = array(
 103                         'relevantPages' => 0,
 104                         'equalPages' => 0,
 105                         'equalPagesTalks' => 0,
 106                         'results' => array(),
 107                 );
 108
 109                 $this->output( 'Checking for pages with default message...' );
 110
 111                 // Load message information
 112                 if ( $langCode ) {
 113                         $langCodes = Language::fetchLanguageNames( null, 'mwfile' );
 114                         if ( $langCode === '*' ) {
 115                                 // All valid lang-code subpages in NS_MEDIAWIKI that
 116                                 // override the messsages in that language
 117                                 foreach ( $langCodes as $key => $value ) {
 118                                         $this->fetchMessageInfo( $key, $messageInfo );
 119                                 }
 120                                 // Lastly, the base pages in NS_MEDIAWIKI that override
 121                                 // messages in content language
 122                                 $this->fetchMessageInfo( false, $messageInfo );
 123                         } else {
 124                                 if ( !isset( $langCodes[$langCode] ) ) {
 125                                         $this->error( 'Invalid language code: ' . $langCode, 1 );
 126                                 }
 127                                 $this->fetchMessageInfo( $langCode, $messageInfo );
 128                         }
 129                 } else {
 130                         $this->fetchMessageInfo( false, $messageInfo );
 131                 }
 132
 133                 if ( $messageInfo['equalPages'] === 0 ) {
 134                         // No more equal messages left
 135                         $this->output( "\ndone.\n" );
 136
 137                         return;
 138                 }
 139
 140                 $this->output( "\n{$messageInfo['relevantPages']} pages in the MediaWiki namespace ' .
 141                         'override messages." );
 142                 $this->output( "\n{$messageInfo['equalPages']} pages are equal to the default message ' .
 143                         '(+ {$messageInfo['equalPagesTalks']} talk pages).\n" );
 144
 145                 if ( !$doDelete ) {
 146                         $list = '';
 147                         foreach ( $messageInfo['results'] as $result ) {
 148                                 $title = Title::makeTitle( NS_MEDIAWIKI, $result['title'] );
 149                                 $list .= "* [[$title]]\n";
 150                                 if ( $result['hasTalk'] ) {
 151                                         $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] );
 152                                         $list .= "* [[$title]]\n";
 153                                 }
 154                         }
 155                         $this->output( "\nList:\n$list\nRun the script again with --delete to delete these pages" );
 156                         if ( $messageInfo['equalPagesTalks'] !== 0 ) {
 157                                 $this->output( " (include --delete-talk to also delete the talk pages)" );
 158                         }
 159                         $this->output( "\n" );
 160
 161                         return;
 162                 }
 163
 164                 $user = User::newFromName( 'MediaWiki default' );
 165                 if ( !$user ) {
 166                         $this->error( "Invalid username", true );
 167                 }
 168                 global $wgUser;
 169                 $wgUser = $user;
 170
 171                 // Hide deletions from RecentChanges
 172                 $user->addGroup( 'bot' );
 173
 174                 // Handle deletion
 175                 $this->output( "\n...deleting equal messages (this may take a long time!)..." );
 176                 $dbw = wfGetDB( DB_MASTER );
 177                 foreach ( $messageInfo['results'] as $result ) {
 178                         wfWaitForSlaves();
 179                         $dbw->ping();
 180                         $title = Title::makeTitle( NS_MEDIAWIKI, $result['title'] );
 181                         $this->output( "\n* [[$title]]" );
 182                         $page = WikiPage::factory( $title );
 183                         $error = ''; // Passed by ref
 184                         $page->doDeleteArticle( 'No longer required', false, 0, false, $error, $user );
 185                         if ( $result['hasTalk'] && $doDeleteTalk ) {
 186                                 $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] );
 187                                 $this->output( "\n* [[$title]]" );
 188                                 $page = WikiPage::factory( $title );
 189                                 $error = ''; // Passed by ref
 190                                 $page->doDeleteArticle( 'Orphaned talk page of no longer required message',
 191                                         false, 0, false, $error, $user );
 192                         }
 193                 }
 194                 $this->output( "\n\ndone!\n" );
 195         }
 196 }
 197
 198 $maintClass = "DeleteEqualMessages";
 199 require_once RUN_MAINTENANCE_IF_MAIN;