MediaWiki REL1_30
ReCaptchaNoCaptcha.class.php
Go to the documentation of this file.
1<?php
2
3use MediaWiki\Auth\AuthenticationRequest;
4
5class 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;
15 function getFormInformation( $tabIndex = 1 ) {
16 global $wgReCaptchaSiteKey, $wgLang;
17 $lang = htmlspecialchars( urlencode( $wgLang->getCode() ) );
18
19 $output = Html::element( 'div', [
20 'class' => [
21 'g-recaptcha',
22 'mw-confirmedit-captcha-fail' => !!$this->error,
23 ],
24 'data-sitekey' => $wgReCaptchaSiteKey
25 ] );
26 $htmlUrlencoded = htmlspecialchars( urlencode( $wgReCaptchaSiteKey ) );
27 $output .= <<<HTML
28<noscript>
29 <div>
30 <div style="width: 302px; height: 422px; position: relative;">
31 <div style="width: 302px; height: 422px; position: absolute;">
32 <iframe src="https://www.google.com/recaptcha/api/fallback?k={$htmlUrlencoded}&hl={$lang}"
33 frameborder="0" scrolling="no"
34 style="width: 302px; height:422px; border-style: none;">
35 </iframe>
36 </div>
37 </div>
38 <div style="width: 300px; height: 60px; border-style: none;
39 bottom: 12px; left: 25px; margin: 0px; padding: 0px; right: 25px;
40 background: #f9f9f9; border: 1px solid #c1c1c1; border-radius: 3px;">
41 <textarea id="g-recaptcha-response" name="g-recaptcha-response"
42 class="g-recaptcha-response"
43 style="width: 250px; height: 40px; border: 1px solid #c1c1c1;
44 margin: 10px 25px; padding: 0px; resize: none;" >
45 </textarea>
46 </div>
47 </div>
48</noscript>
49HTML;
50 return [
51 'html' => $output,
52 'headitems' => [
53 // Insert reCAPTCHA script, in display language, if available.
54 // Language falls back to the browser's display language.
55 // See https://developers.google.com/recaptcha/docs/faq
56 "<script src=\"https://www.google.com/recaptcha/api.js?hl={$lang}\" async defer></script>"
57 ]
58 ];
59 }
60
64 protected function logCheckError( $info ) {
65 if ( $info instanceof Status ) {
66 $errors = $info->getErrorsArray();
67 $error = $errors[0][0];
68 } elseif ( is_array( $info ) ) {
69 $error = implode( ',', $info );
70 } else {
71 $error = $info;
72 }
73
74 wfDebugLog( 'captcha', 'Unable to validate response: ' . $error );
75 }
76
81 protected function getCaptchaParamsFromRequest( WebRequest $request ) {
82 $index = 'not used'; // ReCaptchaNoCaptcha combines captcha ID + solution into a single value
83 // API is hardwired to return captchaWord, so use that if the standard isempty
84 $response = $request->getVal( 'g-recaptcha-response', $request->getVal( 'captchaWord' ) );
85 return [ $index, $response ];
86 }
87
98 function passCaptcha( $_, $word ) {
99 global $wgRequest, $wgReCaptchaSecretKey, $wgReCaptchaSendRemoteIP;
100
101 $url = 'https://www.google.com/recaptcha/api/siteverify';
102 // Build data to append to request
103 $data = [
104 'secret' => $wgReCaptchaSecretKey,
105 'response' => $word,
106 ];
107 if ( $wgReCaptchaSendRemoteIP ) {
108 $data['remoteip'] = $wgRequest->getIP();
109 }
110 $url = wfAppendQuery( $url, $data );
111 $request = MWHttpRequest::factory( $url, [ 'method' => 'GET' ] );
112 $status = $request->execute();
113 if ( !$status->isOK() ) {
114 $this->error = 'http';
115 $this->logCheckError( $status );
116 return false;
117 }
118 $response = FormatJson::decode( $request->getContent(), true );
119 if ( !$response ) {
120 $this->error = 'json';
121 $this->logCheckError( $this->error );
122 return false;
123 }
124 if ( isset( $response['error-codes'] ) ) {
125 $this->error = 'recaptcha-api';
126 $this->logCheckError( $response['error-codes'] );
127 return false;
128 }
129
130 return $response['success'];
131 }
132
136 function addCaptchaAPI( &$resultArr ) {
137 $resultArr['captcha'] = $this->describeCaptchaType();
138 $resultArr['captcha']['error'] = $this->error;
139 }
140
144 public function describeCaptchaType() {
145 global $wgReCaptchaSiteKey;
146 return [
147 'type' => 'recaptchanocaptcha',
148 'mime' => 'image/png',
149 'key' => $wgReCaptchaSiteKey,
150 ];
151 }
152
160 public function getMessage( $action ) {
161 $msg = parent::getMessage( $action );
162 if ( $this->error ) {
163 $msg = new RawMessage( '<div class="error">$1</div>', [ $msg ] );
164 }
165 return $msg;
166 }
167
174 public function APIGetAllowedParams( &$module, &$params, $flags ) {
175 if ( $flags && $this->isAPICaptchaModule( $module ) ) {
176 $params['g-recaptcha-response'] = [
177 ApiBase::PARAM_HELP_MSG => 'renocaptcha-apihelp-param-g-recaptcha-response',
178 ];
179 }
180
181 return true;
182 }
183
184 public function getError() {
185 return $this->error;
186 }
187
188 public function storeCaptcha( $info ) {
189 // ReCaptcha is stored by Google; the ID will be generated at that time as well, and
190 // the one returned here won't be used. Just pretend this worked.
191 return 'not used';
192 }
193
194 public function retrieveCaptcha( $index ) {
195 // just pretend it worked
196 return [ 'index' => $index ];
197 }
198
199 public function getCaptcha() {
200 // ReCaptcha is handled by frontend code + an external provider; nothing to do here.
201 return [];
202 }
203
209 public function getCaptchaInfo( $captchaData, $id ) {
210 return wfMessage( 'renocaptcha-info' );
211 }
212
216 public function createAuthenticationRequest() {
217 return new ReCaptchaNoCaptchaAuthenticationRequest();
218 }
219
226 public function onAuthChangeFormFields(
227 array $requests, array $fieldInfo, array &$formDescriptor, $action
228 ) {
229 global $wgReCaptchaSiteKey;
230
231 $req = AuthenticationRequest::getRequestByClass( $requests,
232 CaptchaAuthenticationRequest::class, true );
233 if ( !$req ) {
234 return;
235 }
236
237 // ugly way to retrieve error information
238 $captcha = ConfirmEditHooks::getInstance();
239
240 $formDescriptor['captchaWord'] = [
241 'class' => HTMLReCaptchaNoCaptchaField::class,
242 'key' => $wgReCaptchaSiteKey,
243 'error' => $captcha->getError(),
244 ] + $formDescriptor['captchaWord'];
245 }
246}
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:1141
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:535
$wgRequest
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:662
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:128
ConfirmEditHooks\getInstance
static getInstance()
Get the global Captcha instance.
Definition ConfirmEditHooks.php:13
MediaWiki\Auth\AuthenticationRequest
This is a value object for authentication requests.
Definition AuthenticationRequest.php:37
RawMessage
Variant of the Message class.
Definition RawMessage.php:34
ReCaptchaNoCaptcha\getCaptchaInfo
getCaptchaInfo( $captchaData, $id)
Definition ReCaptchaNoCaptcha.class.php:209
ReCaptchaNoCaptcha\getMessage
getMessage( $action)
Show a message asking the user to enter a captcha on edit The result will be treated as wiki text.
Definition ReCaptchaNoCaptcha.class.php:160
ReCaptchaNoCaptcha\onAuthChangeFormFields
onAuthChangeFormFields(array $requests, array $fieldInfo, array &$formDescriptor, $action)
Definition ReCaptchaNoCaptcha.class.php:226
ReCaptchaNoCaptcha\getError
getError()
Return the error from the last passCaptcha* call.
Definition ReCaptchaNoCaptcha.class.php:184
ReCaptchaNoCaptcha\getCaptcha
getCaptcha()
Returns an array with 'question' and 'answer' keys.
Definition ReCaptchaNoCaptcha.class.php:199
ReCaptchaNoCaptcha\passCaptcha
passCaptcha( $_, $word)
Check, if the user solved the captcha.
Definition ReCaptchaNoCaptcha.class.php:98
ReCaptchaNoCaptcha\retrieveCaptcha
retrieveCaptcha( $index)
Fetch this session's captcha info.
Definition ReCaptchaNoCaptcha.class.php:194
ReCaptchaNoCaptcha\getFormInformation
getFormInformation( $tabIndex=1)
Get the captcha form.
Definition ReCaptchaNoCaptcha.class.php:15
ReCaptchaNoCaptcha\storeCaptcha
storeCaptcha( $info)
Generate a captcha session ID and save the info in PHP's session storage.
Definition ReCaptchaNoCaptcha.class.php:188
ReCaptchaNoCaptcha\getCaptchaParamsFromRequest
getCaptchaParamsFromRequest(WebRequest $request)
Definition ReCaptchaNoCaptcha.class.php:81
ReCaptchaNoCaptcha\APIGetAllowedParams
APIGetAllowedParams(&$module, &$params, $flags)
Definition ReCaptchaNoCaptcha.class.php:174
SimpleCaptcha
Demo CAPTCHA (not for production usage) and base class for real CAPTCHAs.
Definition Captcha.php:9
SimpleCaptcha\isAPICaptchaModule
isAPICaptchaModule( $module)
Definition Captcha.php:893
SimpleCaptcha\$action
string $action
Used to select the right message.
Definition Captcha.php:20
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition WebRequest.php:38
$wgLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition design.txt:56
$req
this hook is for auditing only $req
Definition hooks.txt:988
$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:2775
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2225
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;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
$flags
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition hooks.txt:2805
$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:304
$response
this hook is for auditing only $response
Definition hooks.txt:781
$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. '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). '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:1049
$params
$params
Definition styleTest.css.php:40
$lang
if(!isset( $args[0])) $lang
Definition testCompression.php:33
style
Bar style
Definition parserTests.txt:192