MediaWiki  1.28.0
LinksDeletionUpdate.php
Go to the documentation of this file.
1 <?php
24 
30  protected $page;
32  protected $pageId;
34  protected $timestamp;
35 
37  private $db;
38 
45  function __construct( WikiPage $page, $pageId = null, $timestamp = null ) {
46  parent::__construct();
47 
48  $this->page = $page;
49  if ( $pageId ) {
50  $this->pageId = $pageId; // page ID at time of deletion
51  } elseif ( $page->exists() ) {
52  $this->pageId = $page->getId();
53  } else {
54  throw new InvalidArgumentException( "Page ID not known. Page doesn't exist?" );
55  }
56 
57  $this->timestamp = $timestamp ?: wfTimestampNow();
58  }
59 
60  public function doUpdate() {
61  $services = MediaWikiServices::getInstance();
62  $config = $services->getMainConfig();
63  $lbFactory = $services->getDBLoadBalancerFactory();
64  $batchSize = $config->get( 'UpdateRowsPerQuery' );
65 
66  // Page may already be deleted, so don't just getId()
67  $id = $this->pageId;
68 
69  if ( $this->ticket ) {
70  // Make sure all links update threads see the changes of each other.
71  // This handles the case when updates have to batched into several COMMITs.
72  $scopedLock = LinksUpdate::acquirePageLock( $this->getDB(), $id );
73  }
74 
75  $title = $this->page->getTitle();
76  $dbw = $this->getDB(); // convenience
77 
78  // Delete restrictions for it
79  $dbw->delete( 'page_restrictions', [ 'pr_page' => $id ], __METHOD__ );
80 
81  // Fix category table counts
82  $cats = $dbw->selectFieldValues(
83  'categorylinks',
84  'cl_to',
85  [ 'cl_from' => $id ],
86  __METHOD__
87  );
88  $catBatches = array_chunk( $cats, $batchSize );
89  foreach ( $catBatches as $catBatch ) {
90  $this->page->updateCategoryCounts( [], $catBatch, $id );
91  if ( count( $catBatches ) > 1 ) {
92  $lbFactory->commitAndWaitForReplication(
93  __METHOD__, $this->ticket, [ 'wiki' => $dbw->getWikiID() ]
94  );
95  }
96  }
97 
98  // Refresh the category table entry if it seems to have no pages. Check
99  // master for the most up-to-date cat_pages count.
100  if ( $title->getNamespace() === NS_CATEGORY ) {
101  $row = $dbw->selectRow(
102  'category',
103  [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
104  [ 'cat_title' => $title->getDBkey(), 'cat_pages <= 0' ],
105  __METHOD__
106  );
107  if ( $row ) {
108  Category::newFromRow( $row, $title )->refreshCounts();
109  }
110  }
111 
112  $this->batchDeleteByPK(
113  'pagelinks',
114  [ 'pl_from' => $id ],
115  [ 'pl_from', 'pl_namespace', 'pl_title' ],
116  $batchSize
117  );
118  $this->batchDeleteByPK(
119  'imagelinks',
120  [ 'il_from' => $id ],
121  [ 'il_from', 'il_to' ],
122  $batchSize
123  );
124  $this->batchDeleteByPK(
125  'categorylinks',
126  [ 'cl_from' => $id ],
127  [ 'cl_from', 'cl_to' ],
128  $batchSize
129  );
130  $this->batchDeleteByPK(
131  'templatelinks',
132  [ 'tl_from' => $id ],
133  [ 'tl_from', 'tl_namespace', 'tl_title' ],
134  $batchSize
135  );
136  $this->batchDeleteByPK(
137  'externallinks',
138  [ 'el_from' => $id ],
139  [ 'el_id' ],
140  $batchSize
141  );
142  $this->batchDeleteByPK(
143  'langlinks',
144  [ 'll_from' => $id ],
145  [ 'll_from', 'll_lang' ],
146  $batchSize
147  );
148  $this->batchDeleteByPK(
149  'iwlinks',
150  [ 'iwl_from' => $id ],
151  [ 'iwl_from', 'iwl_prefix', 'iwl_title' ],
152  $batchSize
153  );
154 
155  // Delete any redirect entry or page props entries
156  $dbw->delete( 'redirect', [ 'rd_from' => $id ], __METHOD__ );
157  $dbw->delete( 'page_props', [ 'pp_page' => $id ], __METHOD__ );
158 
159  // Find recentchanges entries to clean up...
160  $rcIdsForTitle = $dbw->selectFieldValues(
161  'recentchanges',
162  'rc_id',
163  [
164  'rc_type != ' . RC_LOG,
165  'rc_namespace' => $title->getNamespace(),
166  'rc_title' => $title->getDBkey(),
167  'rc_timestamp < ' .
168  $dbw->addQuotes( $dbw->timestamp( $this->timestamp ) )
169  ],
170  __METHOD__
171  );
172  $rcIdsForPage = $dbw->selectFieldValues(
173  'recentchanges',
174  'rc_id',
175  [ 'rc_type != ' . RC_LOG, 'rc_cur_id' => $id ],
176  __METHOD__
177  );
178 
179  // T98706: delete by PK to avoid lock contention with RC delete log insertions
180  $rcIdBatches = array_chunk( array_merge( $rcIdsForTitle, $rcIdsForPage ), $batchSize );
181  foreach ( $rcIdBatches as $rcIdBatch ) {
182  $dbw->delete( 'recentchanges', [ 'rc_id' => $rcIdBatch ], __METHOD__ );
183  if ( count( $rcIdBatches ) > 1 ) {
184  $lbFactory->commitAndWaitForReplication(
185  __METHOD__, $this->ticket, [ 'wiki' => $dbw->getWikiID() ]
186  );
187  }
188  }
189 
190  // Commit and release the lock (if set)
191  ScopedCallback::consume( $scopedLock );
192  }
193 
194  private function batchDeleteByPK( $table, array $conds, array $pk, $bSize ) {
195  $services = MediaWikiServices::getInstance();
196  $lbFactory = $services->getDBLoadBalancerFactory();
197  $dbw = $this->getDB(); // convenience
198 
199  $res = $dbw->select( $table, $pk, $conds, __METHOD__ );
200 
201  $pkDeleteConds = [];
202  foreach ( $res as $row ) {
203  $pkDeleteConds[] = $dbw->makeList( (array)$row, LIST_AND );
204  if ( count( $pkDeleteConds ) >= $bSize ) {
205  $dbw->delete( $table, $dbw->makeList( $pkDeleteConds, LIST_OR ), __METHOD__ );
206  $lbFactory->commitAndWaitForReplication(
207  __METHOD__, $this->ticket, [ 'wiki' => $dbw->getWikiID() ]
208  );
209  $pkDeleteConds = [];
210  }
211  }
212 
213  if ( $pkDeleteConds ) {
214  $dbw->delete( $table, $dbw->makeList( $pkDeleteConds, LIST_OR ), __METHOD__ );
215  }
216  }
217 
218  protected function getDB() {
219  if ( !$this->db ) {
220  $this->db = wfGetDB( DB_MASTER );
221  }
222 
223  return $this->db;
224  }
225 
226  public function getAsJobSpecification() {
227  return [
228  'wiki' => $this->getDB()->getWikiID(),
229  'job' => new JobSpecification(
230  'deleteLinks',
231  [ 'pageId' => $this->pageId, 'timestamp' => $this->timestamp ],
232  [ 'removeDuplicates' => true ],
233  $this->page->getTitle()
234  )
235  ];
236  }
237 }
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
__construct(WikiPage $page, $pageId=null, $timestamp=null)
the array() calling protocol came about after MediaWiki 1.4rc1.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Interface that marks a DataUpdate as enqueuable via the JobQueue.
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 MediaWikiServices
Definition: injection.txt:23
const DB_MASTER
Definition: defines.php:23
const LIST_AND
Definition: Defines.php:35
$res
Definition: database.txt:21
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
const NS_CATEGORY
Definition: Defines.php:70
batchDeleteByPK($table, array $conds, array $pk, $bSize)
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2159
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
const LIST_OR
Definition: Defines.php:38
Class representing a MediaWiki article and history.
Definition: WikiPage.php:32
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
$lbFactory
Abstract base class for update jobs that do something with some secondary data extracted from article...
Definition: DataUpdate.php:28
static newFromRow($row, $title=null)
Factory function, for constructing a Category object from a result set.
Definition: Category.php:173
static acquirePageLock(IDatabase $dbw, $pageId, $why= 'atomicity')
Acquire a lock for performing link table updates for a page on a DB.
Job queue task description base code.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk page
Definition: hooks.txt:2491
doUpdate()
Perform the actual work.
Update object handling the cleanup of links tables after a page was deleted.
const RC_LOG
Definition: Defines.php:138