updateRestrictions.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Maintenance;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
class UpdateRestrictions extends LoggedUpdateMaintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Updates page_restrictions table from old page_restriction column' );
        $this->setBatchSize( 1000 );
    }
 
    public function doDBUpdates() {
        $dbw = $this->getDB( DB_PRIMARY );
        $batchSize = $this->getBatchSize();
 
        if ( !$dbw->tableExists( 'page_restrictions', __METHOD__ ) ) {
            $this->fatalError( "page_restrictions table does not exist" );
        }
 
        if ( !$dbw->fieldExists( 'page', 'page_restrictions', __METHOD__ ) ) {
            $this->output( "Migration is not needed.\n" );
            return true;
        }
 
        $encodedExpiry = $dbw->getInfinity();
 
        $maxPageId = $dbw->newSelectQueryBuilder()
            ->select( 'MAX(page_id)' )
            ->from( 'page' )
            ->caller( __METHOD__ )->fetchField();
 
        $batchMinPageId = 0;
 
        do {
            $batchMaxPageId = $batchMinPageId + $batchSize;
 
            $this->output( "...processing page IDs from $batchMinPageId to $batchMaxPageId.\n" );
 
            $res = $dbw->newSelectQueryBuilder()
                ->select( [ 'page_id', 'page_restrictions' ] )
                ->from( 'page' )
                ->where( [
                    $dbw->expr( 'page_restrictions', '!=', '' ),
                    $dbw->expr( 'page_id', '>', $batchMinPageId ),
                    $dbw->expr( 'page_id', '<=', $batchMaxPageId ),
                ] )
                ->caller( __METHOD__ )->fetchResultSet();
 
            // No pages have legacy protection settings in the current batch
            if ( !$res->numRows() ) {
                $batchMinPageId = $batchMaxPageId;
                continue;
            }
 
            $batch = [];
            $pageIds = [];
 
            foreach ( $res as $row ) {
                $pageIds[] = $row->page_id;
 
                $restrictionsByAction = $this->mapLegacyRestrictionBlob( $row->page_restrictions );
 
                # Update restrictions table
                foreach ( $restrictionsByAction as $action => $restrictions ) {
                    $batch[] = [
                        'pr_page' => $row->page_id,
                        'pr_type' => $action,
                        'pr_level' => $restrictions,
                        'pr_cascade' => 0,
                        'pr_expiry' => $encodedExpiry
                    ];
                }
            }
 
            $this->beginTransactionRound( __METHOD__ );
 
            // Insert new format protection settings for the pages in the current batch.
            // Use INSERT IGNORE to ignore conflicts with new format settings that might exist for the page
            $dbw->newInsertQueryBuilder()
                ->insertInto( 'page_restrictions' )
                ->ignore()
                ->rows( $batch )
                ->caller( __METHOD__ )->execute();
 
            // Clear out the legacy page.page_restrictions blob for this batch
            $dbw->newUpdateQueryBuilder()
                ->update( 'page' )
                ->set( [ 'page_restrictions' => '' ] )
                ->where( [ 'page_id' => $pageIds ] )
                ->caller( __METHOD__ )
                ->execute();
 
            $this->commitTransactionRound( __METHOD__ );
 
            $batchMinPageId = $batchMaxPageId;
        } while ( $batchMaxPageId < $maxPageId );
 
        $this->output( "...Done!\n" );
        return true;
    }
 
    private function mapLegacyRestrictionBlob( $legacyBlob ) {
        $oldRestrictions = [];
 
        foreach ( explode( ':', trim( $legacyBlob ) ) as $restrict ) {
            $temp = explode( '=', trim( $restrict ) );
 
            // Treat old old format without action name as edit/move restriction
            if ( count( $temp ) == 1 ) {
                $level = trim( $temp[0] );
 
                $oldRestrictions['edit'] = $level;
                $oldRestrictions['move'] = $level;
            } else {
                $restriction = trim( $temp[1] );
                // Some old entries are empty
                if ( $restriction != '' ) {
                    $oldRestrictions[$temp[0]] = $restriction;
                }
            }
        }
 
        return $oldRestrictions;
    }
 
    protected function getUpdateKey() {
        return __CLASS__;
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = UpdateRestrictions::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd