Add maintenance script to populate page,revision,archive.*_content_* fields

Bug: T103388
Co-Authored-By: Roan Kattouw <roan.kattouw@gmail.com>
Change-Id: I65ab629d25c394751c05ce6b5c1a27464893896d

diff --git a/maintenance/populateContentModel.php b/maintenance/populateContentModel.php
new file mode 100644 (file)
index 0000000..3f5d6b6
--- /dev/null
+++ b/maintenance/populateContentModel.php
@@ -0,0 +1,207 @@
+<?php
+/**
+ * Populate the page_content_model and {rev,ar}_content_{model,format} fields.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Maintenance
+ */
+
+require_once __DIR__ . '/Maintenance.php';
+
+/**
+ * Usage:
+ *  populateContentModel.php --ns=1 --table=page
+ */
+class PopulateContentModel extends Maintenance {
+       public function __construct() {
+               parent::__construct();
+               $this->mDescription = 'Populate the various content_* fields';
+               $this->addOption( 'ns', 'Namespace to run in, or "all" for all namespaces', true, true );
+               $this->addOption( 'table', 'Table to run in', true, true );
+               $this->setBatchSize( 100 );
+       }
+
+       public function execute() {
+               $dbw = wfGetDB( DB_MASTER );
+               $ns = $this->getOption( 'ns' );
+               if ( !ctype_digit( $ns ) && $ns !== 'all' ) {
+                       $this->error( 'Invalid namespace', 1 );
+               }
+               $ns = $ns === 'all' ? 'all' : (int)$ns;
+               $table = $this->getOption( 'table' );
+               switch ( $table ) {
+                       case 'revision':
+                       case 'archive':
+                               $this->populateRevisionOrArchive( $dbw, $table, $ns );
+                               break;
+                       case 'page':
+                               $this->populatePage( $dbw, $ns );
+                               break;
+                       default:
+                               $this->error( "Invalid table name: $table", 1 );
+               }
+       }
+
+       private function updatePageRows( DatabaseBase $dbw, $pageIds, $model ) {
+               $count = count( $pageIds );
+               $this->output( "Setting $count rows to $model..." );
+               $dbw->update(
+                       'page',
+                       array( 'page_content_model' => $model ),
+                       array( 'page_id' => $pageIds ),
+                       __METHOD__
+               );
+               wfWaitForSlaves();
+               $this->output( "done.\n" );
+       }
+
+       protected function populatePage( DatabaseBase $dbw, $ns ) {
+               $toSave = array();
+               $lastId = 0;
+               $nsCondition = $ns === 'all' ? array() : array( 'page_namespace' => $ns );
+               do {
+                       $rows = $dbw->select(
+                               'page',
+                               array( 'page_namespace', 'page_title', 'page_id' ),
+                               array(
+                                       'page_content_model' => null,
+                                       'page_id > ' . $dbw->addQuotes( $lastId ),
+                               ) + $nsCondition,
+                               __METHOD__,
+                               array( 'LIMIT' => $this->mBatchSize, 'ORDER BY' => 'page_id ASC' )
+                       );
+                       $this->output( "Fetched {$rows->numRows()} rows.\n" );
+                       foreach ( $rows as $row ) {
+                               $title = Title::newFromRow( $row );
+                               $model = ContentHandler::getDefaultModelFor( $title );
+                               $toSave[$model][] = $row->page_id;
+                               if ( count( $toSave[$model] ) >= $this->mBatchSize ) {
+                                       $this->updatePageRows( $dbw, $toSave[$model], $model );
+                                       unset( $toSave[$model] );
+                               }
+                               $lastId = $row->page_id;
+                       }
+               } while ( $rows->numRows() >= $this->mBatchSize );
+               foreach ( $toSave as $model => $pages ) {
+                       $this->updatePageRows( $dbw, $pages, $model );
+               }
+       }
+
+       private function updateRevisionOrArchiveRows( DatabaseBase $dbw, $ids, $model, $table ) {
+               $prefix = $table === 'archive' ? 'ar' : 'rev';
+               $model_column = "{$prefix}_content_model";
+               $format_column = "{$prefix}_content_format";
+               $key = "{$prefix}_id";
+
+               $count = count( $ids );
+               $format = ContentHandler::getForModelID( $model )->getDefaultFormat();
+               $this->output( "Setting $count rows to $model / $format..." );
+               $dbw->update(
+                       $table,
+                       array( $model_column => $model, $format_column => $format ),
+                       array( $key => $ids ),
+                       __METHOD__
+               );
+               $this->output( "done.\n" );
+       }
+
+       protected function populateRevisionOrArchive( DatabaseBase $dbw, $table, $ns ) {
+               $prefix = $table === 'archive' ? 'ar' : 'rev';
+               $model_column = "{$prefix}_content_model";
+               $format_column = "{$prefix}_content_format";
+               $key = "{$prefix}_id";
+               if ( $table === 'archive' ) {
+                       $selectTables = 'archive';
+                       $fields = array( 'ar_namespace', 'ar_title' );
+                       $join_conds = array();
+                       $where = $ns === 'all' ? array() : array( 'ar_namespace' => $ns );
+               } else { // revision
+                       $selectTables = array( 'revision', 'page' );
+                       $fields = array( 'page_title', 'page_namespace' );
+                       $join_conds = array( 'page' => array( 'INNER JOIN', 'rev_page=page_id' ) );
+                       $where = $ns === 'all' ? array() : array( 'page_namespace' => $ns );
+               }
+
+               $toSave = array();
+               $lastId = 0;
+               do {
+                       $rows = $dbw->select(
+                               $selectTables,
+                               array_merge( $fields, array( $model_column, $format_column, $key ) ),
+                               // @todo support populating format if model is already set
+                               array(
+                                       $model_column => null,
+                                       "$key > " . $dbw->addQuotes( $lastId ),
+                               ) + $where,
+                               __METHOD__,
+                               array( 'LIMIT' => $this->mBatchSize, 'ORDER BY' => "$key ASC" ),
+                               $join_conds
+                       );
+                       $this->output( "Fetched {$rows->numRows()} rows.\n" );
+                       foreach ( $rows as $row ) {
+                               if ( $table === 'archive' ) {
+                                       $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
+                               } else {
+                                       $title = Title::newFromRow( $row );
+                               }
+                               $lastId = $row->{$key};
+                               try {
+                                       $handler = ContentHandler::getForTitle( $title );
+                               } catch ( MWException $e ) {
+                                       $this->error( "Invalid content model for $title" );
+                                       continue;
+                               }
+                               $defaultModel = $handler->getModelID();
+                               $defaultFormat = $handler->getDefaultFormat();
+                               $dbModel = $row->{$model_column};
+                               $dbFormat = $row->{$format_column};
+                               $id = $row->{$key};
+                               if ( $dbModel === null && $dbFormat === null ) {
+                                       // Set the defaults
+                                       $toSave[$defaultModel][] = $row->{$key};
+                               } else { // $dbModel === null, $dbFormat set.
+                                       if ( $dbFormat === $defaultFormat ) {
+                                               $toSave[$defaultModel][] = $row->{$key};
+                                       } else { // non-default format, just update now
+                                               $this->output( "Updating model to match format for $table $id of $title... ");
+                                               $dbw->update(
+                                                       $table,
+                                                       array( $model_column => $defaultModel ),
+                                                       array( $key => $id ),
+                                                       __METHOD__
+                                               );
+                                               wfWaitForSlaves();
+                                               $this->output( "done.\n" );
+                                               continue;
+                                       }
+                               }
+
+                               if ( count( $toSave[$defaultModel] ) >= $this->mBatchSize ) {
+                                       $this->updateRevisionOrArchiveRows( $dbw, $toSave[$defaultModel], $defaultModel, $table );
+                                       unset( $toSave[$defaultModel] );
+                               }
+                       }
+               } while ( $rows->numRows() >= $this->mBatchSize );
+               foreach ( $toSave as $model => $ids ) {
+                       $this->updateRevisionOrArchiveRows( $dbw, $ids, $model, $table );
+               }
+       }
+}
+
+$maintClass = 'PopulateContentModel';
+require_once RUN_MAINTENANCE_IF_MAIN;