MediaWiki  REL1_31
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->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 ) {
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->fatalError( 'Invalid language code: ' . $langCode );
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 ) {
150  $list .= "* [[$title]]\n";
151  if ( $result['hasTalk'] ) {
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->fatalError( "Invalid username" );
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 ) {
179  wfWaitForSlaves();
180  $dbw->ping();
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 ) {
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 
206 require_once RUN_MAINTENANCE_IF_MAIN;
$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:247
$wgUser
$wgUser
Definition: Setup.php:902
wfMessage
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
array
the array() calling protocol came about after MediaWiki 1.4rc1.
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:439
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
DeleteEqualMessages\execute
execute()
Do the actual work.
Definition: deleteEqualMessages.php:98
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
$success
$success
Definition: NoLocalSettings.php:42
$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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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. '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) '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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. 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:1993
wfWaitForSlaves
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Definition: GlobalFunctions.php:2966
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
User\newSystemUser
static newSystemUser( $name, $options=[])
Static factory method for creation of a "system" user from username.
Definition: User.php:791
AllMessagesTablePager\getCustomisedStatuses
static getCustomisedStatuses( $messageNames, $langcode='en', $foreign=false)
Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.
Definition: AllMessagesTablePager.php:200
Language\getLocalisationCache
static getLocalisationCache()
Get the LocalisationCache instance.
Definition: Language.php:406
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
Language\fetchLanguageNames
static fetchLanguageNames( $inLanguage=null, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:803
NS_MEDIAWIKI_TALK
const NS_MEDIAWIKI_TALK
Definition: Defines.php:83
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_MASTER
const DB_MASTER
Definition: defines.php:26
DeleteEqualMessages\fetchMessageInfo
fetchMessageInfo( $langCode, array &$messageInfo)
Definition: deleteEqualMessages.php:46
$value
$value
Definition: styleTest.css.php:45
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:254
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:22
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1309
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:82
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
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
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:240
$maintClass
$maintClass
Definition: deleteEqualMessages.php:205
$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:57