MediaWiki  master
populateRecentChangesSource.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
27 
35  public function __construct() {
36  parent::__construct();
37  $this->addDescription(
38  'Populates rc_source field of the recentchanges table with the data in rc_type.' );
39  $this->setBatchSize( 100 );
40  }
41 
42  protected function doDBUpdates() {
43  $dbw = $this->getDB( DB_PRIMARY );
44  $batchSize = $this->getBatchSize();
45  if ( !$dbw->fieldExists( 'recentchanges', 'rc_source', __METHOD__ ) ) {
46  $this->error( 'rc_source field in recentchanges table does not exist.' );
47  }
48 
49  $start = $dbw->selectField( 'recentchanges', 'MIN(rc_id)', '', __METHOD__ );
50  if ( !$start ) {
51  $this->output( "Nothing to do.\n" );
52 
53  return true;
54  }
55  $end = $dbw->selectField( 'recentchanges', 'MAX(rc_id)', '', __METHOD__ );
56  $end += $batchSize - 1;
57  $blockStart = $start;
58  $blockEnd = $start + $batchSize - 1;
59 
60  $updatedValues = $this->buildUpdateCondition( $dbw );
61 
62  while ( $blockEnd <= $end ) {
63  $dbw->update(
64  'recentchanges',
65  [ $updatedValues ],
66  [
67  "rc_source = ''",
68  "rc_id BETWEEN " . (int)$blockStart . " AND " . (int)$blockEnd
69  ],
70  __METHOD__
71  );
72 
73  $this->output( "." );
74  $this->waitForReplication();
75 
76  $blockStart += $batchSize;
77  $blockEnd += $batchSize;
78  }
79 
80  $this->output( "\nDone.\n" );
81  }
82 
83  protected function getUpdateKey() {
84  return __CLASS__;
85  }
86 
87  protected function buildUpdateCondition( IDatabase $dbw ) {
88  $rcNew = $dbw->addQuotes( RC_NEW );
89  $rcSrcNew = $dbw->addQuotes( RecentChange::SRC_NEW );
90  $rcEdit = $dbw->addQuotes( RC_EDIT );
91  $rcSrcEdit = $dbw->addQuotes( RecentChange::SRC_EDIT );
92  $rcLog = $dbw->addQuotes( RC_LOG );
93  $rcSrcLog = $dbw->addQuotes( RecentChange::SRC_LOG );
94  $rcExternal = $dbw->addQuotes( RC_EXTERNAL );
95  $rcSrcExternal = $dbw->addQuotes( RecentChange::SRC_EXTERNAL );
96 
97  return "rc_source = CASE
98  WHEN rc_type = $rcNew THEN $rcSrcNew
99  WHEN rc_type = $rcEdit THEN $rcSrcEdit
100  WHEN rc_type = $rcLog THEN $rcSrcLog
101  WHEN rc_type = $rcExternal THEN $rcSrcExternal
102  ELSE ''
103  END";
104  }
105 }
106 
107 $maintClass = PopulateRecentChangesSource::class;
108 require_once RUN_MAINTENANCE_IF_MAIN;
const RC_NEW
Definition: Defines.php:117
const RC_LOG
Definition: Defines.php:118
const RC_EXTERNAL
Definition: Defines.php:119
const RC_EDIT
Definition: Defines.php:116
Class for scripts that perform database maintenance and want to log the update in updatelog so we can...
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.
error( $err, $die=0)
Throw an error to the user.
output( $out, $channel=null)
Throw some output to the user.
waitForReplication()
Wait for replica DBs to catch up.
getBatchSize()
Returns batch size.
addDescription( $text)
Set the description text.
setBatchSize( $s=0)
Maintenance script to populate the rc_source field.
getUpdateKey()
Get the update key name to go in the update log table.
const SRC_EXTERNAL
addQuotes( $s)
Escape and quote a raw value string for use in a SQL query.
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:40
const DB_PRIMARY
Definition: defines.php:28