MediaWiki REL1_30
deleteEqualMessages.php
Go to the documentation of this file.
1<?php
22require_once __DIR__ . '/Maintenance.php';
23
31 public function __construct() {
32 parent::__construct();
33 $this->addDescription( '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
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( [ $wgContLang, 'ucfirst' ], $messageNames );
64
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'][] = [
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 = [
104 'relevantPages' => 0,
105 'equalPages' => 0,
106 'equalPagesTalks' => 0,
107 'results' => [],
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::newSystemUser( 'MediaWiki default', [ 'steal' => true ] );
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 = $this->getDB( DB_MASTER );
178 foreach ( $messageInfo['results'] as $result ) {
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 $success = $page->doDeleteArticle( 'No longer required', false, 0, true, $error, $user );
186 if ( !$success ) {
187 $this->output( " (Failed!)" );
188 }
189 if ( $result['hasTalk'] && $doDeleteTalk ) {
190 $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] );
191 $this->output( "\n* [[$title]]" );
192 $page = WikiPage::factory( $title );
193 $error = ''; // Passed by ref
194 $success = $page->doDeleteArticle( 'Orphaned talk page of no longer required message',
195 false, 0, true, $error, $user );
196 if ( !$success ) {
197 $this->output( " (Failed!)" );
198 }
199 }
200 }
201 $this->output( "\n\ndone!\n" );
202 }
203}
204
205$maintClass = "DeleteEqualMessages";
206require_once RUN_MAINTENANCE_IF_MAIN;
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
$wgUser
Definition Setup.php:817
static getCustomisedStatuses( $messageNames, $langcode='en', $foreign=false)
Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.
Maintenance script that deletes all pages in the MediaWiki namespace of which the content is equal to...
__construct()
Default constructor.
execute()
Do the actual work.
fetchMessageInfo( $langCode, array &$messageInfo)
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption( $name)
Checks to see if a particular param exists.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition WikiPage.php:121
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition hooks.txt:2581
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
const NS_MEDIAWIKI_TALK
Definition Defines.php:74
require_once RUN_MAINTENANCE_IF_MAIN
const DB_MASTER
Definition defines.php:26