UpdateTables.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates;
 
use DatabaseUpdater;
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia;
use FormatJson;
use ConfigException;
 
class UpdateTables {
    protected $updater;
 
    protected $base;
 
    public static function callback( $updater ) {
        $dir = dirname( dirname( dirname( __DIR__ ) ) );
        $handler = new static( $updater, $dir );
        return $handler->execute();
    }
 
    protected function __construct( $updater, $base ) {
        $this->updater = $updater;
        $this->base = $base;
    }
 
    protected function execute() {
        switch ( $this->updater->getDB()->getType() ) {
            case 'mysql':
            case 'sqlite':
                $this->updater->addExtensionTable( 'oathauth_users', "{$this->base}/sql/mysql/tables.sql" );
                $this->updater->addExtensionUpdate( [ [ $this, 'schemaUpdateOldUsersFromInstaller' ] ] );
                $this->updater->dropExtensionField(
                    'oathauth_users',
                    'secret_reset',
                    "{$this->base}/sql/mysql/patch-remove_reset.sql"
                );
                $this->updater->addExtensionField(
                    'oathauth_users',
                    'module',
                    "{$this->base}/sql/mysql/patch-add_generic_fields.sql"
                );
 
                $this->updater->addExtensionUpdate(
                    [ [ __CLASS__, 'schemaUpdateSubstituteForGenericFields' ] ]
                );
                $this->updater->dropExtensionField(
                    'oathauth_users',
                    'secret',
                    "{$this->base}/sql/mysql/patch-remove_module_specific_fields.sql"
                );
 
                $this->updater->addExtensionUpdate(
                    [ [ __CLASS__, 'schemaUpdateTOTPToMultipleKeys' ] ]
                );
 
                break;
 
            case 'oracle':
                $this->updater->addExtensionTable( 'oathauth_users', "{$this->base}/sql/oracle/tables.sql" );
                break;
 
            case 'postgres':
                $this->updater->addExtensionTable( 'oathauth_users', "{$this->base}/sql/postgres/tables.sql" );
                break;
        }
 
        return true;
    }
 
    public function schemaUpdateOldUsersFromInstaller( DatabaseUpdater $updater ) {
        global $wgOATHAuthDatabase;
        $lb = MediaWikiServices::getInstance()->getDBLoadBalancerFactory()
            ->getMainLB( $wgOATHAuthDatabase );
        $dbw = $lb->getConnectionRef( DB_MASTER, [], $wgOATHAuthDatabase );
        return self::schemaUpdateOldUsers( $dbw );
    }
 
    public static function schemaUpdateSubstituteForGenericFields( DatabaseUpdater $updater ) {
        global $wgOATHAuthDatabase;
        $lb = MediaWikiServices::getInstance()->getDBLoadBalancerFactory()
            ->getMainLB( $wgOATHAuthDatabase );
        $dbw = $lb->getConnectionRef( DB_MASTER, [], $wgOATHAuthDatabase );
        return self::convertToGenericFields( $dbw );
    }
 
    public static function schemaUpdateTOTPToMultipleKeys( DatabaseUpdater $updater ) {
        global $wgOATHAuthDatabase;
        $lb = MediaWikiServices::getInstance()->getDBLoadBalancerFactory()
            ->getMainLB( $wgOATHAuthDatabase );
        $dbw = $lb->getConnectionRef( DB_MASTER, [], $wgOATHAuthDatabase );
        return self::switchTOTPToMultipleKeys( $dbw );
    }
 
    public static function convertToGenericFields( IDatabase $db ) {
        if ( !$db->fieldExists( 'oathauth_users', 'secret' ) ) {
            return true;
        }
 
        $services = MediaWikiServices::getInstance();
        $batchSize = $services->getMainConfig()->get( 'UpdateRowsPerQuery' );
        $lbFactory = $services->getDBLoadBalancerFactory();
        while ( true ) {
            $lbFactory->waitForReplication();
 
            $res = $db->select(
                'oathauth_users',
                [ 'id', 'secret', 'scratch_tokens' ],
                [
                    'module' => '',
                    'data IS NULL',
                    'secret IS NOT NULL'
                ],
                __METHOD__,
                [ 'LIMIT' => $batchSize ]
            );
 
            if ( $res->numRows() === 0 ) {
                return true;
            }
 
            foreach ( $res as $row ) {
                $db->update(
                    'oathauth_users',
                    [
                        'module' => 'totp',
                        'data' => FormatJson::encode( [
                            'keys' => [ [
                                'secret' => $row->secret,
                                'scratch_tokens' => $row->scratch_tokens
                            ] ]
                        ] )
                    ],
                    [ 'id' => $row->id ],
                    __METHOD__
                );
            }
        }
 
        return true;
    }
 
    public static function switchTOTPToMultipleKeys( IDatabase $db ) {
        if ( !$db->fieldExists( 'oathauth_users', 'data' ) ) {
            return true;
        }
 
        $res = $db->select(
            'oathauth_users',
            [ 'id', 'data' ],
            [
                'module' => 'totp'
            ],
            __METHOD__
        );
 
        foreach ( $res as $row ) {
            $data = FormatJson::decode( $row->data, true );
            if ( isset( $data['keys'] ) ) {
                continue;
            }
            $db->update(
                'oathauth_users',
                [
                    'data' => FormatJson::encode( [
                        'keys' => [ $data ]
                    ] )
                ],
                [ 'id' => $row->id ],
                __METHOD__
            );
        }
 
        return true;
    }
 
    public static function schemaUpdateOldUsers( IDatabase $db ) {
        if ( !$db->fieldExists( 'oathauth_users', 'secret_reset' ) ) {
            return true;
        }
 
        $res = $db->select(
            'oathauth_users',
            [ 'id', 'scratch_tokens' ],
            [ 'is_validated != 0' ],
            __METHOD__
        );
 
        foreach ( $res as $row ) {
            Wikimedia\suppressWarnings();
            $scratchTokens = unserialize( base64_decode( $row->scratch_tokens ) );
            Wikimedia\restoreWarnings();
            if ( $scratchTokens ) {
                $db->update(
                    'oathauth_users',
                    [ 'scratch_tokens' => implode( ',', $scratchTokens ) ],
                    [ 'id' => $row->id ],
                    __METHOD__
                );
            }
        }
 
        // Remove rows from the table where user never completed the setup process
        $db->delete( 'oathauth_users', [ 'is_validated' => 0 ], __METHOD__ );
 
        return true;
    }
}