[Summary view] [Print] [Text view]

   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       * @param array &$messageInfo
  45       */
  46  	protected function fetchMessageInfo( $langCode, array &$messageInfo ) {
  47          global $wgContLang;
  48  
  49          if ( $langCode ) {
  50              $this->output( "\n... fetching message info for language: $langCode" );
  51              $nonContLang = true;
  52          } else {
  53              $this->output( "\n... fetching message info for content language" );
  54              $langCode = $wgContLang->getCode();
  55              $nonContLang = false;
  56          }
  57  
  58          /* Based on SpecialAllmessages::reallyDoQuery #filter=modified */
  59  
  60          $l10nCache = Language::getLocalisationCache();
  61          $messageNames = $l10nCache->getSubitemList( 'en', 'messages' );
  62          // Normalise message names for NS_MEDIAWIKI page_title
  63          $messageNames = array_map( array( $wgContLang, 'ucfirst' ), $messageNames );
  64  
  65          $statuses = AllMessagesTablePager::getCustomisedStatuses(
  66              $messageNames, $langCode, $nonContLang );
  67          // getCustomisedStatuses is stripping the sub page from the page titles, add it back
  68          $titleSuffix = $nonContLang ? "/$langCode" : '';
  69  
  70          foreach ( $messageNames as $key ) {
  71              $customised = isset( $statuses['pages'][$key] );
  72              if ( $customised ) {
  73                  $actual = wfMessage( $key )->inLanguage( $langCode )->plain();
  74                  $default = wfMessage( $key )->inLanguage( $langCode )->useDatabase( false )->plain();
  75  
  76                  $messageInfo['relevantPages']++;
  77  
  78                  if (
  79                      // Exclude messages that are empty by default, such as sitenotice, specialpage
  80                      // summaries and accesskeys.
  81                      $default !== '' && $default !== '-' &&
  82                          $actual === $default
  83                  ) {
  84                      $hasTalk = isset( $statuses['talks'][$key] );
  85                      $messageInfo['results'][] = array(
  86                          'title' => $key . $titleSuffix,
  87                          'hasTalk' => $hasTalk,
  88                      );
  89                      $messageInfo['equalPages']++;
  90                      if ( $hasTalk ) {
  91                          $messageInfo['equalPagesTalks']++;
  92                      }
  93                  }
  94              }
  95          }
  96      }
  97  
  98  	public function execute() {
  99          $doDelete = $this->hasOption( 'delete' );
 100          $doDeleteTalk = $this->hasOption( 'delete-talk' );
 101          $langCode = $this->getOption( 'lang-code' );
 102  
 103          $messageInfo = array(
 104              'relevantPages' => 0,
 105              'equalPages' => 0,
 106              'equalPagesTalks' => 0,
 107              'results' => array(),
 108          );
 109  
 110          $this->output( 'Checking for pages with default message...' );
 111  
 112          // Load message information
 113          if ( $langCode ) {
 114              $langCodes = Language::fetchLanguageNames( null, 'mwfile' );
 115              if ( $langCode === '*' ) {
 116                  // All valid lang-code subpages in NS_MEDIAWIKI that
 117                  // override the messsages in that language
 118                  foreach ( $langCodes as $key => $value ) {
 119                      $this->fetchMessageInfo( $key, $messageInfo );
 120                  }
 121                  // Lastly, the base pages in NS_MEDIAWIKI that override
 122                  // messages in content language
 123                  $this->fetchMessageInfo( false, $messageInfo );
 124              } else {
 125                  if ( !isset( $langCodes[$langCode] ) ) {
 126                      $this->error( 'Invalid language code: ' . $langCode, 1 );
 127                  }
 128                  $this->fetchMessageInfo( $langCode, $messageInfo );
 129              }
 130          } else {
 131              $this->fetchMessageInfo( false, $messageInfo );
 132          }
 133  
 134          if ( $messageInfo['equalPages'] === 0 ) {
 135              // No more equal messages left
 136              $this->output( "\ndone.\n" );
 137  
 138              return;
 139          }
 140  
 141          $this->output( "\n{$messageInfo['relevantPages']} pages in the MediaWiki namespace "
 142              . "override messages." );
 143          $this->output( "\n{$messageInfo['equalPages']} pages are equal to the default message "
 144              . "(+ {$messageInfo['equalPagesTalks']} talk pages).\n" );
 145  
 146          if ( !$doDelete ) {
 147              $list = '';
 148              foreach ( $messageInfo['results'] as $result ) {
 149                  $title = Title::makeTitle( NS_MEDIAWIKI, $result['title'] );
 150                  $list .= "* [[$title]]\n";
 151                  if ( $result['hasTalk'] ) {
 152                      $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] );
 153                      $list .= "* [[$title]]\n";
 154                  }
 155              }
 156              $this->output( "\nList:\n$list\nRun the script again with --delete to delete these pages" );
 157              if ( $messageInfo['equalPagesTalks'] !== 0 ) {
 158                  $this->output( " (include --delete-talk to also delete the talk pages)" );
 159              }
 160              $this->output( "\n" );
 161  
 162              return;
 163          }
 164  
 165          $user = User::newFromName( 'MediaWiki default' );
 166          if ( !$user ) {
 167              $this->error( "Invalid username", true );
 168          }
 169          global $wgUser;
 170          $wgUser = $user;
 171  
 172          // Hide deletions from RecentChanges
 173          $user->addGroup( 'bot' );
 174  
 175          // Handle deletion
 176          $this->output( "\n...deleting equal messages (this may take a long time!)..." );
 177          $dbw = wfGetDB( DB_MASTER );
 178          foreach ( $messageInfo['results'] as $result ) {
 179              wfWaitForSlaves();
 180              $dbw->ping();
 181              $title = Title::makeTitle( NS_MEDIAWIKI, $result['title'] );
 182              $this->output( "\n* [[$title]]" );
 183              $page = WikiPage::factory( $title );
 184              $error = ''; // Passed by ref
 185              $page->doDeleteArticle( 'No longer required', false, 0, false, $error, $user );
 186              if ( $result['hasTalk'] && $doDeleteTalk ) {
 187                  $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] );
 188                  $this->output( "\n* [[$title]]" );
 189                  $page = WikiPage::factory( $title );
 190                  $error = ''; // Passed by ref
 191                  $page->doDeleteArticle( 'Orphaned talk page of no longer required message',
 192                      false, 0, false, $error, $user );
 193              }
 194          }
 195          $this->output( "\n\ndone!\n" );
 196      }
 197  }
 198  
 199  $maintClass = "DeleteEqualMessages";
 200  require_once RUN_MAINTENANCE_IF_MAIN;