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.
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.
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
19 * @ingroup Maintenance
22 use MediaWiki\MediaWikiServices
;
24 require_once __DIR__
. '/Maintenance.php';
27 * Maintenance script that deletes all pages in the MediaWiki namespace
28 * of which the content is equal to the system default.
30 * @ingroup Maintenance
32 class DeleteEqualMessages
extends Maintenance
{
33 public function __construct() {
34 parent
::__construct();
35 $this->addDescription( 'Deletes all pages in the MediaWiki namespace that are equal to '
36 . 'the default message' );
37 $this->addOption( 'delete', 'Actually delete the pages (default: dry run)' );
38 $this->addOption( 'delete-talk', 'Don\'t leave orphaned talk pages behind during deletion' );
39 $this->addOption( 'lang-code', 'Check for subpages of this language code (default: root '
40 . 'page against content language). Use value "*" to run for all mwfile language code '
41 . 'subpages (including the base pages that override content language).', false, true );
45 * @param string|bool $langCode See --lang-code option.
46 * @param array &$messageInfo
48 protected function fetchMessageInfo( $langCode, array &$messageInfo ) {
49 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
51 $this->output( "\n... fetching message info for language: $langCode" );
52 $nonContentLanguage = true;
54 $this->output( "\n... fetching message info for content language" );
55 $langCode = $contLang->getCode();
56 $nonContentLanguage = false;
59 /* Based on SpecialAllmessages::reallyDoQuery #filter=modified */
61 $l10nCache = Language
::getLocalisationCache();
62 $messageNames = $l10nCache->getSubitemList( 'en', 'messages' );
63 // Normalise message names for NS_MEDIAWIKI page_title
64 $messageNames = array_map( [ $contLang, 'ucfirst' ], $messageNames );
66 $statuses = AllMessagesTablePager
::getCustomisedStatuses(
67 $messageNames, $langCode, $nonContentLanguage );
68 // getCustomisedStatuses is stripping the sub page from the page titles, add it back
69 $titleSuffix = $nonContentLanguage ?
"/$langCode" : '';
71 foreach ( $messageNames as $key ) {
72 $customised = isset( $statuses['pages'][$key] );
74 $actual = wfMessage( $key )->inLanguage( $langCode )->plain();
75 $default = wfMessage( $key )->inLanguage( $langCode )->useDatabase( false )->plain();
77 $messageInfo['relevantPages']++
;
80 // Exclude messages that are empty by default, such as sitenotice, specialpage
81 // summaries and accesskeys.
82 $default !== '' && $default !== '-' &&
85 $hasTalk = isset( $statuses['talks'][$key] );
86 $messageInfo['results'][] = [
87 'title' => $key . $titleSuffix,
88 'hasTalk' => $hasTalk,
90 $messageInfo['equalPages']++
;
92 $messageInfo['equalPagesTalks']++
;
99 public function execute() {
100 $doDelete = $this->hasOption( 'delete' );
101 $doDeleteTalk = $this->hasOption( 'delete-talk' );
102 $langCode = $this->getOption( 'lang-code' );
105 'relevantPages' => 0,
107 'equalPagesTalks' => 0,
111 $this->output( 'Checking for pages with default message...' );
113 // Load message information
115 $langCodes = Language
::fetchLanguageNames( null, 'mwfile' );
116 if ( $langCode === '*' ) {
117 // All valid lang-code subpages in NS_MEDIAWIKI that
118 // override the messsages in that language
119 foreach ( $langCodes as $key => $value ) {
120 $this->fetchMessageInfo( $key, $messageInfo );
122 // Lastly, the base pages in NS_MEDIAWIKI that override
123 // messages in content language
124 $this->fetchMessageInfo( false, $messageInfo );
126 if ( !isset( $langCodes[$langCode] ) ) {
127 $this->fatalError( 'Invalid language code: ' . $langCode );
129 $this->fetchMessageInfo( $langCode, $messageInfo );
132 $this->fetchMessageInfo( false, $messageInfo );
135 if ( $messageInfo['equalPages'] === 0 ) {
136 // No more equal messages left
137 $this->output( "\ndone.\n" );
142 $this->output( "\n{$messageInfo['relevantPages']} pages in the MediaWiki namespace "
143 . "override messages." );
144 $this->output( "\n{$messageInfo['equalPages']} pages are equal to the default message "
145 . "(+ {$messageInfo['equalPagesTalks']} talk pages).\n" );
149 foreach ( $messageInfo['results'] as $result ) {
150 $title = Title
::makeTitle( NS_MEDIAWIKI
, $result['title'] );
151 $list .= "* [[$title]]\n";
152 if ( $result['hasTalk'] ) {
153 $title = Title
::makeTitle( NS_MEDIAWIKI_TALK
, $result['title'] );
154 $list .= "* [[$title]]\n";
157 $this->output( "\nList:\n$list\nRun the script again with --delete to delete these pages" );
158 if ( $messageInfo['equalPagesTalks'] !== 0 ) {
159 $this->output( " (include --delete-talk to also delete the talk pages)" );
161 $this->output( "\n" );
166 $user = User
::newSystemUser( 'MediaWiki default', [ 'steal' => true ] );
168 $this->fatalError( "Invalid username" );
173 // Hide deletions from RecentChanges
174 $user->addGroup( 'bot' );
177 $this->output( "\n...deleting equal messages (this may take a long time!)..." );
178 $dbw = $this->getDB( DB_MASTER
);
179 foreach ( $messageInfo['results'] as $result ) {
182 $title = Title
::makeTitle( NS_MEDIAWIKI
, $result['title'] );
183 $this->output( "\n* [[$title]]" );
184 $page = WikiPage
::factory( $title );
185 $error = ''; // Passed by ref
186 $success = $page->doDeleteArticle( 'No longer required', false, 0, true, $error, $user );
188 $this->output( " (Failed!)" );
190 if ( $result['hasTalk'] && $doDeleteTalk ) {
191 $title = Title
::makeTitle( NS_MEDIAWIKI_TALK
, $result['title'] );
192 $this->output( "\n* [[$title]]" );
193 $page = WikiPage
::factory( $title );
194 $error = ''; // Passed by ref
195 $success = $page->doDeleteArticle( 'Orphaned talk page of no longer required message',
196 false, 0, true, $error, $user );
198 $this->output( " (Failed!)" );
202 $this->output( "\n\ndone!\n" );
206 $maintClass = DeleteEqualMessages
::class;
207 require_once RUN_MAINTENANCE_IF_MAIN
;