maintenance/populateLogUsertext.php

   1 <?php
   2 /**
   3  * Makes the required database updates for Special:ProtectedPages
   4  * to show all protected pages, even ones before the page restrictions
   5  * schema change. All remaining page_restriction column values are moved
   6  * to the new table.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  * @ingroup Maintenance
  25  */
  26
  27 require_once __DIR__ . '/Maintenance.php';
  28
  29 /**
  30  * Maintenance script that makes the required database updates for
  31  * Special:ProtectedPages to show all protected pages.
  32  *
  33  * @ingroup Maintenance
  34  */
  35 class PopulateLogUsertext extends LoggedUpdateMaintenance {
  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;