MediaWiki  1.34.4
ReCaptchaNoCaptcha Class Reference
Inheritance diagram for ReCaptchaNoCaptcha:
Collaboration diagram for ReCaptchaNoCaptcha:

Public Member Functions

 apiGetAllowedParams (&$module, &$params, $flags)
 
 createAuthenticationRequest ()
 
 describeCaptchaType ()
 
 getCaptcha ()
 Returns an array with 'question' and 'answer' keys. More...
 
 getCaptchaInfo ( $captchaData, $id)
 
 getError ()
 Return the error from the last passCaptcha* call. More...
 
 getFormInformation ( $tabIndex=1)
 Get the captcha form. More...
 
 getMessage ( $action)
 Show a message asking the user to enter a captcha on edit The result will be treated as wiki text. More...
 
 onAuthChangeFormFields (array $requests, array $fieldInfo, array &$formDescriptor, $action)
 
 retrieveCaptcha ( $index)
 Fetch this session's captcha info. More...
 
 storeCaptcha ( $info)
 Generate a captcha session ID and save the info in PHP's session storage. More...
 
- Public Member Functions inherited from SimpleCaptcha
 addFormInformationToOutput (OutputPage $out, array $formInformation)
 Processes the given $formInformation array and adds the options (see getFormInformation()) to the given OutputPage object. More...
 
 addFormToOutput (OutputPage $out, $tabIndex=1)
 Uses getFormInformation() to get the CAPTCHA form and adds it to the given OutputPage object. More...
 
 canSkipCaptcha ( $user, Config $config)
 Check whether the user provided / IP making the request is allowed to skip captchas. More...
 
 captchaTriggers ( $title, $action)
 
 clearCaptcha ( $index)
 Clear out existing captcha info from the session, to ensure it can't be reused. More...
 
 confirmEditMerged ( $context, $content, $status, $summary, $user, $minorEdit)
 An efficient edit filter callback based on the text after section merging. More...
 
 confirmEmailUser ( $from, $to, $subject, $text, &$error)
 Check the captcha on Special:EmailUser. More...
 
 editShowCaptcha ( $editPage)
 Insert the captcha prompt into an edit form. More...
 
 increaseBadLoginCounter ( $username)
 Increase bad login counter after a failed login. More...
 
 injectEmailUser (&$form)
 Inject whazawhoo @fixme if multiple thingies insert a header, could break. More...
 
 isBadLoginPerUserTriggered ( $u)
 Is the per-user captcha triggered? More...
 
 isBadLoginTriggered ()
 Check if a bad login has already been registered for this IP address. More...
 
 needCreateAccountCaptcha (User $creatingUser=null)
 Logic to check if we need to pass a captcha for the current user to create a new account, or not. More...
 
 passCaptchaFromRequest (WebRequest $request, User $user)
 Given a required captcha run, test form input for correct input on the open session. More...
 
 passCaptchaLimited ( $index, $word, User $user)
 Checks, if the user reached the amount of false CAPTCHAs and give him some vacation or run self::passCaptcha() and clear counter if correct. More...
 
 passCaptchaLimitedFromRequest (WebRequest $request, User $user)
 Checks, if the user reached the amount of false CAPTCHAs and give him some vacation or run self::passCaptcha() and clear counter if correct. More...
 
 resetBadLoginCounter ( $username)
 Reset bad login counter after a successful login. More...
 
 setAction ( $action)
 
 setTrigger ( $trigger)
 
 shouldCheck (WikiPage $page, $content, $section, $context, $oldtext=null)
 
 showEditFormFields (&$editPage, &$out)
 Show error message for missing or incorrect captcha on EditPage. More...
 
 showHelp ()
 Show a page explaining what this wacky thing is. More...
 
 triggersCaptcha ( $action, $title=null)
 Checks, whether the passed action should trigger a CAPTCHA. More...
 

Protected Member Functions

 addCaptchaAPI (&$resultArr)
 
 getCaptchaParamsFromRequest (WebRequest $request)
 
 logCheckError ( $info)
 
 passCaptcha ( $_, $word)
 Check, if the user solved the captcha. More...
 
- Protected Member Functions inherited from SimpleCaptcha
 isAPICaptchaModule ( $module)
 
 keyMatch ( $answer, $info)
 Check if the submitted form matches the captcha session data provided by the plugin when the form was generated. More...
 
 log ( $message)
 Log the status and any triggering info for debugging or statistics. More...
 

Static Protected Attributes

static $messagePrefix = 'renocaptcha-'
 
- Static Protected Attributes inherited from SimpleCaptcha
static $messagePrefix = 'captcha-'
 

Private Attributes

 $error = null
 

Additional Inherited Members

- Protected Attributes inherited from SimpleCaptcha
string $action
 Used to select the right message. More...
 
string $trigger
 Used in log messages. More...
 

Detailed Description

Definition at line 5 of file ReCaptchaNoCaptcha.php.

Member Function Documentation

◆ addCaptchaAPI()

ReCaptchaNoCaptcha::addCaptchaAPI ( $resultArr)
protected
Parameters
array&$resultArr

Reimplemented from SimpleCaptcha.

Definition at line 143 of file ReCaptchaNoCaptcha.php.

References $error, and describeCaptchaType().

◆ apiGetAllowedParams()

ReCaptchaNoCaptcha::apiGetAllowedParams ( $module,
$params,
  $flags 
)
Parameters
ApiBase&$module
array&$params
int$flags
Returns
bool

Reimplemented from SimpleCaptcha.

