HCaptcha.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Extensions\ConfirmEdit\hCaptcha;
 
use ApiBase;
use CaptchaAuthenticationRequest;
use ConfirmEditHooks;
use FormatJson;
use Html;
use MediaWiki\Auth\AuthenticationRequest;
use Message;
use MWHttpRequest;
use RawMessage;
use SimpleCaptcha;
use Status;
use WebRequest;
 
class HCaptcha extends SimpleCaptcha {
    // used for hcaptcha-edit, hcaptcha-addurl, hcaptcha-badlogin, hcaptcha-createaccount,
    // hcaptcha-create, hcaptcha-sendemail via getMessage()
    protected static $messagePrefix = 'hcaptcha-';
 
    private $error;
 
    public function getFormInformation( $tabIndex = 1 ) {
        global $wgHCaptchaSiteKey;
 
        $output = Html::element( 'div', [
            'class' => [
                'h-captcha',
                'mw-confirmedit-captcha-fail' => (bool)$this->error,
            ],
            'data-sitekey' => $wgHCaptchaSiteKey
        ] );
 
        return [
            'html' => $output,
            'headitems' => [
                "<script src=\"https://hcaptcha.com/1/api.js\" async defer></script>"
            ]
        ];
    }
 
    protected function logCheckError( $info ) {
        if ( $info instanceof Status ) {
            $errors = $info->getErrorsArray();
            $error = $errors[0][0];
        } elseif ( is_array( $info ) ) {
            $error = implode( ',', $info );
        } else {
            $error = $info;
        }
 
        \wfDebugLog( 'captcha', 'Unable to validate response: ' . $error );
    }
 
    protected function getCaptchaParamsFromRequest( WebRequest $request ) {
        $response = $request->getVal( 'h-captcha-response' );
        return [ '', $response ];
    }
 
    protected function passCaptcha( $_, $token ) {
        global $wgRequest, $wgHCaptchaSecretKey, $wgHCaptchaSendRemoteIP;
 
        $url = 'https://hcaptcha.com/siteverify';
        $data = [
            'secret' => $wgHCaptchaSecretKey,
            'response' => $token,
        ];
        if ( $wgHCaptchaSendRemoteIP ) {
            $data['remoteip'] = $wgRequest->getIP();
        }
        $request = MWHttpRequest::factory(
            $url,
            [
                'method' => 'POST',
                'postData' => $data,
            ]
        );
        $status = $request->execute();
        if ( !$status->isOK() ) {
            $this->error = 'http';
            $this->logCheckError( $status );
            return false;
        }
        $response = FormatJson::decode( $request->getContent(), true );
        if ( !$response ) {
            $this->error = 'json';
            $this->logCheckError( $this->error );
            return false;
        }
        if ( isset( $response['error-codes'] ) ) {
            $this->error = 'hcaptcha-api';
            $this->logCheckError( $response['error-codes'] );
            return false;
        }
 
        return $response['success'];
    }
 
    protected function addCaptchaAPI( &$resultArr ) {
    }
 
    public function describeCaptchaType() {
        global $wgHCaptchaSiteKey;
        return [
            'type' => 'hcaptcha',
            'mime' => 'application/javascript',
            'key' => $wgHCaptchaSiteKey,
        ];
    }
 
    public function getMessage( $action ) {
        $msg = parent::getMessage( $action );
        if ( $this->error ) {
            $msg = new RawMessage( '<div class="error">$1</div>', [ $msg ] );
        }
        return $msg;
    }
 
    public function apiGetAllowedParams( ApiBase $module, &$params, $flags ) {
        return true;
    }
 
    public function getError() {
        return $this->error;
    }
 
    public function storeCaptcha( $info ) {
        return 'not used';
    }
 
    public function retrieveCaptcha( $index ) {
        // just pretend it worked
        return [ 'index' => $index ];
    }
 
    public function getCaptcha() {
        return [];
    }
 
    public function createAuthenticationRequest() {
        return new HCaptchaAuthenticationRequest();
    }
 
    public function onAuthChangeFormFields(
        array $requests, array $fieldInfo, array &$formDescriptor, $action
    ) {
        global $wgHCaptchaSiteKey;
 
        $req = AuthenticationRequest::getRequestByClass(
            $requests,
            CaptchaAuthenticationRequest::class,
            true
        );
        if ( !$req ) {
            return;
        }
 
        // ugly way to retrieve error information
        $captcha = ConfirmEditHooks::getInstance();
 
        $formDescriptor['captchaWord'] = [
            'class' => HTMLHCaptchaField::class,
            'key' => $wgHCaptchaSiteKey,
            'error' => $captcha->getError(),
        ] + $formDescriptor['captchaWord'];
    }
}