convertUserOptions.php

Go to the documentation of this file.

<?php
require_once __DIR__ . '/Maintenance.php';
 
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\IResultWrapper;
 
class ConvertUserOptions extends Maintenance {
 
    private $mConversionCount = 0;
 
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Convert user options from old to new system' );
        $this->setBatchSize( 50 );
    }
 
    public function execute() {
        $this->output( "...batch conversion of user_options: " );
        $id = 0;
        $dbw = $this->getDB( DB_MASTER );
 
        if ( !$dbw->fieldExists( 'user', 'user_options', __METHOD__ ) ) {
            $this->output( "nothing to migrate. " );
 
            return;
        }
        $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
        while ( $id !== null ) {
            $res = $dbw->select( 'user',
                [ 'user_id', 'user_options' ],
                [
                    'user_id > ' . $dbw->addQuotes( $id ),
                    "user_options != " . $dbw->addQuotes( '' ),
                ],
                __METHOD__,
                [
                    'ORDER BY' => 'user_id',
                    'LIMIT' => $this->getBatchSize(),
                ]
            );
            $id = $this->convertOptionBatch( $res, $dbw );
 
            $lbFactory->waitForReplication();
 
            if ( $id ) {
                $this->output( "--Converted to ID $id\n" );
            }
        }
        $this->output( "done. Converted " . $this->mConversionCount . " user records.\n" );
    }
 
    private function convertOptionBatch( $res, $dbw ) {
        $id = null;
        foreach ( $res as $row ) {
            $this->mConversionCount++;
            $insertRows = [];
            foreach ( explode( "\n", $row->user_options ) as $s ) {
                $m = [];
                if ( !preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
                    continue;
                }
 
                // MW < 1.16 would save even default values. Filter them out
                // here (as in User) to avoid adding many unnecessary rows.
                $defaultOption = User::getDefaultOption( $m[1] );
                if ( $defaultOption === null || $m[2] != $defaultOption ) {
                    $insertRows[] = [
                        'up_user' => $row->user_id,
                        'up_property' => $m[1],
                        'up_value' => $m[2],
                    ];
                }
            }
 
            if ( count( $insertRows ) ) {
                $dbw->insert( 'user_properties', $insertRows, __METHOD__, [ 'IGNORE' ] );
            }
 
            $dbw->update(
                'user',
                [ 'user_options' => '' ],
                [ 'user_id' => $row->user_id ],
                __METHOD__
            );
            $id = $row->user_id;
        }
 
        return $id;
    }
}
 
$maintClass = ConvertUserOptions::class;
require_once RUN_MAINTENANCE_IF_MAIN;