Definition at line 181 of file ReCaptchaNoCaptcha.php.

References SimpleCaptcha\isAPICaptchaModule(), and ApiBase\PARAM_HELP_MSG.

◆ createAuthenticationRequest()

ReCaptchaNoCaptcha::createAuthenticationRequest ( )
Returns
ReCaptchaNoCaptchaAuthenticationRequest

Reimplemented from SimpleCaptcha.

Definition at line 223 of file ReCaptchaNoCaptcha.php.

◆ describeCaptchaType()

ReCaptchaNoCaptcha::describeCaptchaType ( )
Returns
array

Reimplemented from SimpleCaptcha.

Definition at line 151 of file ReCaptchaNoCaptcha.php.

Referenced by addCaptchaAPI().

◆ getCaptcha()

ReCaptchaNoCaptcha::getCaptcha ( )

Returns an array with 'question' and 'answer' keys.

Subclasses might use different structure. Since MW 1.27 all subclasses must implement this method.

Returns
array

Reimplemented from SimpleCaptcha.

Definition at line 206 of file ReCaptchaNoCaptcha.php.

◆ getCaptchaInfo()

ReCaptchaNoCaptcha::getCaptchaInfo (   $captchaData,
  $id 
)
Parameters
array$captchaData
string$id
Returns
Message

Reimplemented from SimpleCaptcha.

Definition at line 216 of file ReCaptchaNoCaptcha.php.

References wfMessage().

◆ getCaptchaParamsFromRequest()

ReCaptchaNoCaptcha::getCaptchaParamsFromRequest ( WebRequest  $request)
protected
Parameters
WebRequest$request
Returns
array

Reimplemented from SimpleCaptcha.

Definition at line 83 of file ReCaptchaNoCaptcha.php.

References $response, and WebRequest\getVal().

◆ getError()

ReCaptchaNoCaptcha::getError ( )

Return the error from the last passCaptcha* call.

Not implemented but needed by some child classes.

Returns
mixed

Reimplemented from SimpleCaptcha.

Definition at line 191 of file ReCaptchaNoCaptcha.php.

References $error.

◆ getFormInformation()

ReCaptchaNoCaptcha::getFormInformation (   $tabIndex = 1)

Get the captcha form.

Parameters
int$tabIndex
Returns
array

Reimplemented from SimpleCaptcha.

Definition at line 17 of file ReCaptchaNoCaptcha.php.

References $lang, $wgLang, and Html\element().

◆ getMessage()

ReCaptchaNoCaptcha::getMessage (   $action)

Show a message asking the user to enter a captcha on edit The result will be treated as wiki text.

Parameters
string$actionAction being performed
Returns
Message

Reimplemented from SimpleCaptcha.

Definition at line 167 of file ReCaptchaNoCaptcha.php.

References SimpleCaptcha\$action.

◆ logCheckError()

ReCaptchaNoCaptcha::logCheckError (   $info)
protected
Parameters
Status | array | string$info

Definition at line 66 of file ReCaptchaNoCaptcha.php.

References $error, and wfDebugLog().

Referenced by passCaptcha().

◆ onAuthChangeFormFields()

ReCaptchaNoCaptcha::onAuthChangeFormFields ( array  $requests,
array  $fieldInfo,
array &  $formDescriptor,
  $action 
)
Parameters
array$requests
array$fieldInfo
array&$formDescriptor
string$action

Reimplemented from SimpleCaptcha.

Definition at line 233 of file ReCaptchaNoCaptcha.php.

References ConfirmEditHooks\getInstance().

◆ passCaptcha()

ReCaptchaNoCaptcha::passCaptcha (   $_,
  $word 
)
protected

Check, if the user solved the captcha.

Based on reference implementation: https://github.com/google/recaptcha#php

Parameters
mixed$_Not used (ReCaptcha v2 puts index and solution in a single string)
string$wordcaptcha solution
Returns
bool

Reimplemented from SimpleCaptcha.

Definition at line 105 of file ReCaptchaNoCaptcha.php.

References $response, $wgRequest, FormatJson\decode(), MWHttpRequest\factory(), logCheckError(), and wfAppendQuery().

◆ retrieveCaptcha()

ReCaptchaNoCaptcha::retrieveCaptcha (   $index)

Fetch this session's captcha info.

Parameters
string$index
Returns
array|false array of info, or false if missing

Reimplemented from SimpleCaptcha.

Definition at line 201 of file ReCaptchaNoCaptcha.php.

◆ storeCaptcha()

ReCaptchaNoCaptcha::storeCaptcha (   $info)

Generate a captcha session ID and save the info in PHP's session storage.

(Requires the user to have cookies enabled to get through the captcha.)

A random ID is used so legit users can make edits in multiple tabs or windows without being unnecessarily hobbled by a serial order requirement. Pass the returned id value into the edit form as wpCaptchaId.

Parameters
array$infodata to store
Returns
string captcha ID key

Reimplemented from SimpleCaptcha.

Definition at line 195 of file ReCaptchaNoCaptcha.php.

Member Data Documentation

◆ $error

ReCaptchaNoCaptcha::$error = null
private

Definition at line 10 of file ReCaptchaNoCaptcha.php.

Referenced by addCaptchaAPI(), getError(), and logCheckError().

◆ $messagePrefix

ReCaptchaNoCaptcha::$messagePrefix = 'renocaptcha-'
staticprotected

Definition at line 8 of file ReCaptchaNoCaptcha.php.


The documentation for this class was generated from the following file: