MediaWiki  master
SpecialTags.php
Go to the documentation of this file.
1 <?php
29 class SpecialTags extends SpecialPage {
30 
35 
40 
45 
46  function __construct() {
47  parent::__construct( 'Tags' );
48  }
49 
50  function execute( $par ) {
51  $this->setHeaders();
52  $this->outputHeader();
53  $this->addHelpLink( 'Manual:Tags' );
54 
55  $request = $this->getRequest();
56  switch ( $par ) {
57  case 'delete':
58  $this->showDeleteTagForm( $request->getVal( 'tag' ) );
59  break;
60  case 'activate':
61  $this->showActivateDeactivateForm( $request->getVal( 'tag' ), true );
62  break;
63  case 'deactivate':
64  $this->showActivateDeactivateForm( $request->getVal( 'tag' ), false );
65  break;
66  case 'create':
67  // fall through, thanks to HTMLForm's logic
68  default:
69  $this->showTagList();
70  break;
71  }
72  }
73 
74  function showTagList() {
75  $out = $this->getOutput();
76  $out->setPageTitle( $this->msg( 'tags-title' ) );
77  $out->wrapWikiMsg( "<div class='mw-tags-intro'>\n$1\n</div>", 'tags-intro' );
78 
79  $user = $this->getUser();
80  $userCanManage = $user->isAllowed( 'managechangetags' );
81  $userCanDelete = $user->isAllowed( 'deletechangetags' );
82  $userCanEditInterface = $user->isAllowed( 'editinterface' );
83 
84  // Show form to create a tag
85  if ( $userCanManage ) {
86  $fields = [
87  'Tag' => [
88  'type' => 'text',
89  'label' => $this->msg( 'tags-create-tag-name' )->plain(),
90  'required' => true,
91  ],
92  'Reason' => [
93  'type' => 'text',
94  'label' => $this->msg( 'tags-create-reason' )->plain(),
95  'size' => 50,
96  ],
97  'IgnoreWarnings' => [
98  'type' => 'hidden',
99  ],
100  ];
101 
102  $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
103  $form->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
104  $form->setWrapperLegendMsg( 'tags-create-heading' );
105  $form->setHeaderText( $this->msg( 'tags-create-explanation' )->parseAsBlock() );
106  $form->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
107  $form->setSubmitTextMsg( 'tags-create-submit' );
108  $form->show();
109 
110  // If processCreateTagForm generated a redirect, there's no point
111  // continuing with this, as the user is just going to end up getting sent
112  // somewhere else. Additionally, if we keep going here, we end up
113  // populating the memcache of tag data (see ChangeTags::listDefinedTags)
114  // with out-of-date data from the replica DB, because the replica DB hasn't caught
115  // up to the fact that a new tag has been created as part of an implicit,
116  // as yet uncommitted transaction on master.
117  if ( $out->getRedirect() !== '' ) {
118  return;
119  }
120  }
121 
122  // Used to get hitcounts for #doTagRow()
123  $tagStats = ChangeTags::tagUsageStatistics();
124 
125  // Used in #doTagRow()
126  $this->explicitlyDefinedTags = array_fill_keys(
128  $this->softwareDefinedTags = array_fill_keys(
130 
131  // List all defined tags, even if they were never applied
132  $definedTags = array_keys( $this->explicitlyDefinedTags + $this->softwareDefinedTags );
133 
134  // Show header only if there exists atleast one tag
135  if ( !$tagStats && !$definedTags ) {
136  return;
137  }
138 
139  // Write the headers
140  $thead = Xml::tags( 'tr', null, Xml::tags( 'th', null, $this->msg( 'tags-tag' )->parse() ) .
141  Xml::tags( 'th', null, $this->msg( 'tags-display-header' )->parse() ) .
142  Xml::tags( 'th', null, $this->msg( 'tags-description-header' )->parse() ) .
143  Xml::tags( 'th', null, $this->msg( 'tags-source-header' )->parse() ) .
144  Xml::tags( 'th', null, $this->msg( 'tags-active-header' )->parse() ) .
145  Xml::tags( 'th', null, $this->msg( 'tags-hitcount-header' )->parse() ) .
146  ( ( $userCanManage || $userCanDelete ) ?
147  Xml::tags( 'th', [ 'class' => 'unsortable' ],
148  $this->msg( 'tags-actions-header' )->parse() ) :
149  '' )
150  );
151 
152  $tbody = '';
153  // Used in #doTagRow()
154  $this->softwareActivatedTags = array_fill_keys(
156 
157  // Insert tags that have been applied at least once
158  foreach ( $tagStats as $tag => $hitcount ) {
159  $tbody .= $this->doTagRow( $tag, $hitcount, $userCanManage,
160  $userCanDelete, $userCanEditInterface );
161  }
162  // Insert tags defined somewhere but never applied
163  foreach ( $definedTags as $tag ) {
164  if ( !isset( $tagStats[$tag] ) ) {
165  $tbody .= $this->doTagRow( $tag, 0, $userCanManage, $userCanDelete, $userCanEditInterface );
166  }
167  }
168 
169  $out->addModuleStyles( 'jquery.tablesorter.styles' );
170  $out->addModules( 'jquery.tablesorter' );
171  $out->addHTML( Xml::tags(
172  'table',
173  [ 'class' => 'mw-datatable sortable mw-tags-table' ],
174  Xml::tags( 'thead', null, $thead ) .
175  Xml::tags( 'tbody', null, $tbody )
176  ) );
177  }
178 
179  function doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks ) {
180  $newRow = '';
181  $newRow .= Xml::tags( 'td', null, Xml::element( 'code', null, $tag ) );
182 
183  $linkRenderer = $this->getLinkRenderer();
184  $disp = ChangeTags::tagDescription( $tag, $this->getContext() );
185  if ( $showEditLinks ) {
186  $disp .= ' ';
187  $editLink = $linkRenderer->makeLink(
188  $this->msg( "tag-$tag" )->inContentLanguage()->getTitle(),
189  $this->msg( 'tags-edit' )->text()
190  );
191  $disp .= $this->msg( 'parentheses' )->rawParams( $editLink )->escaped();
192  }
193  $newRow .= Xml::tags( 'td', null, $disp );
194 
195  $msg = $this->msg( "tag-$tag-description" );
196  $desc = !$msg->exists() ? '' : $msg->parse();
197  if ( $showEditLinks ) {
198  $desc .= ' ';
199  $editDescLink = $linkRenderer->makeLink(
200  $this->msg( "tag-$tag-description" )->inContentLanguage()->getTitle(),
201  $this->msg( 'tags-edit' )->text()
202  );
203  $desc .= $this->msg( 'parentheses' )->rawParams( $editDescLink )->escaped();
204  }
205  $newRow .= Xml::tags( 'td', null, $desc );
206 
207  $sourceMsgs = [];
208  $isSoftware = isset( $this->softwareDefinedTags[$tag] );
209  $isExplicit = isset( $this->explicitlyDefinedTags[$tag] );
210  if ( $isSoftware ) {
211  // TODO: Rename this message
212  $sourceMsgs[] = $this->msg( 'tags-source-extension' )->escaped();
213  }
214  if ( $isExplicit ) {
215  $sourceMsgs[] = $this->msg( 'tags-source-manual' )->escaped();
216  }
217  if ( !$sourceMsgs ) {
218  $sourceMsgs[] = $this->msg( 'tags-source-none' )->escaped();
219  }
220  $newRow .= Xml::tags( 'td', null, implode( Xml::element( 'br' ), $sourceMsgs ) );
221 
222  $isActive = $isExplicit || isset( $this->softwareActivatedTags[$tag] );
223  $activeMsg = ( $isActive ? 'tags-active-yes' : 'tags-active-no' );
224  $newRow .= Xml::tags( 'td', null, $this->msg( $activeMsg )->escaped() );
225 
226  $hitcountLabelMsg = $this->msg( 'tags-hitcount' )->numParams( $hitcount );
227  if ( $this->getConfig()->get( 'UseTagFilter' ) ) {
228  $hitcountLabel = $linkRenderer->makeLink(
229  SpecialPage::getTitleFor( 'Recentchanges' ),
230  $hitcountLabelMsg->text(),
231  [],
232  [ 'tagfilter' => $tag ]
233  );
234  } else {
235  $hitcountLabel = $hitcountLabelMsg->escaped();
236  }
237 
238  // add raw $hitcount for sorting, because tags-hitcount contains numbers and letters
239  $newRow .= Xml::tags( 'td', [ 'data-sort-value' => $hitcount ], $hitcountLabel );
240 
241  $actionLinks = [];
242 
243  if ( $showDeleteActions && ChangeTags::canDeleteTag( $tag )->isOK() ) {
244  $actionLinks[] = $linkRenderer->makeKnownLink(
245  $this->getPageTitle( 'delete' ),
246  $this->msg( 'tags-delete' )->text(),
247  [],
248  [ 'tag' => $tag ] );
249  }
250 
251  if ( $showManageActions ) { // we've already checked that the user had the requisite userright
252  if ( ChangeTags::canActivateTag( $tag )->isOK() ) {
253  $actionLinks[] = $linkRenderer->makeKnownLink(
254  $this->getPageTitle( 'activate' ),
255  $this->msg( 'tags-activate' )->text(),
256  [],
257  [ 'tag' => $tag ] );
258  }
259 
260  if ( ChangeTags::canDeactivateTag( $tag )->isOK() ) {
261  $actionLinks[] = $linkRenderer->makeKnownLink(
262  $this->getPageTitle( 'deactivate' ),
263  $this->msg( 'tags-deactivate' )->text(),
264  [],
265  [ 'tag' => $tag ] );
266  }
267  }
268 
269  if ( $showDeleteActions || $showManageActions ) {
270  $newRow .= Xml::tags( 'td', null, $this->getLanguage()->pipeList( $actionLinks ) );
271  }
272 
273  return Xml::tags( 'tr', null, $newRow ) . "\n";
274  }
275 
276  public function processCreateTagForm( array $data, HTMLForm $form ) {
277  $context = $form->getContext();
278  $out = $context->getOutput();
279 
280  $tag = trim( strval( $data['Tag'] ) );
281  $ignoreWarnings = isset( $data['IgnoreWarnings'] ) && $data['IgnoreWarnings'] === '1';
282  $status = ChangeTags::createTagWithChecks( $tag, $data['Reason'],
283  $context->getUser(), $ignoreWarnings );
284 
285  if ( $status->isGood() ) {
286  $out->redirect( $this->getPageTitle()->getLocalURL() );
287  return true;
288  } elseif ( $status->isOK() ) {
289  // we have some warnings, so we show a confirmation form
290  $fields = [
291  'Tag' => [
292  'type' => 'hidden',
293  'default' => $data['Tag'],
294  ],
295  'Reason' => [
296  'type' => 'hidden',
297  'default' => $data['Reason'],
298  ],
299  'IgnoreWarnings' => [
300  'type' => 'hidden',
301  'default' => '1',
302  ],
303  ];
304 
305  // fool HTMLForm into thinking the form hasn't been submitted yet. Otherwise
306  // we get into an infinite loop!
307  $context->getRequest()->unsetVal( 'wpEditToken' );
308 
309  $headerText = $this->msg( 'tags-create-warnings-above', $tag,
310  count( $status->getWarningsArray() ) )->parseAsBlock() .
311  $out->parseAsInterface( $status->getWikiText() ) .
312  $this->msg( 'tags-create-warnings-below' )->parseAsBlock();
313 
314  $subform = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
315  $subform->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
316  $subform->setWrapperLegendMsg( 'tags-create-heading' );
317  $subform->setHeaderText( $headerText );
318  $subform->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
319  $subform->setSubmitTextMsg( 'htmlform-yes' );
320  $subform->show();
321 
322  $out->addBacklinkSubtitle( $this->getPageTitle() );
323  return true;
324  } else {
325  $out->wrapWikiTextAsInterface( 'error', $status->getWikiText() );
326  return false;
327  }
328  }
329 
330  protected function showDeleteTagForm( $tag ) {
331  $user = $this->getUser();
332  if ( !$user->isAllowed( 'deletechangetags' ) ) {
333  throw new PermissionsError( 'deletechangetags' );
334  }
335 
336  $out = $this->getOutput();
337  $out->setPageTitle( $this->msg( 'tags-delete-title' ) );
338  $out->addBacklinkSubtitle( $this->getPageTitle() );
339 
340  // is the tag actually able to be deleted?
341  $canDeleteResult = ChangeTags::canDeleteTag( $tag, $user );
342  if ( !$canDeleteResult->isGood() ) {
343  $out->wrapWikiTextAsInterface( 'error', $canDeleteResult->getWikiText() );
344  if ( !$canDeleteResult->isOK() ) {
345  return;
346  }
347  }
348 
349  $preText = $this->msg( 'tags-delete-explanation-initial', $tag )->parseAsBlock();
350  $tagUsage = ChangeTags::tagUsageStatistics();
351  if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > 0 ) {
352  $preText .= $this->msg( 'tags-delete-explanation-in-use', $tag,
353  $tagUsage[$tag] )->parseAsBlock();
354  }
355  $preText .= $this->msg( 'tags-delete-explanation-warning', $tag )->parseAsBlock();
356 
357  // see if the tag is in use
358  $this->softwareActivatedTags = array_fill_keys(
360  if ( isset( $this->softwareActivatedTags[$tag] ) ) {
361  $preText .= $this->msg( 'tags-delete-explanation-active', $tag )->parseAsBlock();
362  }
363 
364  $fields = [];
365  $fields['Reason'] = [
366  'type' => 'text',
367  'label' => $this->msg( 'tags-delete-reason' )->plain(),
368  'size' => 50,
369  ];
370  $fields['HiddenTag'] = [
371  'type' => 'hidden',
372  'name' => 'tag',
373  'default' => $tag,
374  'required' => true,
375  ];
376 
377  $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
378  $form->setAction( $this->getPageTitle( 'delete' )->getLocalURL() );
379  $form->tagAction = 'delete'; // custom property on HTMLForm object
380  $form->setSubmitCallback( [ $this, 'processTagForm' ] );
381  $form->setSubmitTextMsg( 'tags-delete-submit' );
382  $form->setSubmitDestructive(); // nasty!
383  $form->addPreText( $preText );
384  $form->show();
385  }
386 
387  protected function showActivateDeactivateForm( $tag, $activate ) {
388  $actionStr = $activate ? 'activate' : 'deactivate';
389 
390  $user = $this->getUser();
391  if ( !$user->isAllowed( 'managechangetags' ) ) {
392  throw new PermissionsError( 'managechangetags' );
393  }
394 
395  $out = $this->getOutput();
396  // tags-activate-title, tags-deactivate-title
397  $out->setPageTitle( $this->msg( "tags-$actionStr-title" ) );
398  $out->addBacklinkSubtitle( $this->getPageTitle() );
399 
400  // is it possible to do this?
401  $func = $activate ? 'canActivateTag' : 'canDeactivateTag';
402  $result = ChangeTags::$func( $tag, $user );
403  if ( !$result->isGood() ) {
404  $out->wrapWikiTextAsInterface( 'error', $result->getWikiText() );
405  if ( !$result->isOK() ) {
406  return;
407  }
408  }
409 
410  // tags-activate-question, tags-deactivate-question
411  $preText = $this->msg( "tags-$actionStr-question", $tag )->parseAsBlock();
412 
413  $fields = [];
414  // tags-activate-reason, tags-deactivate-reason
415  $fields['Reason'] = [
416  'type' => 'text',
417  'label' => $this->msg( "tags-$actionStr-reason" )->plain(),
418  'size' => 50,
419  ];
420  $fields['HiddenTag'] = [
421  'type' => 'hidden',
422  'name' => 'tag',
423  'default' => $tag,
424  'required' => true,
425  ];
426 
427  $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
428  $form->setAction( $this->getPageTitle( $actionStr )->getLocalURL() );
429  $form->tagAction = $actionStr;
430  $form->setSubmitCallback( [ $this, 'processTagForm' ] );
431  // tags-activate-submit, tags-deactivate-submit
432  $form->setSubmitTextMsg( "tags-$actionStr-submit" );
433  $form->addPreText( $preText );
434  $form->show();
435  }
436 
437  public function processTagForm( array $data, HTMLForm $form ) {
438  $context = $form->getContext();
439  $out = $context->getOutput();
440 
441  $tag = $data['HiddenTag'];
442  $status = call_user_func( [ ChangeTags::class, "{$form->tagAction}TagWithChecks" ],
443  $tag, $data['Reason'], $context->getUser(), true );
444 
445  if ( $status->isGood() ) {
446  $out->redirect( $this->getPageTitle()->getLocalURL() );
447  return true;
448  } elseif ( $status->isOK() && $form->tagAction === 'delete' ) {
449  // deletion succeeded, but hooks raised a warning
450  $out->addWikiTextAsInterface( $this->msg( 'tags-delete-warnings-after-delete', $tag,
451  count( $status->getWarningsArray() ) )->text() . "\n" .
452  $status->getWikitext() );
453  $out->addReturnTo( $this->getPageTitle() );
454  return true;
455  } else {
456  $out->wrapWikiTextAsInterface( 'error', $status->getWikitext() );
457  return false;
458  }
459  }
460 
466  public function getSubpagesForPrefixSearch() {
467  // The subpages does not have an own form, so not listing it at the moment
468  return [
469  // 'delete',
470  // 'activate',
471  // 'deactivate',
472  // 'create',
473  ];
474  }
475 
476  protected function getGroupName() {
477  return 'changes';
478  }
479 }
getContext()
Gets the context this SpecialPage is executed in.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:193
static listSoftwareDefinedTags()
Lists tags defined by core or extensions using the ListDefinedTags hook.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
static tagDescription( $tag, MessageLocalizer $context)
Get a short description for a tag.
Definition: ChangeTags.php:183
static canDeactivateTag( $tag, User $user=null)
Is it OK to allow the user to deactivate this tag?
static listExplicitlyDefinedTags()
Lists tags explicitly defined in the change_tag_def table of the database.
getOutput()
Get the OutputPage being used for this instance.
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:299
showDeleteTagForm( $tag)
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
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> 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=(\*-\*)") 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. '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 '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 since 1.28! 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) $result
Definition: hooks.txt:1981
static canDeleteTag( $tag, User $user=null)
Is it OK to allow the user to delete this tag?
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:773
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1983
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 '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:1250
showActivateDeactivateForm( $tag, $activate)
static canActivateTag( $tag, User $user=null)
Is it OK to allow the user to activate this tag?
static listSoftwareActivatedTags()
Lists those tags which core or extensions report as being "active".
execute( $par)
Definition: SpecialTags.php:50
getContext()
Get the base IContextSource object.
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:130
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
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 null
Definition: hooks.txt:773
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:83
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
array $softwareActivatedTags
List of software activated tags.
Definition: SpecialTags.php:44
static createTagWithChecks( $tag, $reason, User $user, $ignoreWarnings=false, array $logEntryTags=[])
Creates a tag by adding it to change_tag_def table.
array $explicitlyDefinedTags
List of explicitly defined tags.
Definition: SpecialTags.php:34
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
getUser()
Shortcut to get the User executing this instance.
getConfig()
Shortcut to get main config object.
Show an error when a user tries to do something they do not have the necessary permissions for...
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
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:2632
getRequest()
Get the WebRequest being used for this instance.
doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks)
A special page that lists tags for edits.
Definition: SpecialTags.php:29
processTagForm(array $data, HTMLForm $form)
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:2632
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1460
array $softwareDefinedTags
List of software defined tags.
Definition: SpecialTags.php:39
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept.
processCreateTagForm(array $data, HTMLForm $form)
static tagUsageStatistics()
Returns a map of any tags used on the wiki to number of edits tagged with them, ordered descending by...
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:67