MediaWiki  1.23.2
deleteEqualMessages.php
Go to the documentation of this file.
1 <?php
22 require_once __DIR__ . '/Maintenance.php';
23 
31  public function __construct() {
32  parent::__construct();
33  $this->mDescription = "Deletes all pages in the MediaWiki namespace that are equal to the default message";
34  $this->addOption( 'delete', 'Actually delete the pages (default: dry run)' );
35  $this->addOption( 'delete-talk', 'Don\'t leave orphaned talk pages behind during deletion' );
36  $this->addOption( 'lang-code', 'Check for subpages of this language code (default: root page against content language). ' .
37  'Use value "*" to run for all mwfile language code subpages (including the base pages that override content language).', false, true );
38  }
39 
43  protected function fetchMessageInfo( $langCode, array &$messageInfo ) {
45 
46  if ( $langCode ) {
47  $this->output( "\n... fetching message info for language: $langCode" );
48  $nonContLang = true;
49  } else {
50  $this->output( "\n... fetching message info for content language" );
51  $langCode = $wgContLang->getCode();
52  $nonContLang = false;
53  }
54 
55  /* Based on SpecialAllmessages::reallyDoQuery #filter=modified */
56 
57  $l10nCache = Language::getLocalisationCache();
58  $messageNames = $l10nCache->getSubitemList( 'en', 'messages' );
59  // Normalise message names for NS_MEDIAWIKI page_title
60  $messageNames = array_map( array( $wgContLang, 'ucfirst' ), $messageNames );
61 
62  $statuses = AllmessagesTablePager::getCustomisedStatuses( $messageNames, $langCode, $nonContLang );
63  // getCustomisedStatuses is stripping the sub page from the page titles, add it back
64  $titleSuffix = $nonContLang ? "/$langCode" : '';
65 
66  foreach ( $messageNames as $key ) {
67  $customised = isset( $statuses['pages'][$key] );
68  if ( $customised ) {
69  $actual = wfMessage( $key )->inLanguage( $langCode )->plain();
70  $default = wfMessage( $key )->inLanguage( $langCode )->useDatabase( false )->plain();
71 
72  $messageInfo['relevantPages']++;
73 
74  if (
75  // Exclude messages that are empty by default, such as sitenotice, specialpage
76  // summaries and accesskeys.
77  $default !== '' && $default !== '-' &&
78  $actual === $default
79  ) {
80  $hasTalk = isset( $statuses['talks'][$key] );
81  $messageInfo['results'][] = array(
82  'title' => $key . $titleSuffix,
83  'hasTalk' => $hasTalk,
84  );
85  $messageInfo['equalPages']++;
86  if ( $hasTalk ) {
87  $messageInfo['equalPagesTalks']++;
88  }
89  }
90  }
91  }
92  }
93 
94  public function execute() {
95  $doDelete = $this->hasOption( 'delete' );
96  $doDeleteTalk = $this->hasOption( 'delete-talk' );
97  $langCode = $this->getOption( 'lang-code' );
98 
99  $messageInfo = array(
100  'relevantPages' => 0,
101  'equalPages' => 0,
102  'equalPagesTalks' => 0,
103  'results' => array(),
104  );
105 
106  $this->output( 'Checking for pages with default message...' );
107 
108  // Load message information
109  if ( $langCode ) {
110  $langCodes = Language::fetchLanguageNames( null, 'mwfile' );
111  if ( $langCode === '*' ) {
112  // All valid lang-code subpages in NS_MEDIAWIKI that
113  // override the messsages in that language
114  foreach ( $langCodes as $key => $value ) {
115  $this->fetchMessageInfo( $key, $messageInfo );
116  }
117  // Lastly, the base pages in NS_MEDIAWIKI that override
118  // messages in content language
119  $this->fetchMessageInfo( false, $messageInfo );
120  } else {
121  if ( !isset( $langCodes[$langCode] ) ) {
122  $this->error( 'Invalid language code: ' . $langCode, 1 );
123  }
124  $this->fetchMessageInfo( $langCode, $messageInfo );
125  }
126  } else {
127  $this->fetchMessageInfo( false, $messageInfo );
128  }
129 
130  if ( $messageInfo['equalPages'] === 0 ) {
131  // No more equal messages left
132  $this->output( "\ndone.\n" );
133  return;
134  }
135 
136  $this->output( "\n{$messageInfo['relevantPages']} pages in the MediaWiki namespace override messages." );
137  $this->output( "\n{$messageInfo['equalPages']} pages are equal to the default message (+ {$messageInfo['equalPagesTalks']} talk pages).\n" );
138 
139  if ( !$doDelete ) {
140  $list = '';
141  foreach ( $messageInfo['results'] as $result ) {
143  $list .= "* [[$title]]\n";
144  if ( $result['hasTalk'] ) {
146  $list .= "* [[$title]]\n";
147  }
148  }
149  $this->output( "\nList:\n$list\nRun the script again with --delete to delete these pages" );
150  if ( $messageInfo['equalPagesTalks'] !== 0 ) {
151  $this->output( " (include --delete-talk to also delete the talk pages)" );
152  }
153  $this->output( "\n" );
154  return;
155  }
156 
157  $user = User::newFromName( 'MediaWiki default' );
158  if ( !$user ) {
159  $this->error( "Invalid username", true );
160  }
161  global $wgUser;
162  $wgUser = $user;
163 
164  // Hide deletions from RecentChanges
165  $user->addGroup( 'bot' );
166 
167  // Handle deletion
168  $this->output( "\n...deleting equal messages (this may take a long time!)..." );
169  $dbw = wfGetDB( DB_MASTER );
170  foreach ( $messageInfo['results'] as $result ) {
171  wfWaitForSlaves();
172  $dbw->ping();
173  $dbw->begin( __METHOD__ );
175  $this->output( "\n* [[$title]]" );
176  $page = WikiPage::factory( $title );
177  $error = ''; // Passed by ref
178  $page->doDeleteArticle( 'No longer required', false, 0, false, $error, $user );
179  if ( $result['hasTalk'] && $doDeleteTalk ) {
181  $this->output( "\n* [[$title]]" );
182  $page = WikiPage::factory( $title );
183  $error = ''; // Passed by ref
184  $page->doDeleteArticle( 'Orphaned talk page of no longer required message', false, 0, false, $error, $user );
185  }
186  $dbw->commit( __METHOD__ );
187  }
188  $this->output( "\n\ndone!\n" );
189  }
190 }
191 
192 $maintClass = "DeleteEqualMessages";
193 require_once RUN_MAINTENANCE_IF_MAIN;
Title\makeTitle
static & makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:398
$wgUser
$wgUser
Definition: Setup.php:552
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
DB_MASTER
const DB_MASTER
Definition: Defines.php:56
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
wfGetDB
& wfGetDB( $db, $groups=array(), $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3650
DeleteEqualMessages\execute
execute()
Do the actual work.
Definition: deleteEqualMessages.php:94
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false)
Add a parameter to the script.
Definition: Maintenance.php:169
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:388
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
$wgContLang
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 content language as $wgContLang
Definition: design.txt:56
Language\getLocalisationCache
static getLocalisationCache()
Get the LocalisationCache instance.
Definition: Language.php:443
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:103
Language\fetchLanguageNames
static fetchLanguageNames( $inLanguage=null, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:875
NS_MEDIAWIKI_TALK
const NS_MEDIAWIKI_TALK
Definition: Defines.php:88
wfMessage
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables 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
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
wfWaitForSlaves
wfWaitForSlaves( $maxLag=false, $wiki=false, $cluster=false)
Modern version of wfWaitForSlaves().
Definition: GlobalFunctions.php:3795
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
DeleteEqualMessages\fetchMessageInfo
fetchMessageInfo( $langCode, array &$messageInfo)
Definition: deleteEqualMessages.php:43
$value
$value
Definition: styleTest.css.php:45
$user
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 account $user
Definition: hooks.txt:237
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:191
AllmessagesTablePager\getCustomisedStatuses
static getCustomisedStatuses( $messageNames, $langcode='en', $foreign=false)
Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.
Definition: SpecialAllmessages.php:243
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:333
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:314
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:87
DeleteEqualMessages
Maintenance script that deletes all pages in the MediaWiki namespace of which the content is equal to...
Definition: deleteEqualMessages.php:30
DeleteEqualMessages\__construct
__construct()
Default constructor.
Definition: deleteEqualMessages.php:31
$error
usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object with all info about the upload string as detected by MediaWiki Handlers will typically only apply for specific mime types object & $error
Definition: hooks.txt:2573
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:181
$maintClass
$maintClass
Definition: deleteEqualMessages.php:192