MediaWiki REL1_31
ReCaptchaNoCaptcha.class.php
Go to the documentation of this file.
1<?php
2
4
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 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' => !!$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>
50HTML;
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
83 $index = 'not used'; // ReCaptchaNoCaptcha combines captcha ID + solution into a single value
84 // API is hardwired to return captchaWord, so use that if the standard isempty
85 $response = $request->getVal( 'g-recaptcha-response', $request->getVal( 'captchaWord' ) );
86 return [ $index, $response ];
87 }
88
99 function passCaptcha( $_, $word ) {
100 global $wgRequest, $wgReCaptchaSecretKey, $wgReCaptchaSendRemoteIP;
101
102 $url = 'https://www.google.com/recaptcha/api/siteverify';
103 // Build data to append to request
104 $data = [
105 'secret' => $wgReCaptchaSecretKey,
106 'response' => $word,
107 ];
108 if ( $wgReCaptchaSendRemoteIP ) {
109 $data['remoteip'] = $wgRequest->getIP();
110 }
111 $url = wfAppendQuery( $url, $data );
112 $request = MWHttpRequest::factory( $url, [ 'method' => 'POST' ] );
113 $status = $request->execute();
114 if ( !$status->isOK() ) {
115 $this->error = 'http';
116 $this->logCheckError( $status );
117 return false;
118 }
119 $response = FormatJson::decode( $request->getContent(), true );
120 if ( !$response ) {
121 $this->error = 'json';
122 $this->logCheckError( $this->error );
123 return false;
124 }
125 if ( isset( $response['error-codes'] ) ) {
126 $this->error = 'recaptcha-api';
127 $this->logCheckError( $response['error-codes'] );
128 return false;
129 }
130
131 return $response['success'];
132 }
133
137 function addCaptchaAPI( &$resultArr ) {
138 $resultArr['captcha'] = $this->describeCaptchaType();
139 $resultArr['captcha']['error'] = $this->error;
140 }
141
145 public function describeCaptchaType() {
146 global $wgReCaptchaSiteKey;
147 return [
148 'type' => 'recaptchanocaptcha',
149 'mime' => 'image/png',
150 'key' => $wgReCaptchaSiteKey,
151 ];
152 }
153
161 public function getMessage( $action ) {
162 $msg = parent::getMessage( $action );
163 if ( $this->error ) {
164 $msg = new RawMessage( '<div class="error">$1</div>', [ $msg ] );
165 }
166 return $msg;
167 }
168
175 public function APIGetAllowedParams( &$module, &$params, $flags ) {
176 if ( $flags && $this->isAPICaptchaModule( $module ) ) {
177 $params['g-recaptcha-response'] = [
178 ApiBase::PARAM_HELP_MSG => 'renocaptcha-apihelp-param-g-recaptcha-response',
179 ];
180 }
181
182 return true;
183 }
184
185 public function getError() {
186 return $this->error;
187 }
188
189 public function storeCaptcha( $info ) {
190 // ReCaptcha is stored by Google; the ID will be generated at that time as well, and
191 // the one returned here won't be used. Just pretend this worked.
192 return 'not used';
193 }
194
195 public function retrieveCaptcha( $index ) {
196 // just pretend it worked
197 return [ 'index' => $index ];
198 }
199
200 public function getCaptcha() {
201 // ReCaptcha is handled by frontend code + an external provider; nothing to do here.
202 return [];
203 }
204
210 public function getCaptchaInfo( $captchaData, $id ) {
211 return wfMessage( 'renocaptcha-info' );
212 }
213
217 public function createAuthenticationRequest() {
219 }
220
227 public function onAuthChangeFormFields(
228 array $requests, array $fieldInfo, array &$formDescriptor, $action
229 ) {
230 global $wgReCaptchaSiteKey;
231
232 $req = AuthenticationRequest::getRequestByClass( $requests,
233 CaptchaAuthenticationRequest::class, true );
234 if ( !$req ) {
235 return;
236 }
237
238 // ugly way to retrieve error information
240
241 $formDescriptor['captchaWord'] = [
242 'class' => HTMLReCaptchaNoCaptchaField::class,
243 'key' => $wgReCaptchaSiteKey,
244 'error' => $captcha->getError(),
245 ] + $formDescriptor['captchaWord'];
246 }
247}
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:737
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:124
static getInstance()
Get the global Captcha instance.
This is a value object for authentication requests.
Variant of the Message class.
getCaptchaInfo( $captchaData, $id)
getMessage( $action)
Show a message asking the user to enter a captcha on edit The result will be treated as wiki text.
onAuthChangeFormFields(array $requests, array $fieldInfo, array &$formDescriptor, $action)
getError()
Return the error from the last passCaptcha* call.
getCaptcha()
Returns an array with 'question' and 'answer' keys.
passCaptcha( $_, $word)
Check, if the user solved the captcha.
retrieveCaptcha( $index)
Fetch this session's captcha info.
getFormInformation( $tabIndex=1)
Get the captcha form.
storeCaptcha( $info)
Generate a captcha session ID and save the info in PHP's session storage.
getCaptchaParamsFromRequest(WebRequest $request)
APIGetAllowedParams(&$module, &$params, $flags)
Demo CAPTCHA (not for production usage) and base class for real CAPTCHAs.
Definition Captcha.php:8
isAPICaptchaModule( $module)
Definition Captcha.php:921
string $action
Used to select the right message.
Definition Captcha.php:19
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
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
this hook is for auditing only $req
Definition hooks.txt:990
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:2806
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:2255
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). '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:1051
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
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
this hook is for auditing only $response
Definition hooks.txt:783
> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) name
Definition hooks.txt:1840
$params
if(!isset( $args[0])) $lang
Bar style