MediaWiki  1.33.0
ReCaptchaNoCaptcha.php
Go to the documentation of this file.
1 <?php
2 
4 
5 class ReCaptchaNoCaptcha extends SimpleCaptcha {
6  // used for renocaptcha-edit, renocaptcha-addurl, renocaptcha-badlogin, renocaptcha-createaccount,
7  // renocaptcha-create, renocaptcha-sendemail via getMessage()
8  protected static $messagePrefix = 'renocaptcha-';
9 
10  private $error = null;
16  public function getFormInformation( $tabIndex = 1 ) {
17  global $wgReCaptchaSiteKey, $wgLang;
18  $lang = htmlspecialchars( urlencode( $wgLang->getCode() ) );
19 
20  $output = Html::element( 'div', [
21  'class' => [
22  'g-recaptcha',
23  'mw-confirmedit-captcha-fail' => (bool)$this->error,
24  ],
25  'data-sitekey' => $wgReCaptchaSiteKey
26  ] );
27  $htmlUrlencoded = htmlspecialchars( urlencode( $wgReCaptchaSiteKey ) );
28  $output .= <<<HTML
29 <noscript>
30  <div>
31  <div style="width: 302px; height: 422px; position: relative;">
32  <div style="width: 302px; height: 422px; position: absolute;">
33  <iframe src="https://www.google.com/recaptcha/api/fallback?k={$htmlUrlencoded}&hl={$lang}"
34  frameborder="0" scrolling="no"
35  style="width: 302px; height:422px; border-style: none;">
36  </iframe>
37  </div>
38  </div>
39  <div style="width: 300px; height: 60px; border-style: none;
40  bottom: 12px; left: 25px; margin: 0px; padding: 0px; right: 25px;
41  background: #f9f9f9; border: 1px solid #c1c1c1; border-radius: 3px;">
42  <textarea id="g-recaptcha-response" name="g-recaptcha-response"
43  class="g-recaptcha-response"
44  style="width: 250px; height: 40px; border: 1px solid #c1c1c1;
45  margin: 10px 25px; padding: 0px; resize: none;" >
46  </textarea>
47  </div>
48  </div>
49 </noscript>
50 HTML;
51  return [
52  'html' => $output,
53  'headitems' => [
54  // Insert reCAPTCHA script, in display language, if available.
55  // Language falls back to the browser's display language.
56  // See https://developers.google.com/recaptcha/docs/faq
57  "<script src=\"https://www.google.com/recaptcha/api.js?hl={$lang}\" async defer></script>"
58  ]
59  ];
60  }
61 
65  protected function logCheckError( $info ) {
66  if ( $info instanceof Status ) {
67  $errors = $info->getErrorsArray();
68  $error = $errors[0][0];
69  } elseif ( is_array( $info ) ) {
70  $error = implode( ',', $info );
71  } else {
72  $error = $info;
73  }
74 
75  wfDebugLog( 'captcha', 'Unable to validate response: ' . $error );
76  }
77 
82  protected function getCaptchaParamsFromRequest( WebRequest $request ) {
83  // ReCaptchaNoCaptcha combines captcha ID + solution into a single value
84  // API is hardwired to return captchaWord, so use that if the standard isempty
85  // "captchaWord" is sent as "captchaword" by visual editor
86  $index = 'not used';
87  $response = $request->getVal( 'g-recaptcha-response',
88  $request->getVal( 'captchaWord',
89  $request->getVal( 'captchaword' )
90  ) );
91  return [ $index, $response ];
92  }
93 
104  protected function passCaptcha( $_, $word ) {
105  global $wgRequest, $wgReCaptchaSecretKey, $wgReCaptchaSendRemoteIP;
106 
107  $url = 'https://www.google.com/recaptcha/api/siteverify';
108  // Build data to append to request
109  $data = [
110  'secret' => $wgReCaptchaSecretKey,
111  'response' => $word,
112  ];
113  if ( $wgReCaptchaSendRemoteIP ) {
114  $data['remoteip'] = $wgRequest->getIP();
115  }
116  $url = wfAppendQuery( $url, $data );
117  $request = MWHttpRequest::factory( $url, [ 'method' => 'GET' ] );
118  $status = $request->execute();
119  if ( !$status->isOK() ) {
120  $this->error = 'http';
121  $this->logCheckError( $status );
122  return false;
123  }
124  $response = FormatJson::decode( $request->getContent(), true );
125  if ( !$response ) {
126  $this->error = 'json';
127  $this->logCheckError( $this->error );
128  return false;
129  }
130  if ( isset( $response['error-codes'] ) ) {
131  $this->error = 'recaptcha-api';
132  $this->logCheckError( $response['error-codes'] );
133  return false;
134  }
135 
136  return $response['success'];
137  }
138 
142  protected function addCaptchaAPI( &$resultArr ) {
143  $resultArr['captcha'] = $this->describeCaptchaType();
144  $resultArr['captcha']['error'] = $this->error;
145  }
146 
150  public function describeCaptchaType() {
151  global $wgReCaptchaSiteKey;
152  return [
153  'type' => 'recaptchanocaptcha',
154  'mime' => 'image/png',
155  'key' => $wgReCaptchaSiteKey,
156  ];
157  }
158 
166  public function getMessage( $action ) {
167  $msg = parent::getMessage( $action );
168  if ( $this->error ) {
169  $msg = new RawMessage( '<div class="error">$1</div>', [ $msg ] );
170  }
171  return $msg;
172  }
173 
180  public function apiGetAllowedParams( &$module, &$params, $flags ) {
181  if ( $flags && $this->isAPICaptchaModule( $module ) ) {
182  $params['g-recaptcha-response'] = [
183  ApiBase::PARAM_HELP_MSG => 'renocaptcha-apihelp-param-g-recaptcha-response',
184  ];
185  }
186 
187  return true;
188  }
189 
190  public function getError() {
191  return $this->error;
192  }
193 
194  public function storeCaptcha( $info ) {
195  // ReCaptcha is stored by Google; the ID will be generated at that time as well, and
196  // the one returned here won't be used. Just pretend this worked.
197  return 'not used';
198  }
199 
200  public function retrieveCaptcha( $index ) {
201  // just pretend it worked
202  return [ 'index' => $index ];
203  }
204 
205  public function getCaptcha() {
206  // ReCaptcha is handled by frontend code + an external provider; nothing to do here.
207  return [];
208  }
209 
215  public function getCaptchaInfo( $captchaData, $id ) {
216  return wfMessage( 'renocaptcha-info' );
217  }
218 
222  public function createAuthenticationRequest() {
224  }
225 
232  public function onAuthChangeFormFields(
233  array $requests, array $fieldInfo, array &$formDescriptor, $action
234  ) {
235  global $wgReCaptchaSiteKey;
236 
237  $req = AuthenticationRequest::getRequestByClass( $requests,
239  if ( !$req ) {
240  return;
241  }
242 
243  // ugly way to retrieve error information
244  $captcha = ConfirmEditHooks::getInstance();
245 
246  $formDescriptor['captchaWord'] = [
248  'key' => $wgReCaptchaSiteKey,
249  'error' => $captcha->getError(),
250  ] + $formDescriptor['captchaWord'];
251  }
252 }
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1266
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
$req
this hook is for auditing only $req
Definition: hooks.txt:979
$params
$params
Definition: styleTest.css.php:44
$formDescriptor
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 use $formDescriptor instead & $formDescriptor
Definition: hooks.txt:2064
ConfirmEditHooks\getInstance
static getInstance()
Get the global Captcha instance.
Definition: ConfirmEditHooks.php:11
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1043
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
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
SimpleCaptcha\getCaptchaInfo
getCaptchaInfo( $captchaData, $id)
Definition: SimpleCaptcha.php:193
wfAppendQuery
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Definition: GlobalFunctions.php:463
name
and how to run hooks for an and one after Each event has a name
Definition: hooks.txt:6
SimpleCaptcha\addCaptchaAPI
addCaptchaAPI(&$resultArr)
Definition: SimpleCaptcha.php:71
$data
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
FormatJson\decode
static decode( $value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:174
ReCaptchaNoCaptchaAuthenticationRequest
Authentication request for ReCaptcha v2.
Definition: ReCaptchaNoCaptchaAuthenticationRequest.php:9
SimpleCaptcha\getCaptcha
getCaptcha()
Returns an array with 'question' and 'answer' keys.
Definition: SimpleCaptcha.php:53
$wgLang
$wgLang
Definition: Setup.php:875
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
SimpleCaptcha\getCaptchaParamsFromRequest
getCaptchaParamsFromRequest(WebRequest $request)
Definition: SimpleCaptcha.php:958
div
div
Definition: parserTests.txt:6850
$output
$output
Definition: SyntaxHighlight.php:334
array
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
SimpleCaptcha\onAuthChangeFormFields
onAuthChangeFormFields(array $requests, array $fieldInfo, array &$formDescriptor, $action)
Modify the appearance of the captcha field.
Definition: SimpleCaptcha.php:1151
SimpleCaptcha\apiGetAllowedParams
apiGetAllowedParams(&$module, &$params, $flags)
Definition: SimpleCaptcha.php:928
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2636
SimpleCaptcha\retrieveCaptcha
retrieveCaptcha( $index)
Fetch this session's captcha info.
Definition: SimpleCaptcha.php:1069
SimpleCaptcha\createAuthenticationRequest
createAuthenticationRequest()
Definition: SimpleCaptcha.php:1138
SimpleCaptcha
Demo CAPTCHA (not for production usage) and base class for real CAPTCHAs.
Definition: SimpleCaptcha.php:8
SimpleCaptcha\getError
getError()
Return the error from the last passCaptcha* call.
Definition: SimpleCaptcha.php:43
SimpleCaptcha\storeCaptcha
storeCaptcha( $info)
Generate a captcha session ID and save the info in PHP's session storage.
Definition: SimpleCaptcha.php:1055
SimpleCaptcha\getMessage
getMessage( $action)
Show a message asking the user to enter a captcha on edit The result will be treated as wiki text.
Definition: SimpleCaptcha.php:239
$response
this hook is for auditing only $response
Definition: hooks.txt:780
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition: WebRequest.php:41
style
Bar style
Definition: parserTests.txt:218
SimpleCaptcha\describeCaptchaType
describeCaptchaType()
Describes the captcha type for API clients.
Definition: SimpleCaptcha.php:84
SimpleCaptcha\isAPICaptchaModule
isAPICaptchaModule( $module)
Definition: SimpleCaptcha.php:918
SimpleCaptcha\passCaptcha
passCaptcha( $index, $word)
Given a required captcha run, test form input for correct input on the open session.
Definition: SimpleCaptcha.php:1010
$requests
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead. & $feedLinks hooks can tweak the array to change how login etc forms should look $requests
Definition: hooks.txt:273
true
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 just before the function returns a value If you return true
Definition: hooks.txt:1985
error
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition: hooks.txt:2636
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
$wgRequest
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:728
RawMessage
Variant of the Message class.
Definition: RawMessage.php:34
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 use $formDescriptor instead 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
SimpleCaptcha\getFormInformation
getFormInformation( $tabIndex=1)
Insert a captcha prompt into the edit form.
Definition: SimpleCaptcha.php:120
MediaWiki\Auth\AuthenticationRequest
This is a value object for authentication requests.
Definition: AuthenticationRequest.php:37
MWHttpRequest\factory
static factory( $url, array $options=null, $caller=__METHOD__)
Generate a new request object Deprecated:
Definition: MWHttpRequest.php:183