MediaWiki  master
cleanupEmptyCategories.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
33 
34  public function __construct() {
35  parent::__construct();
36  $this->addDescription(
37  <<<TEXT
38 This script will clean up the category table by removing entries for empty
39 categories without a description page and adding entries for empty categories
40 with a description page. It will print out progress indicators every batch. The
41 script is perfectly safe to run on large, live wikis, and running it multiple
42 times is harmless. You may want to use the throttling options if it's causing
43 too much load; they will not affect correctness.
44 
45 If the script is stopped and later resumed, you can use the --mode and --begin
46 options with the last printed progress indicator to pick up where you left off.
47 
48 When the script has finished, it will make a note of this in the database, and
49 will not run again without the --force option.
50 TEXT
51  );
52 
53  $this->addOption(
54  'mode',
55  '"add" empty categories with description pages, "remove" empty categories '
56  . 'without description pages, or "both"',
57  false,
58  true
59  );
60  $this->addOption(
61  'begin',
62  'Only do categories whose names are alphabetically after the provided name',
63  false,
64  true
65  );
66  $this->addOption(
67  'throttle',
68  'Wait this many milliseconds after each batch. Default: 0',
69  false,
70  true
71  );
72  }
73 
74  protected function getUpdateKey() {
75  return 'cleanup empty categories';
76  }
77 
78  protected function doDBUpdates() {
79  $mode = $this->getOption( 'mode', 'both' );
80  $begin = $this->getOption( 'begin', '' );
81  $throttle = $this->getOption( 'throttle', 0 );
82 
83  if ( !in_array( $mode, [ 'add', 'remove', 'both' ] ) ) {
84  $this->output( "--mode must be 'add', 'remove', or 'both'.\n" );
85  return false;
86  }
87 
88  $dbw = $this->getDB( DB_MASTER );
89 
90  $throttle = intval( $throttle );
91 
92  if ( $mode === 'add' || $mode === 'both' ) {
93  if ( $begin !== '' ) {
94  $where = [ 'page_title > ' . $dbw->addQuotes( $begin ) ];
95  } else {
96  $where = [];
97  }
98 
99  $this->output( "Adding empty categories with description pages...\n" );
100  while ( true ) {
101  # Find which category to update
102  $rows = $dbw->select(
103  [ 'page', 'category' ],
104  'page_title',
105  array_merge( $where, [
106  'page_namespace' => NS_CATEGORY,
107  'cat_title' => null,
108  ] ),
109  __METHOD__,
110  [
111  'ORDER BY' => 'page_title',
112  'LIMIT' => $this->getBatchSize(),
113  ],
114  [
115  'category' => [ 'LEFT JOIN', 'page_title = cat_title' ],
116  ]
117  );
118  if ( !$rows || $rows->numRows() <= 0 ) {
119  break;
120  }
121 
122  foreach ( $rows as $row ) {
123  $name = $row->page_title;
124  $where = [ 'page_title > ' . $dbw->addQuotes( $name ) ];
125 
126  # Use the row to update the category count
127  $cat = Category::newFromName( $name );
128  if ( !is_object( $cat ) ) {
129  $this->output( "The category named $name is not valid?!\n" );
130  } else {
131  $cat->refreshCounts();
132  }
133  }
134  $this->output( "--mode=$mode --begin=$name\n" );
135 
136  wfWaitForSlaves();
137  usleep( $throttle * 1000 );
138  }
139 
140  $begin = '';
141  }
142 
143  if ( $mode === 'remove' || $mode === 'both' ) {
144  if ( $begin !== '' ) {
145  $where = [ 'cat_title > ' . $dbw->addQuotes( $begin ) ];
146  } else {
147  $where = [];
148  }
149 
150  $this->output( "Removing empty categories without description pages...\n" );
151  while ( true ) {
152  # Find which category to update
153  $rows = $dbw->select(
154  [ 'category', 'page' ],
155  'cat_title',
156  array_merge( $where, [
157  'page_title' => null,
158  'cat_pages' => 0,
159  ] ),
160  __METHOD__,
161  [
162  'ORDER BY' => 'cat_title',
163  'LIMIT' => $this->getBatchSize(),
164  ],
165  [
166  'page' => [ 'LEFT JOIN', [
167  'page_namespace' => NS_CATEGORY, 'page_title = cat_title'
168  ] ],
169  ]
170  );
171  if ( !$rows || $rows->numRows() <= 0 ) {
172  break;
173  }
174  foreach ( $rows as $row ) {
175  $name = $row->cat_title;
176  $where = [ 'cat_title > ' . $dbw->addQuotes( $name ) ];
177 
178  # Use the row to update the category count
179  $cat = Category::newFromName( $name );
180  if ( !is_object( $cat ) ) {
181  $this->output( "The category named $name is not valid?!\n" );
182  } else {
183  $cat->refreshCounts();
184  }
185  }
186 
187  $this->output( "--mode=remove --begin=$name\n" );
188 
189  wfWaitForSlaves();
190  usleep( $throttle * 1000 );
191  }
192  }
193 
194  $this->output( "Category cleanup complete.\n" );
195 
196  return true;
197  }
198 }
199 
200 $maintClass = CleanupEmptyCategories::class;
201 require_once RUN_MAINTENANCE_IF_MAIN;
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set up
Definition: hooks.txt:2217
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had 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 similarly to how extensions are installed You can then make that skin the default by adding
Definition: skin.txt:57
target page
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a batch
Definition: linkcache.txt:14
This document provides an overview of the usage of PageUpdater and that is
Definition: pageupdater.txt:3
and how to run hooks for an and one after Each event has a name
Definition: hooks.txt:6
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
An extension or a local will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may add
Definition: hooks.txt:51
addDescription( $text)
Set the description text.
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed by
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:35
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
Class for scripts that perform database maintenance and want to log the update in updatelog so we can...
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
Definition: deferred.txt:11
$dbw begin(__METHOD__)
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going on
Definition: hooks.txt:77
</td >< td > &</td >< td > t want your writing to be edited mercilessly and redistributed at will
=Architecture==Two class hierarchies are used to provide the functionality associated with the different content models:*Content interface(and AbstractContent base class) define functionality that acts on the concrete content of a page, and *ContentHandler base class provides functionality specific to a content model, but not acting on concrete content. The most important function of ContentHandler is to act as a factory for the appropriate implementation of Content. These Content objects are to be used by MediaWiki everywhere, instead of passing page content around as text. All manipulation and analysis of page content must be done via the appropriate methods of the Content object. For each content model, a subclass of ContentHandler has to be registered with $wgContentHandlers. The ContentHandler object for a given content model can be obtained using ContentHandler::getForModelID($id). Also Title, WikiPage and Revision now have getContentHandler() methods for convenience. ContentHandler objects are singletons that provide functionality specific to the content type, but not directly acting on the content of some page. ContentHandler::makeEmptyContent() and ContentHandler::unserializeContent() can be used to create a Content object of the appropriate type. However, it is recommended to instead use WikiPage::getContent() resp. Revision::getContent() to get a page 's content as a Content object. These two methods should be the ONLY way in which page content is accessed. Another important function of ContentHandler objects is to define custom action handlers for a content model, see ContentHandler::getActionOverrides(). This is similar to what WikiPage::getActionOverrides() was already doing.==Serialization==With the ContentHandler facility, page content no longer has to be text based. Objects implementing the Content interface are used to represent and handle the content internally. For storage and data exchange, each content model supports at least one serialization format via ContentHandler::serializeContent($content). The list of supported formats for a given content model can be accessed using ContentHandler::getSupportedFormats(). Content serialization formats are identified using MIME type like strings. The following formats are built in:*text/x-wiki - wikitext *text/javascript - for js pages *text/css - for css pages *text/plain - for future use, e.g. with plain text messages. *text/html - for future use, e.g. with plain html messages. *application/vnd.php.serialized - for future use with the api and for extensions *application/json - for future use with the api, and for use by extensions *application/xml - for future use with the api, and for use by extensions In PHP, use the corresponding CONTENT_FORMAT_XXX constant. Note that when using the API to access page content, especially action=edit, action=parse and action=query &prop=revisions, the model and format of the content should always be handled explicitly. Without that information, interpretation of the provided content is not reliable. The same applies to XML dumps generated via maintenance/dumpBackup.php or Special:Export. Also note that the API will provide encapsulated, serialized content - so if the API was called with format=json, and contentformat is also json(or rather, application/json), the page content is represented as a string containing an escaped json structure. Extensions that use JSON to serialize some types of page content may provide specialized API modules that allow access to that content in a more natural form.==Compatibility==The ContentHandler facility is introduced in a way that should allow all existing code to keep functioning at least for pages that contain wikitext or other text based content. However, a number of functions and hooks have been deprecated in favor of new versions that are aware of the page 's content model, and will now generate warnings when used. Most importantly, the following functions have been deprecated:*Revisions::getText() is deprecated in favor Revisions::getContent() *WikiPage::getText() is deprecated in favor WikiPage::getContent() Also, the old Article::getContent()(which returns text) is superceded by Article::getContentObject(). However, both methods should be avoided since they do not provide clean access to the page 's actual content. For instance, they may return a system message for non-existing pages. Use WikiPage::getContent() instead. Code that relies on a textual representation of the page content should eventually be rewritten. However, ContentHandler::getContentText() provides a stop-gap that can be used to get text for a page. Its behavior is controlled by $wgContentHandlerTextFallback it
within a display generated by the Derivative if and wherever such third party notices normally appear The contents of the NOTICE file are for informational purposes only and do not modify the License You may add Your own attribution notices within Derivative Works that You alongside or as an addendum to the NOTICE text from the provided that such additional attribution notices cannot be construed as modifying the License You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for or distribution of Your or for any such Derivative Works as a provided Your and distribution of the Work otherwise complies with the conditions stated in this License Submission of Contributions Unless You explicitly state any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this without any additional terms or conditions Notwithstanding the nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions Trademarks This License does not grant permission to use the trade names
Maintenance script to clean up empty categories in the category table.