QuestyCaptcha.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Auth\AuthenticationRequest;
 
class QuestyCaptcha extends SimpleCaptcha {
    // used for questycaptcha-edit, questycaptcha-addurl, questycaptcha-badlogin,
    // questycaptcha-createaccount, questycaptcha-create, questycaptcha-sendemail via getMessage()
    protected static $messagePrefix = 'questycaptcha-';
 
    protected function keyMatch( $answer, $info ) {
        if ( is_array( $info['answer'] ) ) {
            return in_array( strtolower( $answer ), array_map( 'strtolower', $info['answer'] ) );
        } else {
            return strtolower( $answer ) == strtolower( $info['answer'] );
        }
    }
 
    protected function addCaptchaAPI( &$resultArr ) {
        $captcha = $this->getCaptcha();
        $index = $this->storeCaptcha( $captcha );
        $resultArr['captcha'] = $this->describeCaptchaType();
        $resultArr['captcha']['id'] = $index;
        $resultArr['captcha']['question'] = $captcha['question'];
    }
 
    public function describeCaptchaType() {
        return [
            'type' => 'question',
            'mime' => 'text/html',
        ];
    }
 
    public function getCaptcha() {
        global $wgCaptchaQuestions;
 
        // Backwards compatibility
        if ( $wgCaptchaQuestions === array_values( $wgCaptchaQuestions ) ) {
            return $wgCaptchaQuestions[ mt_rand( 0, count( $wgCaptchaQuestions ) - 1 ) ];
        }
 
        $question = array_rand( $wgCaptchaQuestions, 1 );
        $answer = $wgCaptchaQuestions[ $question ];
        return [ 'question' => $question, 'answer' => $answer ];
    }
 
    public function getFormInformation( $tabIndex = 1 ) {
        $captcha = $this->getCaptcha();
        if ( !$captcha ) {
            die(
                "No questions found; set some in LocalSettings.php using the format from QuestyCaptcha.php."
            );
        }
        $index = $this->storeCaptcha( $captcha );
        return [
            'html' => "<p><label for=\"wpCaptchaWord\">{$captcha['question']}</label> " .
                Html::element( 'input', [
                    'name' => 'wpCaptchaWord',
                    'id'   => 'wpCaptchaWord',
                    'class' => 'mw-ui-input',
                    'required',
                    'autocomplete' => 'off',
                    // tab in before the edit textarea
                    'tabindex' => $tabIndex ] ) .
                "</p>\n" .
                Xml::element( 'input', [
                    'type'  => 'hidden',
                    'name'  => 'wpCaptchaId',
                    'id'    => 'wpCaptchaId',
                    'value' => $index ] )
        ];
    }
 
    public function showHelp() {
        global $wgOut;
        $wgOut->setPageTitle( wfMessage( 'captchahelp-title' )->text() );
        $wgOut->addWikiMsg( 'questycaptchahelp-text' );
        if ( CaptchaStore::get()->cookiesNeeded() ) {
            $wgOut->addWikiMsg( 'captchahelp-cookies-needed' );
        }
    }
 
    public function getCaptchaInfo( $captchaData, $id ) {
        return $captchaData['question'];
    }
 
    public function onAuthChangeFormFields( array $requests, array $fieldInfo,
        array &$formDescriptor, $action ) {
        $req =
            AuthenticationRequest::getRequestByClass( $requests,
                CaptchaAuthenticationRequest::class, true );
        if ( !$req ) {
            return;
        }
 
        // declare RAW HTML output.
        $formDescriptor['captchaInfo']['raw'] = true;
        $formDescriptor['captchaWord']['label-message'] = null;
    }
}