MediaWiki  master
populateLogUsertext.php
Go to the documentation of this file.
1 <?php
27 require_once __DIR__ . '/Maintenance.php';
28 
36  public function __construct() {
37  parent::__construct();
38  $this->addDescription( 'Populates the log_user_text field' );
39  $this->setBatchSize( 100 );
40  }
41 
42  protected function getUpdateKey() {
43  return 'populate log_usertext';
44  }
45 
46  protected function updateSkippedMessage() {
47  return 'log_user_text column of logging table already populated.';
48  }
49 
50  protected function doDBUpdates() {
51  $batchSize = $this->getBatchSize();
52  $db = $this->getDB( DB_MASTER );
53  $start = $db->selectField( 'logging', 'MIN(log_id)', '', __METHOD__ );
54  if ( !$start ) {
55  $this->output( "Nothing to do.\n" );
56 
57  return true;
58  }
59  $end = $db->selectField( 'logging', 'MAX(log_id)', '', __METHOD__ );
60 
61  // If this is being run during an upgrade from 1.16 or earlier, this
62  // will be run before the actor table change and should continue. But
63  // if it's being run on a new installation, the field won't exist to be populated.
64  if ( !$db->fieldInfo( 'logging', 'log_user_text' ) ) {
65  $this->output( "No log_user_text field, nothing to do.\n" );
66  return true;
67  }
68 
69  # Do remaining chunk
70  $end += $batchSize - 1;
71  $blockStart = $start;
72  $blockEnd = $start + $batchSize - 1;
73  while ( $blockEnd <= $end ) {
74  $this->output( "...doing log_id from $blockStart to $blockEnd\n" );
75  $cond = "log_id BETWEEN " . (int)$blockStart . " AND " . (int)$blockEnd .
76  " AND log_user = user_id";
77  $res = $db->select( [ 'logging', 'user' ],
78  [ 'log_id', 'user_name' ], $cond, __METHOD__ );
79 
80  $this->beginTransaction( $db, __METHOD__ );
81  foreach ( $res as $row ) {
82  $db->update( 'logging', [ 'log_user_text' => $row->user_name ],
83  [ 'log_id' => $row->log_id ], __METHOD__ );
84  }
85  $this->commitTransaction( $db, __METHOD__ );
86  $blockStart += $batchSize;
87  $blockEnd += $batchSize;
88  }
89  $this->output( "Done populating log_user_text field.\n" );
90 
91  return true;
92  }
93 }
94 
95 $maintClass = PopulateLogUsertext::class;
96 require_once RUN_MAINTENANCE_IF_MAIN;
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
const RUN_MAINTENANCE_IF_MAIN
Definition: Maintenance.php:39
Maintenance script that makes the required database updates for Special:ProtectedPages to show all pr...
setBatchSize( $s=0)
Set the batch size.
const DB_MASTER
Definition: defines.php:26
addDescription( $text)
Set the description text.
output( $out, $channel=null)
Throw some output to the user.
Class for scripts that perform database maintenance and want to log the update in updatelog so we can...
getBatchSize()
Returns batch size.
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.