MediaWiki  master
deleteEqualMessages.php
Go to the documentation of this file.
1 <?php
23 
24 require_once __DIR__ . '/Maintenance.php';
25 
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 );
42  }
43 
48  protected function fetchMessageInfo( $langCode, array &$messageInfo ) {
49  $services = MediaWikiServices::getInstance();
50  $contLang = $services->getContentLanguage();
51  if ( $langCode ) {
52  $this->output( "\n... fetching message info for language: $langCode" );
53  $nonContentLanguage = true;
54  } else {
55  $this->output( "\n... fetching message info for content language" );
56  $langCode = $contLang->getCode();
57  $nonContentLanguage = false;
58  }
59 
60  /* Based on SpecialAllmessages::reallyDoQuery #filter=modified */
61 
62  $l10nCache = $services->getLocalisationCache();
63  $messageNames = $l10nCache->getSubitemList( 'en', 'messages' );
64  // Normalise message names for NS_MEDIAWIKI page_title
65  $messageNames = array_map( [ $contLang, 'ucfirst' ], $messageNames );
66 
68  $messageNames,
69  $langCode,
70  $nonContentLanguage,
71  $this->getDB( DB_REPLICA )
72  );
73  // getCustomisedStatuses is stripping the sub page from the page titles, add it back
74  $titleSuffix = $nonContentLanguage ? "/$langCode" : '';
75 
76  foreach ( $messageNames as $key ) {
77  $customised = isset( $statuses['pages'][$key] );
78  if ( $customised ) {
79  $actual = wfMessage( $key )->inLanguage( $langCode )->plain();
80  $default = wfMessage( $key )->inLanguage( $langCode )->useDatabase( false )->plain();
81 
82  $messageInfo['relevantPages']++;
83 
84  if (
85  // Exclude messages that are empty by default, such as sitenotice, specialpage
86  // summaries and accesskeys.
87  $default !== '' && $default !== '-' &&
88  $actual === $default
89  ) {
90  $hasTalk = isset( $statuses['talks'][$key] );
91  $messageInfo['results'][] = [
92  'title' => $key . $titleSuffix,
93  'hasTalk' => $hasTalk,
94  ];
95  $messageInfo['equalPages']++;
96  if ( $hasTalk ) {
97  $messageInfo['equalPagesTalks']++;
98  }
99  }
100  }
101  }
102  }
103 
104  public function execute() {
105  $doDelete = $this->hasOption( 'delete' );
106  $doDeleteTalk = $this->hasOption( 'delete-talk' );
107  $langCode = $this->getOption( 'lang-code' );
108 
109  $messageInfo = [
110  'relevantPages' => 0,
111  'equalPages' => 0,
112  'equalPagesTalks' => 0,
113  'results' => [],
114  ];
115 
116  $this->output( 'Checking for pages with default message...' );
117 
118  $services = MediaWikiServices::getInstance();
119  // Load message information
120  if ( $langCode ) {
121  $langCodes = $services->getLanguageNameUtils()
122  ->getLanguageNames( null, 'mwfile' );
123  if ( $langCode === '*' ) {
124  // All valid lang-code subpages in NS_MEDIAWIKI that
125  // override the messsages in that language
126  foreach ( $langCodes as $key => $value ) {
127  $this->fetchMessageInfo( $key, $messageInfo );
128  }
129  // Lastly, the base pages in NS_MEDIAWIKI that override
130  // messages in content language
131  $this->fetchMessageInfo( false, $messageInfo );
132  } else {
133  if ( !isset( $langCodes[$langCode] ) ) {
134  $this->fatalError( 'Invalid language code: ' . $langCode );
135  }
136  $this->fetchMessageInfo( $langCode, $messageInfo );
137  }
138  } else {
139  $this->fetchMessageInfo( false, $messageInfo );
140  }
141 
142  if ( $messageInfo['equalPages'] === 0 ) {
143  // No more equal messages left
144  $this->output( "\ndone.\n" );
145 
146  return;
147  }
148 
149  $this->output( "\n{$messageInfo['relevantPages']} pages in the MediaWiki namespace "
150  . "override messages." );
151  $this->output( "\n{$messageInfo['equalPages']} pages are equal to the default message "
152  . "(+ {$messageInfo['equalPagesTalks']} talk pages).\n" );
153 
154  if ( !$doDelete ) {
155  $list = '';
156  foreach ( $messageInfo['results'] as $result ) {
157  $title = Title::makeTitle( NS_MEDIAWIKI, $result['title'] );
158  $list .= "* [[$title]]\n";
159  if ( $result['hasTalk'] ) {
160  $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] );
161  $list .= "* [[$title]]\n";
162  }
163  }
164  $this->output( "\nList:\n$list\nRun the script again with --delete to delete these pages" );
165  if ( $messageInfo['equalPagesTalks'] !== 0 ) {
166  $this->output( " (include --delete-talk to also delete the talk pages)" );
167  }
168  $this->output( "\n" );
169 
170  return;
171  }
172 
173  $user = User::newSystemUser( 'MediaWiki default', [ 'steal' => true ] );
174  if ( !$user ) {
175  $this->fatalError( "Invalid username" );
176  }
177  StubGlobalUser::setUser( $user );
178 
179  // Hide deletions from RecentChanges
180  $userGroupManager = $services->getUserGroupManager();
181  $userGroupManager->addUserToGroup( $user, 'bot' );
182 
183  // Handle deletion
184  $this->output( "\n...deleting equal messages (this may take a long time!)..." );
185  $dbw = $this->getDB( DB_PRIMARY );
186  $lbFactory = $services->getDBLoadBalancerFactory();
187  $wikiPageFactory = $services->getWikiPageFactory();
188  foreach ( $messageInfo['results'] as $result ) {
189  $lbFactory->waitForReplication();
190  $dbw->ping();
191  $title = Title::makeTitle( NS_MEDIAWIKI, $result['title'] );
192  $this->output( "\n* [[$title]]" );
193  $page = $wikiPageFactory->newFromTitle( $title );
194  $status = $page->doDeleteArticleReal( 'No longer required', $user );
195  if ( !$status->isOK() ) {
196  $this->output( " (Failed!)" );
197  }
198  if ( $result['hasTalk'] && $doDeleteTalk ) {
199  $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] );
200  $this->output( "\n* [[$title]]" );
201  $page = $wikiPageFactory->newFromTitle( $title );
202  $status = $page->doDeleteArticleReal(
203  'Orphaned talk page of no longer required message',
204  $user
205  );
206  if ( !$status->isOK() ) {
207  $this->output( " (Failed!)" );
208  }
209  }
210  }
211  $this->output( "\n\ndone!\n" );
212  }
213 }
214 
215 $maintClass = DeleteEqualMessages::class;
216 require_once RUN_MAINTENANCE_IF_MAIN;
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:72
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:193
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:489
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:329
DeleteEqualMessages\execute
execute()
Do the actual work.
Definition: deleteEqualMessages.php:104
NS_MEDIAWIKI_TALK
const NS_MEDIAWIKI_TALK
Definition: Defines.php:73
wfMessage
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Definition: GlobalFunctions.php:1182
StubGlobalUser\setUser
static setUser( $user)
Reset the stub global user to a different "real" user object, while ensuring that any method calls on...
Definition: StubGlobalUser.php:79
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:59
User\newSystemUser
static newSystemUser( $name, $options=[])
Static factory method for creation of a "system" user from username.
Definition: User.php:809
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:249
$title
$title
Definition: testCompression.php:38
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:651
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
AllMessagesTablePager\getCustomisedStatuses
static getCustomisedStatuses( $messageNames, $langcode='en', $foreign=false, IDatabase $dbr=null)
Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.
Definition: AllMessagesTablePager.php:156
DeleteEqualMessages\fetchMessageInfo
fetchMessageInfo( $langCode, array &$messageInfo)
Definition: deleteEqualMessages.php:48
DB_PRIMARY
const DB_PRIMARY
Definition: defines.php:27
Maintenance\getDB
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1362
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:286
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:435
DeleteEqualMessages
Maintenance script that deletes all pages in the MediaWiki namespace of which the content is equal to...
Definition: deleteEqualMessages.php:32
DeleteEqualMessages\__construct
__construct()
Default constructor.
Definition: deleteEqualMessages.php:33
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular option was set.
Definition: Maintenance.php:271
$maintClass
$maintClass
Definition: deleteEqualMessages.php:215