MediaWiki  1.30.0
CaptchaAuthenticationRequest.php
Go to the documentation of this file.
1 <?php
2 
5 
12  public $captchaId;
13 
16  public $captchaData;
17 
19  public $captchaWord;
20 
21  public function __construct( $id, $data ) {
22  $this->captchaId = $id;
23  $this->captchaData = $data;
24  }
25 
26  public function loadFromSubmission( array $data ) {
27  $success = parent::loadFromSubmission( $data );
28  if ( $success ) {
29  // captchaId and captchaWord was set from the submission but captchaData was not.
30  $captcha = ConfirmEditHooks::getInstance();
31  $this->captchaData = $captcha->retrieveCaptcha( $this->captchaId );
32  if ( !$this->captchaData ) {
33  return false;
34  }
35  }
36  return $success;
37  }
38 
39  public function getFieldInfo() {
40  $captcha = ConfirmEditHooks::getInstance();
41 
42  $action = 'generic'; // doesn't actually exist but *Captcha::getMessage will handle that
43  switch ( $this->action ) {
44  case AuthManager::ACTION_LOGIN:
45  $action = 'badlogin';
46  break;
47  case AuthManager::ACTION_CREATE:
48  $action = 'createaccount';
49  break;
50  }
51 
52  $fields = [
53  'captchaId' => [
54  'type' => 'hidden',
55  'value' => $this->captchaId,
56  'label' => wfMessage( 'captcha-id-label' ),
57  'help' => wfMessage( 'captcha-id-help' ),
58  ],
59  'captchaInfo' => [
60  'type' => 'null',
61  'label' => $captcha->getMessage( $action ),
62  'value' => $captcha->getCaptchaInfo( $this->captchaData, $this->captchaId ),
63  'help' => wfMessage( 'captcha-info-help' ),
64  ],
65  'captchaWord' => [
66  'type' => 'string',
67  'label' => wfMessage( 'captcha-label' ),
68  'help' => wfMessage( 'captcha-help' ),
69  ],
70  ];
71 
72  return $fields;
73  }
74 
75  public function getMetadata() {
76  $captcha = ConfirmEditHooks::getInstance();
77  return $captcha->describeCaptchaType();
78  }
79 
80  public static function __set_state( $data ) {
81  $ret = new static( null, null );
82  foreach ( $data as $k => $v ) {
83  $ret->$k = $v;
84  }
85  return $ret;
86  }
87 }
CaptchaAuthenticationRequest\getMetadata
getMetadata()
Returns metadata about this request.
Definition: CaptchaAuthenticationRequest.php:75
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
ConfirmEditHooks\getInstance
static getInstance()
Get the global Captcha instance.
Definition: ConfirmEditHooks.php:13
$success
$success
Definition: NoLocalSettings.php:44
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
MediaWiki\Auth\AuthenticationRequest\$action
string null $action
The AuthManager::ACTION_* constant this request was created to be used for.
Definition: AuthenticationRequest.php:57
CaptchaAuthenticationRequest\$captchaData
array $captchaData
Information about the captcha (e.g.
Definition: CaptchaAuthenticationRequest.php:16
CaptchaAuthenticationRequest\$captchaId
string $captchaId
Identifier of the captcha.
Definition: CaptchaAuthenticationRequest.php:12
CaptchaAuthenticationRequest\__set_state
static __set_state( $data)
Implementing this mainly for use from the unit tests.
Definition: CaptchaAuthenticationRequest.php:80
captcha-old.action
action
Definition: captcha-old.py:212
CaptchaAuthenticationRequest\getFieldInfo
getFieldInfo()
Fetch input field info.
Definition: CaptchaAuthenticationRequest.php:39
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1965
CaptchaAuthenticationRequest\$captchaWord
string $captchaWord
Captcha solution submitted by the user.
Definition: CaptchaAuthenticationRequest.php:19
MediaWiki\Auth\AuthManager
This serves as the entry point to the authentication system.
Definition: AuthManager.php:82
CaptchaAuthenticationRequest\__construct
__construct( $id, $data)
Definition: CaptchaAuthenticationRequest.php:21
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
CaptchaAuthenticationRequest\loadFromSubmission
loadFromSubmission(array $data)
Initialize form submitted form data.
Definition: CaptchaAuthenticationRequest.php:26
MediaWiki\Auth\AuthenticationRequest
This is a value object for authentication requests.
Definition: AuthenticationRequest.php:37
array
the array() calling protocol came about after MediaWiki 1.4rc1.
CaptchaAuthenticationRequest
Generic captcha authentication request class.
Definition: CaptchaAuthenticationRequest.php:10