Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 5
CRAP
0.00% covered (danger)
0.00%
0 / 102
PopulateRevisionLength
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 5
272
0.00% covered (danger)
0.00%
0 / 99
 __construct
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 4
 getUpdateKey
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 2
 doDBUpdates
0.00% covered (danger)
0.00%
0 / 1
20
0.00% covered (danger)
0.00%
0 / 28
 doLenUpdates
0.00% covered (danger)
0.00%
0 / 1
56
0.00% covered (danger)
0.00%
0 / 46
 upgradeRow
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 19
<?php
/**
 * Populates the rev_len and ar_len fields when they are NULL.
 *
 * 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
 */
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IDatabase;
require_once __DIR__ . '/Maintenance.php';
/**
 * Maintenance script that populates the rev_len and ar_len fields when they are NULL.
 * This is the case for all revisions created before MW 1.10, as well as those affected
 * by T18748 (MW 1.10-1.13) and those affected by T135414 (MW 1.21-1.24).
 *
 * @ingroup Maintenance
 */
class PopulateRevisionLength extends LoggedUpdateMaintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Populates the rev_len and ar_len fields' );
        $this->setBatchSize( 200 );
    }
    protected function getUpdateKey() {
        return 'populate rev_len and ar_len';
    }
    public function doDBUpdates() {
        $dbw = $this->getDB( DB_MASTER );
        if ( !$dbw->tableExists( 'revision', __METHOD__ ) ) {
            $this->fatalError( "revision table does not exist" );
        } elseif ( !$dbw->tableExists( 'archive', __METHOD__ ) ) {
            $this->fatalError( "archive table does not exist" );
        } elseif ( !$dbw->fieldExists( 'revision', 'rev_len', __METHOD__ ) ) {
            $this->output( "rev_len column does not exist\n\n", true );
            return false;
        }
        $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
        $this->output( "Populating rev_len column\n" );
        $rev = $this->doLenUpdates(
            'revision',
            'rev_id',
            'rev',
            $revisionStore->getQueryInfo()
        );
        $this->output( "Populating ar_len column\n" );
        $ar = $this->doLenUpdates(
            'archive',
            'ar_id',
            'ar',
            $revisionStore->getArchiveQueryInfo()
        );
        $this->output( "rev_len and ar_len population complete "
            . "[$rev revision rows, $ar archive rows].\n" );
        return true;
    }
    /**
     * @param string $table
     * @param string $idCol
     * @param string $prefix
     * @param array $queryInfo
     * @return int
     */
    protected function doLenUpdates( $table, $idCol, $prefix, $queryInfo ) {
        $dbr = $this->getDB( DB_REPLICA );
        $dbw = $this->getDB( DB_MASTER );
        $batchSize = $this->getBatchSize();
        $start = $dbw->selectField( $table, "MIN($idCol)", '', __METHOD__ );
        $end = $dbw->selectField( $table, "MAX($idCol)", '', __METHOD__ );
        if ( !$start || !$end ) {
            $this->output( "...$table table seems to be empty.\n" );
            return 0;
        }
        # Do remaining chunks
        $blockStart = intval( $start );
        $blockEnd = intval( $start ) + $batchSize - 1;
        $count = 0;
        while ( $blockStart <= $end ) {
            $this->output( "...doing $idCol from $blockStart to $blockEnd\n" );
            $res = $dbr->select(
                $queryInfo['tables'],
                $queryInfo['fields'],
                [
                    "$idCol >= $blockStart",
                    "$idCol <= $blockEnd",
                    $dbr->makeList( [
                        "{$prefix}_len IS NULL",
                        $dbr->makeList( [
                            "{$prefix}_len = 0",
                            // sha1( "" )
                            "{$prefix}_sha1 != " . $dbr->addQuotes( 'phoiac9h4m842xq45sp7s6u21eteeq1' ),
                        ], IDatabase::LIST_AND )
                    ], IDatabase::LIST_OR )
                ],
                __METHOD__,
                [],
                $queryInfo['joins']
            );
            if ( $res->numRows() > 0 ) {
                $this->beginTransaction( $dbw, __METHOD__ );
                # Go through and update rev_len from these rows.
                foreach ( $res as $row ) {
                    if ( $this->upgradeRow( $row, $table, $idCol, $prefix ) ) {
                        $count++;
                    }
                }
                $this->commitTransaction( $dbw, __METHOD__ );
            }
            $blockStart += $batchSize;
            $blockEnd += $batchSize;
        }
        return $count;
    }
    /**
     * @param stdClass $row
     * @param string $table
     * @param string $idCol
     * @param string $prefix
     * @return bool
     */
    protected function upgradeRow( $row, $table, $idCol, $prefix ) {
        $dbw = $this->getDB( DB_MASTER );
        $revFactory = MediaWikiServices::getInstance()->getRevisionFactory();
        if ( $table === 'archive' ) {
            $revRecord = $revFactory->newRevisionFromArchiveRow( $row );
        } else {
            $revRecord = $revFactory->newRevisionFromRow( $row );
        }
        if ( !$revRecord ) {
            # This should not happen, but sometimes does (T22757)
            $id = $row->$idCol;
            $this->output( "RevisionRecord of $table $id unavailable!\n" );
            return false;
        }
        # Update the row...
        $dbw->update( $table,
            [ "{$prefix}_len" => $revRecord->getSize() ],
            [ $idCol => $row->$idCol ],
            __METHOD__
        );
        return true;
    }
}
$maintClass = PopulateRevisionLength::class;
require_once RUN_MAINTENANCE_IF_MAIN;