MediaWiki REL1_33
SpecialInterwiki.php
Go to the documentation of this file.
1<?php
2
4
13 public function __construct() {
14 parent::__construct( 'Interwiki' );
15 }
16
17 public function doesWrites() {
18 return true;
19 }
20
26 public function getDescription() {
27 return $this->msg( $this->canModify() ?
28 'interwiki' : 'interwiki-title-norights' )->plain();
29 }
30
31 public function getSubpagesForPrefixSearch() {
32 // delete, edit both require the prefix parameter.
33 return [ 'add' ];
34 }
35
41 public function execute( $par ) {
42 $this->setHeaders();
43 $this->outputHeader();
44
45 $out = $this->getOutput();
46 $request = $this->getRequest();
47
48 $out->addModuleStyles( 'ext.interwiki.specialpage' );
49
50 $action = $par ?: $request->getVal( 'action', $par );
51
52 $action = $par ?: $request->getVal( 'action', $par );
53 if ( !in_array( $action, [ 'add', 'edit', 'delete' ] ) || !$this->canModify( $out ) ) {
54 $this->showList();
55 } else {
56 $this->showForm( $action );
57 }
58 }
59
66 public function canModify( $out = false ) {
67 global $wgInterwikiCache;
68 if ( !$this->getUser()->isAllowed( 'interwiki' ) ) {
69 // Check permissions
70 if ( $out ) {
71 throw new PermissionsError( 'interwiki' );
72 }
73
74 return false;
76 // Editing the interwiki cache is not supported
77 if ( $out ) {
78 $out->addWikiMsg( 'interwiki-cached' );
79 }
80
81 return false;
82 } elseif ( wfReadOnly() ) {
83 throw new ReadOnlyError;
84 }
85
86 return true;
87 }
88
92 protected function showForm( $action ) {
93 $formDescriptor = [];
94 $hiddenFields = [
95 'action' => $action,
96 ];
97
98 $status = Status::newGood();
99 $request = $this->getRequest();
100 $prefix = $request->getVal( 'prefix', $request->getVal( 'hiddenPrefix' ) );
101
102 switch ( $action ) {
103 case 'add':
104 case 'edit':
106 'prefix' => [
107 'type' => 'text',
108 'label-message' => 'interwiki-prefix-label',
109 'name' => 'prefix',
110 ],
111
112 'local' => [
113 'type' => 'check',
114 'id' => 'mw-interwiki-local',
115 'label-message' => 'interwiki-local-label',
116 'name' => 'local',
117 ],
118
119 'trans' => [
120 'type' => 'check',
121 'id' => 'mw-interwiki-trans',
122 'label-message' => 'interwiki-trans-label',
123 'name' => 'trans',
124 ],
125
126 'url' => [
127 'type' => 'url',
128 'id' => 'mw-interwiki-url',
129 'label-message' => 'interwiki-url-label',
130 'maxlength' => 200,
131 'name' => 'wpInterwikiURL',
132 'size' => 60,
133 'tabindex' => 1,
134 ],
135
136 'reason' => [
137 'type' => 'text',
138 'id' => "mw-interwiki-{$action}reason",
139 'label-message' => 'interwiki_reasonfield',
140 'maxlength' => 200,
141 'name' => 'wpInterwikiReason',
142 'size' => 60,
143 'tabindex' => 1,
144 ],
145 ];
146
147 break;
148 case 'delete':
150 'prefix' => [
151 'type' => 'hidden',
152 'name' => 'prefix',
153 'default' => $prefix,
154 ],
155
156 'reason' => [
157 'type' => 'text',
158 'name' => 'reason',
159 'label-message' => 'interwiki_reasonfield',
160 ],
161 ];
162
163 break;
164 }
165
166 $formDescriptor['hiddenPrefix'] = [
167 'type' => 'hidden',
168 'name' => 'hiddenPrefix',
169 'default' => $prefix,
170 ];
171
172 if ( $action === 'delete' ) {
173 $topmessage = $this->msg( 'interwiki_delquestion', $prefix )->text();
174 $intromessage = $this->msg( 'interwiki_deleting', $prefix )->escaped();
175 $wpPrefix = Html::hidden( 'wpInterwikiPrefix', $prefix );
176 $button = 'delete';
177 $formContent = '';
178 } elseif ( $action === 'edit' ) {
180 $row = $dbr->selectRow( 'interwiki', '*', [ 'iw_prefix' => $prefix ], __METHOD__ );
181
182 $formDescriptor['prefix']['disabled'] = true;
183 $formDescriptor['prefix']['default'] = $prefix;
184 $hiddenFields['prefix'] = $prefix;
185
186 if ( !$row ) {
187 $status->fatal( 'interwiki_editerror', $prefix );
188 } else {
189 $formDescriptor['url']['default'] = $row->iw_url;
190 $formDescriptor['url']['trans'] = $row->iw_trans;
191 $formDescriptor['url']['local'] = $row->iw_local;
192 }
193 }
194
195 if ( !$status->isOK() ) {
196 $formDescriptor = [];
197 }
198
199 $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() );
200 $htmlForm
201 ->addHiddenFields( $hiddenFields )
202 ->setSubmitCallback( [ $this, 'onSubmit' ] );
203
204 if ( $status->isOK() ) {
205 if ( $action === 'delete' ) {
206 $htmlForm->setSubmitDestructive();
207 }
208
209 $htmlForm->setSubmitTextMsg( $action !== 'add' ? $action : 'interwiki_addbutton' )
210 ->setIntro( $this->msg( $action !== 'delete' ? "interwiki_{$action}intro" :
211 'interwiki_deleting', $prefix ) )
212 ->show();
213 } else {
214 $htmlForm->suppressDefaultSubmit()
215 ->prepareForm()
216 ->displayForm( $status );
217 }
218
219 $this->getOutput()->addBacklinkSubtitle( $this->getPageTitle() );
220 }
221
222 public function onSubmit( array $data ) {
223 global $wgContLang;
224
225 $status = Status::newGood();
226 $request = $this->getRequest();
227 $prefix = $this->getRequest()->getVal( 'prefix', '' );
228 $do = $request->getVal( 'action' );
229 // Show an error if the prefix is invalid (only when adding one).
230 // Invalid characters for a title should also be invalid for a prefix.
231 // Whitespace, ':', '&' and '=' are invalid, too.
232 // (Bug 30599).
233 global $wgLegalTitleChars;
234 $validPrefixChars = preg_replace( '/[ :&=]/', '', $wgLegalTitleChars );
235 if ( $do === 'add' && preg_match( "/\s|[^$validPrefixChars]/", $prefix ) ) {
236 $status->fatal( 'interwiki-badprefix', htmlspecialchars( $prefix ) );
237 return $status;
238 }
239 $reason = $data['reason'];
240 $selfTitle = $this->getPageTitle();
241 $lookup = MediaWikiServices::getInstance()->getInterwikiLookup();
242 $dbw = wfGetDB( DB_MASTER );
243 switch ( $do ) {
244 case 'delete':
245 $dbw->delete( 'interwiki', [ 'iw_prefix' => $prefix ], __METHOD__ );
246
247 if ( $dbw->affectedRows() === 0 ) {
248 $status->fatal( 'interwiki_delfailed', $prefix );
249 } else {
250 $this->getOutput()->addWikiMsg( 'interwiki_deleted', $prefix );
251 $log = new LogPage( 'interwiki' );
252 $log->addEntry( 'iw_delete', $selfTitle, $reason, [ $prefix ] );
253 $lookup->invalidateCache( $prefix );
254 }
255 break;
257 case 'add':
258 $prefix = $wgContLang->lc( $prefix );
259 case 'edit':
260 $theurl = $data['url'];
261 $local = $data['local'] ? 1 : 0;
262 $trans = $data['trans'] ? 1 : 0;
263 $rows = [
264 'iw_prefix' => $prefix,
265 'iw_url' => $theurl,
266 'iw_local' => $local,
267 'iw_trans' => $trans
268 ];
269
270 if ( $prefix === '' || $theurl === '' ) {
271 $status->fatal( 'interwiki-submit-empty' );
272 break;
273 }
274
275 // Simple URL validation: check that the protocol is one of
276 // the supported protocols for this wiki.
277 // (bug 30600)
278 if ( !wfParseUrl( $theurl ) ) {
279 $status->fatal( 'interwiki-submit-invalidurl' );
280 break;
281 }
282
283 if ( $do === 'add' ) {
284 $dbw->insert( 'interwiki', $rows, __METHOD__, [ 'IGNORE' ] );
285 } else { // $do === 'edit'
286 $dbw->update( 'interwiki', $rows, [ 'iw_prefix' => $prefix ], __METHOD__, [ 'IGNORE' ] );
287 }
288
289 // used here: interwiki_addfailed, interwiki_added, interwiki_edited
290 if ( $dbw->affectedRows() === 0 ) {
291 $status->fatal( "interwiki_{$do}failed", $prefix );
292 } else {
293 $this->getOutput()->addWikiMsg( "interwiki_{$do}ed", $prefix );
294 $log = new LogPage( 'interwiki' );
295 $log->addEntry( 'iw_' . $do, $selfTitle, $reason, [ $prefix, $theurl, $trans, $local ] );
296 $lookup->invalidateCache( $prefix );
297 }
298 break;
299 }
300
301 return $status;
302 }
303
304 protected function showList() {
306 $canModify = $this->canModify();
307
308 // Build lists
309 $lookup = MediaWikiServices::getInstance()->getInterwikiLookup();
310 $iwPrefixes = $lookup->getAllPrefixes( null );
311 $iwGlobalPrefixes = [];
312 if ( $wgInterwikiCentralDB !== null && $wgInterwikiCentralDB !== wfWikiID() ) {
313 // Fetch list from global table
314 $dbrCentralDB = wfGetDB( DB_REPLICA, [], $wgInterwikiCentralDB );
315 $res = $dbrCentralDB->select( 'interwiki', '*', false, __METHOD__ );
316 $retval = [];
317 foreach ( $res as $row ) {
318 $row = (array)$row;
319 if ( !Language::fetchLanguageName( $row['iw_prefix'] ) ) {
320 $retval[] = $row;
321 }
322 }
323 $iwGlobalPrefixes = $retval;
324 }
325
326 // Split out language links
327 $iwLocalPrefixes = [];
328 $iwLanguagePrefixes = [];
329 foreach ( $iwPrefixes as $iwPrefix ) {
330 if ( Language::fetchLanguageName( $iwPrefix['iw_prefix'] ) ) {
331 $iwLanguagePrefixes[] = $iwPrefix;
332 } else {
333 $iwLocalPrefixes[] = $iwPrefix;
334 }
335 }
336
337 // Page intro content
338 $this->getOutput()->addWikiMsg( 'interwiki_intro' );
339
340 // Add 'view log' link when possible
341 if ( $wgInterwikiViewOnly === false ) {
342 $logLink = $this->getLinkRenderer()->makeLink(
343 SpecialPage::getTitleFor( 'Log', 'interwiki' ),
344 $this->msg( 'interwiki-logtext' )->text()
345 );
346 $this->getOutput()->addHTML( '<p class="mw-interwiki-log">' . $logLink . '</p>' );
347 }
348
349 // Add 'add' link
350 if ( $canModify ) {
351 if ( count( $iwGlobalPrefixes ) !== 0 ) {
352 $addtext = $this->msg( 'interwiki-addtext-local' )->text();
353 } else {
354 $addtext = $this->msg( 'interwiki_addtext' )->text();
355 }
356 $addlink = $this->getLinkRenderer()->makeKnownLink(
357 $this->getPageTitle( 'add' ), $addtext );
358 $this->getOutput()->addHTML(
359 '<p class="mw-interwiki-addlink">' . $addlink . '</p>' );
360 }
361
362 $this->getOutput()->addWikiMsg( 'interwiki-legend' );
363
364 if ( ( !is_array( $iwPrefixes ) || count( $iwPrefixes ) === 0 ) &&
365 ( !is_array( $iwGlobalPrefixes ) || count( $iwGlobalPrefixes ) === 0 )
366 ) {
367 // If the interwiki table(s) are empty, display an error message
368 $this->error( 'interwiki_error' );
369 return;
370 }
371
372 // Add the global table
373 if ( count( $iwGlobalPrefixes ) !== 0 ) {
374 $this->getOutput()->addHTML(
375 '<h2 id="interwikitable-global">' .
376 $this->msg( 'interwiki-global-links' )->parse() .
377 '</h2>'
378 );
379 $this->getOutput()->addWikiMsg( 'interwiki-global-description' );
380
381 // $canModify is false here because this is just a display of remote data
382 $this->makeTable( false, $iwGlobalPrefixes );
383 }
384
385 // Add the local table
386 if ( count( $iwLocalPrefixes ) !== 0 ) {
387 if ( count( $iwGlobalPrefixes ) !== 0 ) {
388 $this->getOutput()->addHTML(
389 '<h2 id="interwikitable-local">' .
390 $this->msg( 'interwiki-local-links' )->parse() .
391 '</h2>'
392 );
393 $this->getOutput()->addWikiMsg( 'interwiki-local-description' );
394 } else {
395 $this->getOutput()->addHTML(
396 '<h2 id="interwikitable-local">' .
397 $this->msg( 'interwiki-links' )->parse() .
398 '</h2>'
399 );
400 $this->getOutput()->addWikiMsg( 'interwiki-description' );
401 }
402 $this->makeTable( $canModify, $iwLocalPrefixes );
403 }
404
405 // Add the language table
406 if ( count( $iwLanguagePrefixes ) !== 0 ) {
407 $this->getOutput()->addHTML(
408 '<h2 id="interwikitable-language">' .
409 $this->msg( 'interwiki-language-links' )->parse() .
410 '</h2>'
411 );
412 $this->getOutput()->addWikiMsg( 'interwiki-language-description' );
413
414 $this->makeTable( $canModify, $iwLanguagePrefixes );
415 }
416 }
417
418 protected function makeTable( $canModify, $iwPrefixes ) {
419 // Output the existing Interwiki prefixes table header
420 $out = '';
421 $out .= Html::openElement(
422 'table',
423 [ 'class' => 'mw-interwikitable wikitable sortable body' ]
424 ) . "\n";
425 $out .= Html::openElement( 'thead' ) .
426 Html::openElement( 'tr', [ 'class' => 'interwikitable-header' ] ) .
427 Html::element( 'th', null, $this->msg( 'interwiki_prefix' )->text() ) .
428 Html::element( 'th', null, $this->msg( 'interwiki_url' )->text() ) .
429 Html::element( 'th', null, $this->msg( 'interwiki_local' )->text() ) .
430 Html::element( 'th', null, $this->msg( 'interwiki_trans' )->text() ) .
431 ( $canModify ?
432 Html::element(
433 'th',
434 [ 'class' => 'unsortable' ],
435 $this->msg( 'interwiki_edit' )->text()
436 ) :
437 ''
438 );
439 $out .= Html::closeElement( 'tr' ) .
440 Html::closeElement( 'thead' ) . "\n" .
441 Html::openElement( 'tbody' );
442
443 $selfTitle = $this->getPageTitle();
444
445 // Output the existing Interwiki prefixes table rows
446 foreach ( $iwPrefixes as $iwPrefix ) {
447 $out .= Html::openElement( 'tr', [ 'class' => 'mw-interwikitable-row' ] );
448 $out .= Html::element( 'td', [ 'class' => 'mw-interwikitable-prefix' ],
449 $iwPrefix['iw_prefix'] );
450 $out .= Html::element(
451 'td',
452 [ 'class' => 'mw-interwikitable-url' ],
453 $iwPrefix['iw_url']
454 );
455 $attribs = [ 'class' => 'mw-interwikitable-local' ];
456 // Green background for cells with "yes".
457 if ( isset( $iwPrefix['iw_local'] ) && $iwPrefix['iw_local'] ) {
458 $attribs['class'] .= ' mw-interwikitable-local-yes';
459 }
460 // The messages interwiki_0 and interwiki_1 are used here.
461 $contents = isset( $iwPrefix['iw_local'] ) ?
462 $this->msg( 'interwiki_' . $iwPrefix['iw_local'] )->text() :
463 '-';
464 $out .= Html::element( 'td', $attribs, $contents );
465 $attribs = [ 'class' => 'mw-interwikitable-trans' ];
466 // Green background for cells with "yes".
467 if ( isset( $iwPrefix['iw_trans'] ) && $iwPrefix['iw_trans'] ) {
468 $attribs['class'] .= ' mw-interwikitable-trans-yes';
469 }
470 // The messages interwiki_0 and interwiki_1 are used here.
471 $contents = isset( $iwPrefix['iw_trans'] ) ?
472 $this->msg( 'interwiki_' . $iwPrefix['iw_trans'] )->text() :
473 '-';
474 $out .= Html::element( 'td', $attribs, $contents );
475
476 // Additional column when the interwiki table can be modified.
477 if ( $canModify ) {
478 $out .= Html::rawElement( 'td', [ 'class' => 'mw-interwikitable-modify' ],
479 $this->getLinkRenderer()->makeKnownLink(
480 $selfTitle,
481 $this->msg( 'edit' )->text(),
482 [],
483 [ 'action' => 'edit', 'prefix' => $iwPrefix['iw_prefix'] ]
484 ) .
485 $this->msg( 'comma-separator' ) .
486 $this->getLinkRenderer()->makeKnownLink(
487 $selfTitle,
488 $this->msg( 'delete' )->text(),
489 [],
490 [ 'action' => 'delete', 'prefix' => $iwPrefix['iw_prefix'] ]
491 )
492 );
493 }
494 $out .= Html::closeElement( 'tr' ) . "\n";
495 }
496 $out .= Html::closeElement( 'tbody' ) .
497 Html::closeElement( 'table' );
498
499 $this->getOutput()->addHTML( $out );
500 }
501
505 protected function error( ...$args ) {
506 $this->getOutput()->wrapWikiMsg( "<p class='error'>$1</p>", $args );
507 }
508
509 protected function getGroupName() {
510 return 'wiki';
511 }
512}
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two and(2) offer you this license which gives you legal permission to copy
$wgLegalTitleChars
Allowed title characters – regex character class Don't change this unless you know what you're doing.
bool array string $wgInterwikiCache
Interwiki cache, either as an associative array or a path to a constant database (....
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
wfReadOnly()
Check whether the wiki is in read-only mode.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
$wgContLang
Definition Setup.php:790
if( $line===false) $args
Definition cdb.php:64
Class to simplify the use of log pages.
Definition LogPage.php:33
MediaWikiServices is the service locator for the application scope of MediaWiki.
Show an error when a user tries to do something they do not have the necessary permissions for.
Show an error when the wiki is locked/read-only and the user tries to do something that requires writ...
Implements Special:Interwiki.
canModify( $out=false)
Returns boolean whether the user can modify the data.
getDescription()
Different description will be shown on Special:SpecialPage depending on whether the user can modify t...
__construct()
Constructor - sets up the new special page.
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept for prefix searches.
doesWrites()
Indicates whether this special page may perform database writes.
execute( $par)
Show the special page.
makeTable( $canModify, $iwPrefixes)
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Parent class for all special pages.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getOutput()
Get the OutputPage being used for this instance.
getUser()
Shortcut to get the User executing this instance.
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
getContext()
Gets the context this SpecialPage is executed in.
msg( $key)
Wrapper around wfMessage that sets the current context.
getRequest()
Get the WebRequest being used for this instance.
getPageTitle( $subpage=false)
Get a self-referential title object.
$res
Definition database.txt:21
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 $rows
Definition hooks.txt:2818
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:2843
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:855
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:2157
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:2644
either a plain
Definition hooks.txt:2054
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 after processing & $attribs
Definition hooks.txt:2012
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:1032
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
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))
const DB_REPLICA
Definition defines.php:25
const DB_MASTER
Definition defines.php:26