MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / extensions / ConfirmEdit / includes / auth / CaptchaAuthenticationRequest.php

diff --git a/extensions/ConfirmEdit/includes/auth/CaptchaAuthenticationRequest.php b/extensions/ConfirmEdit/includes/auth/CaptchaAuthenticationRequest.php
new file mode 100644 (file)
index 0000000..d5d6e5a
--- /dev/null
+++ b/extensions/ConfirmEdit/includes/auth/CaptchaAuthenticationRequest.php
@@ -0,0 +1,87 @@
+<?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;
+
+       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;
+       }
+
+       public function getFieldInfo() {
+               $captcha = ConfirmEditHooks::getInstance();
+
+               $action = 'generic'; // doesn't actually exist but *Captcha::getMessage will handle that
+               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( null, null );
+               foreach ( $data as $k => $v ) {
+                       $ret->$k = $v;
+               }
+               return $ret;
+       }
+}