MediaWiki REL1_32
ConfirmEditHooks.php
Go to the documentation of this file.
1<?php
2
4 protected static $instanceCreated = false;
5
11 public static function getInstance() {
12 global $wgCaptcha, $wgCaptchaClass;
13
14 $class = $wgCaptchaClass;
15 if ( $class == null ) {
16 $class = 'SimpleCaptcha';
17 }
18 if ( !static::$instanceCreated ) {
19 static::$instanceCreated = true;
20 $wgCaptcha = new $class;
21 }
22
23 return $wgCaptcha;
24 }
25
35 public static function confirmEditMerged( $context, $content, $status, $summary, $user,
36 $minorEdit
37 ) {
38 return self::getInstance()->confirmEditMerged( $context, $content, $status, $summary,
39 $user, $minorEdit );
40 }
41
60 public static function onPageContentSaveComplete( WikiPage $wikiPage, User $user, Content $content,
61 $summary, $isMinor, $isWatch, $section, $flags, $revision, Status $status, $baseRevId
62 ) {
63 $title = $wikiPage->getTitle();
64 if ( $title->getText() === 'Captcha-ip-whitelist' && $title->getNamespace() === NS_MEDIAWIKI ) {
65 $cache = ObjectCache::getMainWANInstance();
66 $cache->delete( $cache->makeKey( 'confirmedit', 'ipwhitelist' ) );
67 }
68
69 return true;
70 }
71
75 public static function confirmEditPage( EditPage $editpage ) {
76 self::getInstance()->editShowCaptcha( $editpage );
77 }
78
83 public static function showEditFormFields( &$editPage, &$out ) {
84 self::getInstance()->showEditFormFields( $editPage, $out );
85 }
86
91 public static function injectEmailUser( &$form ) {
92 return self::getInstance()->injectEmailUser( $form );
93 }
94
103 public static function confirmEmailUser( $from, $to, $subject, $text, &$error ) {
104 return self::getInstance()->confirmEmailUser( $from, $to, $subject, $text, $error );
105 }
106
115 public static function onAPIGetAllowedParams( &$module, &$params, $flags = 1 ) {
116 return self::getInstance()->apiGetAllowedParams( $module, $params, $flags );
117 }
118
125 public static function onAuthChangeFormFields(
126 array $requests, array $fieldInfo, array &$formDescriptor, $action
127 ) {
128 self::getInstance()->onAuthChangeFormFields( $requests, $fieldInfo, $formDescriptor, $action );
129 }
130
131 public static function confirmEditSetup() {
132 // @codingStandardsIgnoreStart MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
133 global $wgCaptchaTriggers, $wgAllowConfirmedEmail,
134 $wgWikimediaJenkinsCI, $ceAllowConfirmedEmail;
135 // @codingStandardsIgnoreEnd
136
137 // There is no need to run (core) tests with enabled ConfirmEdit - bug T44145
138 if ( isset( $wgWikimediaJenkinsCI ) && $wgWikimediaJenkinsCI === true ) {
139 $wgCaptchaTriggers = array_fill_keys( array_keys( $wgCaptchaTriggers ), false );
140 }
141
142 // $ceAllowConfirmedEmail is deprecated and should be replaced by $wgAllowConfirmedEmail.
143 // For backward-compatibility, keep the value for some time. T162641
144 if ( isset( $ceAllowConfirmedEmail ) ) {
146 'Using $ceAllowConfirmedEmail is deprecated, ' .
147 'please migrate to $wgAllowConfirmedEmail as a replacement.' );
148 $wgAllowConfirmedEmail = $ceAllowConfirmedEmail;
149 }
150 }
151
159 public static function onTitleReadWhitelist( Title $title, User $user, &$whitelisted ) {
160 $image = SpecialPage::getTitleFor( 'Captcha', 'image' );
161 $help = SpecialPage::getTitleFor( 'Captcha', 'help' );
162 if ( $title->equals( $image ) || $title->equals( $help ) ) {
163 $whitelisted = true;
164 }
165 }
166
172 public static function onFancyCaptchaSetup() {
173 global $wgCaptchaDirectory, $wgUploadDirectory;
174 if ( !$wgCaptchaDirectory ) {
175 $wgCaptchaDirectory = "$wgUploadDirectory/captcha";
176 }
177 }
178
183 public static function onReCaptchaSetup() {
184 require_once __DIR__ . '/../ReCaptcha/recaptchalib.php';
185 }
186
191 public static function efReCaptcha() {
192 global $wgReCaptchaPublicKey, $wgReCaptchaPrivateKey;
193 // @codingStandardsIgnoreStart
194 global $recaptcha_public_key, $recaptcha_private_key;
195 // @codingStandardsIgnoreEnd
196 global $wgServerName;
197
198 // Backwards compatibility
199 if ( $wgReCaptchaPublicKey == '' ) {
200 $wgReCaptchaPublicKey = $recaptcha_public_key;
201 }
202 if ( $wgReCaptchaPrivateKey == '' ) {
203 $wgReCaptchaPrivateKey = $recaptcha_private_key;
204 }
205
206 if ( $wgReCaptchaPublicKey == '' || $wgReCaptchaPrivateKey == '' ) {
207 die(
208 'You need to set $wgReCaptchaPrivateKey and $wgReCaptchaPublicKey in LocalSettings.php to ' .
209 "use the reCAPTCHA plugin. You can sign up for a key <a href='" .
210 htmlentities( recaptcha_get_signup_url( $wgServerName, "mediawiki" ) ) .
211 "'>here</a>."
212 );
213 }
214 }
215
228 public static function onAlternateEditPreview( EditPage $editor, &$content, &$html, &$po ) {
229 $title = $editor->getTitle();
230 $exceptionTitle = Title::makeTitle( NS_MEDIAWIKI, 'Captcha-ip-whitelist' );
231
232 if ( !$title->equals( $exceptionTitle ) ) {
233 return true;
234 }
235
236 $ctx = $editor->getArticle()->getContext();
237 $out = $ctx->getOutput();
238 $lang = $ctx->getLanguage();
239
240 $lines = explode( "\n", $content->getNativeData() );
241 $html .= Html::rawElement(
242 'div',
243 [ 'class' => 'warningbox' ],
244 $ctx->msg( 'confirmedit-preview-description' )->parse()
245 ) .
246 Html::openElement(
247 'table',
248 [ 'class' => 'wikitable sortable' ]
249 ) .
250 Html::openElement( 'thead' ) .
251 Html::element( 'th', [], $ctx->msg( 'confirmedit-preview-line' )->text() ) .
252 Html::element( 'th', [], $ctx->msg( 'confirmedit-preview-content' )->text() ) .
253 Html::element( 'th', [], $ctx->msg( 'confirmedit-preview-validity' )->text() ) .
254 Html::closeElement( 'thead' );
255
256 foreach ( $lines as $count => $line ) {
257 $ip = trim( $line );
258 if ( $ip === '' || strpos( $ip, '#' ) !== false ) {
259 continue;
260 }
261 if ( IP::isIPAddress( $ip ) ) {
262 $validity = $ctx->msg( 'confirmedit-preview-valid' )->escaped();
263 $css = 'valid';
264 } else {
265 $validity = $ctx->msg( 'confirmedit-preview-invalid' )->escaped();
266 $css = 'notvalid';
267 }
268 $html .= Html::openElement( 'tr' ) .
269 Html::element(
270 'td',
271 [],
272 $lang->formatNum( $count + 1 )
273 ) .
274 Html::element(
275 'td',
276 [],
277 // IPv6 max length: 8 groups * 4 digits + 7 delimiter = 39
278 // + 11 chars for safety
279 $lang->truncateForVisual( $ip, 50 )
280 ) .
281 Html::rawElement(
282 'td',
283 // possible values:
284 // mw-confirmedit-ip-valid
285 // mw-confirmedit-ip-notvalid
286 [ 'class' => 'mw-confirmedit-ip-' . $css ],
287 $validity
288 ) .
289 Html::closeElement( 'tr' );
290 }
291 $html .= Html::closeElement( 'table' );
292 $out->addModuleStyles( 'ext.confirmEdit.editPreview.ipwhitelist.styles' );
293
294 return false;
295 }
296}
$wgServerName
Server name.
$wgUploadDirectory
The filesystem path of the images directory.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
$line
Definition cdb.php:59
static onFancyCaptchaSetup()
Callback for extension.json of FancyCaptcha to set a default captcha directory, which depends on wgUp...
static injectEmailUser(&$form)
static efReCaptcha()
Extension function, moved from ReCaptcha.php when that was decimated.
static confirmEditMerged( $context, $content, $status, $summary, $user, $minorEdit)
static onReCaptchaSetup()
Callback for extension.json of ReCaptcha to require the recaptcha library php file.
static showEditFormFields(&$editPage, &$out)
static confirmEditPage(EditPage $editpage)
static confirmEmailUser( $from, $to, $subject, $text, &$error)
static onTitleReadWhitelist(Title $title, User $user, &$whitelisted)
TitleReadWhitelist hook handler.
static onAlternateEditPreview(EditPage $editor, &$content, &$html, &$po)
AlternateEditPreview hook handler.
static onAuthChangeFormFields(array $requests, array $fieldInfo, array &$formDescriptor, $action)
static onPageContentSaveComplete(WikiPage $wikiPage, User $user, Content $content, $summary, $isMinor, $isWatch, $section, $flags, $revision, Status $status, $baseRevId)
PageContentSaveComplete hook handler.
static onAPIGetAllowedParams(&$module, &$params, $flags=1)
APIGetAllowedParams hook handler Default $flags to 1 for backwards-compatible behavior.
static getInstance()
Get the global Captcha instance.
The edit page/HTML interface (split from Article) The actual database and text munging is still in Ar...
Definition EditPage.php:44
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
Represents a title within MediaWiki.
Definition Title.php:39
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
Class representing a MediaWiki article and history.
Definition WikiPage.php:44
getTitle()
Get the title object of the article.
Definition WikiPage.php:276
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:2208
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image
Definition hooks.txt:925
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel you ll need to handle error etc yourself modifying $error and returning true will cause the contents of $error to be echoed at the top of the edit form as wikitext Return true without altering $error to allow the edit to proceed & $editor
Definition hooks.txt:1460
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 and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2885
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:894
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 an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition hooks.txt:2062
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
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:1071
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition hooks.txt:3107
Base interface for content objects.
Definition Content.php:34
$cache
Definition mcc.php:33
$help
Definition mcc.php:32
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))
$content
recaptcha_get_signup_url( $domain=null, $appname=null)
gets a URL where the user can sign up for reCAPTCHA.
$lines
Definition router.php:61
$params
if(!isset( $args[0])) $lang