OATHAuthHooks.php

Go to the documentation of this file.

<?php
use MediaWiki\Auth\AuthenticationRequest;
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IDatabase;
 
class OATHAuthHooks {
    public static function getOATHUserRepository() {
        global $wgOATHAuthDatabase;
 
        static $service = null;
 
        if ( $service == null ) {
            $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
            $service = new OATHUserRepository(
                $factory->getMainLB( $wgOATHAuthDatabase ),
                new HashBagOStuff(
                    [
                        'maxKeys' => 5,
                    ]
                )
            );
        }
 
        return $service;
    }
 
    public static function onAuthChangeFormFields(
        array $requests, array $fieldInfo, array &$formDescriptor, $action
    ) {
        if ( isset( $fieldInfo['OATHToken'] ) ) {
            $formDescriptor['OATHToken'] += [
                'cssClass' => 'loginText',
                'id' => 'wpOATHToken',
                'size' => 20,
                'autofocus' => true,
                'persistent' => false,
                'autocomplete' => false,
                'spellcheck' => false,
            ];
        }
        return true;
    }
 
    public static function onTwoFactorIsEnabled( &$isEnabled ) {
        global $wgUser;
 
        $user = self::getOATHUserRepository()->findByUser( $wgUser );
        if ( $user && $user->getKey() !== null ) {
            $isEnabled = true;
            # This two-factor extension is enabled by the user,
            # we don't need to check others.
            return false;
        } else {
            $isEnabled = false;
            # This two-factor extension isn't enabled by the user,
            # but others may be.
            return true;
        }
    }
 
    public static function onGetPreferences( User $user, array &$preferences ) {
        $oathUser = self::getOATHUserRepository()->findByUser( $user );
 
        // If there is no existing key, and the user is not allowed to enable it,
        // we have nothing to show. (
        if ( $oathUser->getKey() === null && !$user->isAllowed( 'oathauth-enable' ) ) {
            return true;
        }
 
        $title = SpecialPage::getTitleFor( 'OATH' );
        $msg = $oathUser->getKey() !== null ? 'oathauth-disable' : 'oathauth-enable';
 
        $preferences[$msg] = [
            'type' => 'info',
            'raw' => 'true',
            'default' => Linker::link(
                $title,
                wfMessage( $msg )->escaped(),
                [],
                [ 'returnto' => SpecialPage::getTitleFor( 'Preferences' )->getPrefixedText() ]
            ),
            'label-message' => 'oathauth-prefs-label',
            'section' => 'personal/info', ];
 
        return true;
    }
 
    public static function onLoadExtensionSchemaUpdates( $updater ) {
        $base = dirname( __DIR__ );
        switch ( $updater->getDB()->getType() ) {
            case 'mysql':
            case 'sqlite':
                $updater->addExtensionTable( 'oathauth_users', "$base/sql/mysql/tables.sql" );
                $updater->addExtensionUpdate( [ [ __CLASS__, 'schemaUpdateOldUsersFromInstaller' ] ] );
                $updater->dropExtensionField(
                    'oathauth_users',
                    'secret_reset',
                    "$base/sql/mysql/patch-remove_reset.sql"
                );
                break;
 
            case 'oracle':
                $updater->addExtensionTable( 'oathauth_users', "$base/sql/oracle/tables.sql" );
                break;
 
            case 'postgres':
                $updater->addExtensionTable( 'oathauth_users', "$base/sql/postgres/tables.sql" );
                break;
        }
 
        return true;
    }
 
    public static function schemaUpdateOldUsersFromInstaller( DatabaseUpdater $updater ) {
        return self::schemaUpdateOldUsers( $updater->getDB() );
    }
 
    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;
    }
}