mediawiki-extensions-Confir.../includes/auth/CaptchaAuthenticationRequest.php
Daimona Eaytoy 7297235b2a Pass correct type to constructor
Although there was no docblock on CaptchaAuthenticationRequest::__construct,
the method is supposed to get a string and an array, as that's how the
class members are documented and used. Trying to access offsets of null
resulted in PHP notices on PHP 7.4, as seen in the experimental job
for various repos.

Bug: T239726
Change-Id: Idd073ebf3d560543ec225479de060e3c198847eb
2019-12-03 19:30:55 +00:00

97 lines
2.5 KiB
PHP

<?php
use MediaWiki\Auth\AuthenticationRequest;
use MediaWiki\Auth\AuthManager;
/**
* Generic captcha authentication request class. A captcha consist some data stored in the session
* (e.g. a question and its answer), an ID that references the data, and a solution.
*/
class CaptchaAuthenticationRequest extends AuthenticationRequest {
/** @var string Identifier of the captcha. Used internally to remember which captcha was used. */
public $captchaId;
/** @var array Information about the captcha (e.g. question text; solution). Exact semantics
* differ between types. */
public $captchaData;
/** @var string Captcha solution submitted by the user. */
public $captchaWord;
/**
* @param string $id
* @param array $data
*/
public function __construct( $id, $data ) {
$this->captchaId = $id;
$this->captchaData = $data;
}
public function loadFromSubmission( array $data ) {
$success = parent::loadFromSubmission( $data );
if ( $success ) {
// captchaId and captchaWord was set from the submission but captchaData was not.
$captcha = ConfirmEditHooks::getInstance();
$this->captchaData = $captcha->retrieveCaptcha( $this->captchaId );
if ( !$this->captchaData ) {
return false;
}
}
return $success;
}
/**
* @inheritDoc
* @suppress SecurityCheck-DoubleEscaped T202112
*/
public function getFieldInfo() {
$captcha = ConfirmEditHooks::getInstance();
// doesn't actually exist but *Captcha::getMessage will handle that
$action = 'generic';
switch ( $this->action ) {
case AuthManager::ACTION_LOGIN:
$action = 'badlogin';
break;
case AuthManager::ACTION_CREATE:
$action = 'createaccount';
break;
}
$fields = [
'captchaId' => [
'type' => 'hidden',
'value' => $this->captchaId,
'label' => wfMessage( 'captcha-id-label' ),
'help' => wfMessage( 'captcha-id-help' ),
],
'captchaInfo' => [
'type' => 'null',
'label' => $captcha->getMessage( $action ),
'value' => $captcha->getCaptchaInfo( $this->captchaData, $this->captchaId ),
'help' => wfMessage( 'captcha-info-help' ),
],
'captchaWord' => [
'type' => 'string',
'label' => wfMessage( 'captcha-label' ),
'help' => wfMessage( 'captcha-help' ),
],
];
return $fields;
}
public function getMetadata() {
$captcha = ConfirmEditHooks::getInstance();
return $captcha->describeCaptchaType();
}
public static function __set_state( $data ) {
$ret = new static( '', [] );
foreach ( $data as $k => $v ) {
$ret->$k = $v;
}
return $ret;
}
}