MediaWiki  master
SpecialEditTags.php
Go to the documentation of this file.
1 <?php
31  protected $wasSaved = false;
32 
34  private $submitClicked;
35 
37  private $ids;
38 
40  private $targetObj;
41 
43  private $typeName;
44 
46  private $revList;
47 
49  private $isAllowed;
50 
52  private $reason;
53 
54  public function __construct() {
55  parent::__construct( 'EditTags', 'changetags' );
56  }
57 
58  public function doesWrites() {
59  return true;
60  }
61 
62  public function execute( $par ) {
63  $this->checkPermissions();
64  $this->checkReadOnly();
65 
66  $output = $this->getOutput();
67  $user = $this->getUser();
68  $request = $this->getRequest();
69 
70  // Check blocks
71  // @TODO Use PermissionManager::isBlockedFrom() instead.
72  $block = $user->getBlock();
73  if ( $block ) {
74  throw new UserBlockedError( $block );
75  }
76 
77  $this->setHeaders();
78  $this->outputHeader();
79 
80  $output->addModules( [ 'mediawiki.special.edittags' ] );
81  $output->addModuleStyles( [
82  'mediawiki.interface.helpers.styles',
83  'mediawiki.special'
84  ] );
85 
86  $this->submitClicked = $request->wasPosted() && $request->getBool( 'wpSubmit' );
87 
88  // Handle our many different possible input types
89  $ids = $request->getVal( 'ids' );
90  if ( !is_null( $ids ) ) {
91  // Allow CSV from the form hidden field, or a single ID for show/hide links
92  $this->ids = explode( ',', $ids );
93  } else {
94  // Array input
95  $this->ids = array_keys( $request->getArray( 'ids', [] ) );
96  }
97  $this->ids = array_unique( array_filter( $this->ids ) );
98 
99  // No targets?
100  if ( count( $this->ids ) == 0 ) {
101  throw new ErrorPageError( 'tags-edit-nooldid-title', 'tags-edit-nooldid-text' );
102  }
103 
104  $this->typeName = $request->getVal( 'type' );
105  $this->targetObj = Title::newFromText( $request->getText( 'target' ) );
106 
107  // sanity check of parameter
108  switch ( $this->typeName ) {
109  case 'logentry':
110  case 'logging':
111  $this->typeName = 'logentry';
112  break;
113  default:
114  $this->typeName = 'revision';
115  break;
116  }
117 
118  // Allow the list type to adjust the passed target
119  // Yuck! Copied straight out of SpecialRevisiondelete, but it does exactly
120  // what we want
121  $this->targetObj = RevisionDeleter::suggestTarget(
122  $this->typeName === 'revision' ? 'revision' : 'logging',
123  $this->targetObj,
124  $this->ids
125  );
126 
127  $this->isAllowed = $user->isAllowed( 'changetags' );
128 
129  $this->reason = $request->getVal( 'wpReason' );
130  // We need a target page!
131  if ( is_null( $this->targetObj ) ) {
132  $output->addWikiMsg( 'undelete-header' );
133  return;
134  }
135  // Give a link to the logs/hist for this page
136  $this->showConvenienceLinks();
137 
138  // Either submit or create our form
139  if ( $this->isAllowed && $this->submitClicked ) {
140  $this->submit();
141  } else {
142  $this->showForm();
143  }
144 
145  // Show relevant lines from the tag log
146  $tagLogPage = new LogPage( 'tag' );
147  $output->addHTML( "<h2>" . $tagLogPage->getName()->escaped() . "</h2>\n" );
149  $output,
150  'tag',
151  $this->targetObj,
152  '', /* user */
153  [ 'lim' => 25, 'conds' => [], 'useMaster' => $this->wasSaved ]
154  );
155  }
156 
160  protected function showConvenienceLinks() {
161  // Give a link to the logs/hist for this page
162  if ( $this->targetObj ) {
163  // Also set header tabs to be for the target.
164  $this->getSkin()->setRelevantTitle( $this->targetObj );
165 
166  $linkRenderer = $this->getLinkRenderer();
167  $links = [];
168  $links[] = $linkRenderer->makeKnownLink(
169  SpecialPage::getTitleFor( 'Log' ),
170  $this->msg( 'viewpagelogs' )->text(),
171  [],
172  [
173  'page' => $this->targetObj->getPrefixedText(),
174  'wpfilters' => [ 'tag' ],
175  ]
176  );
177  if ( !$this->targetObj->isSpecialPage() ) {
178  // Give a link to the page history
179  $links[] = $linkRenderer->makeKnownLink(
180  $this->targetObj,
181  $this->msg( 'pagehist' )->text(),
182  [],
183  [ 'action' => 'history' ]
184  );
185  }
186  // Link to Special:Tags
187  $links[] = $linkRenderer->makeKnownLink(
188  SpecialPage::getTitleFor( 'Tags' ),
189  $this->msg( 'tags-edit-manage-link' )->text()
190  );
191  // Logs themselves don't have histories or archived revisions
192  $this->getOutput()->addSubtitle( $this->getLanguage()->pipeList( $links ) );
193  }
194  }
195 
200  protected function getList() {
201  if ( is_null( $this->revList ) ) {
202  $this->revList = ChangeTagsList::factory( $this->typeName, $this->getContext(),
203  $this->targetObj, $this->ids );
204  }
205 
206  return $this->revList;
207  }
208 
213  protected function showForm() {
214  $out = $this->getOutput();
215  // Messages: tags-edit-revision-selected, tags-edit-logentry-selected
216  $out->wrapWikiMsg( "<strong>$1</strong>", [
217  "tags-edit-{$this->typeName}-selected",
218  $this->getLanguage()->formatNum( count( $this->ids ) ),
219  $this->targetObj->getPrefixedText()
220  ] );
221 
222  $this->addHelpLink( 'Help:Tags' );
223  $out->addHTML( "<ul>" );
224 
225  $numRevisions = 0;
226  // Live revisions...
227  $list = $this->getList();
228  for ( $list->reset(); $list->current(); $list->next() ) {
229  $item = $list->current();
230  if ( !$item->canView() ) {
231  throw new ErrorPageError( 'permissionserrors', 'tags-update-no-permission' );
232  }
233  $numRevisions++;
234  $out->addHTML( $item->getHTML() );
235  }
236 
237  if ( !$numRevisions ) {
238  throw new ErrorPageError( 'tags-edit-nooldid-title', 'tags-edit-nooldid-text' );
239  }
240 
241  $out->addHTML( "</ul>" );
242  // Explanation text
243  $out->wrapWikiMsg( '<p>$1</p>', "tags-edit-{$this->typeName}-explanation" );
244 
245  // Show form if the user can submit
246  if ( $this->isAllowed ) {
247  $form = Xml::openElement( 'form', [ 'method' => 'post',
248  'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ),
249  'id' => 'mw-revdel-form-revisions' ] ) .
250  Xml::fieldset( $this->msg( "tags-edit-{$this->typeName}-legend",
251  count( $this->ids ) )->text() ) .
252  $this->buildCheckBoxes() .
253  Xml::openElement( 'table' ) .
254  "<tr>\n" .
255  '<td class="mw-label">' .
256  Xml::label( $this->msg( 'tags-edit-reason' )->text(), 'wpReason' ) .
257  '</td>' .
258  '<td class="mw-input">' .
259  Xml::input( 'wpReason', 60, $this->reason, [
260  'id' => 'wpReason',
261  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
262  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
263  // Unicode codepoints.
264  // "- 155" is to leave room for the auto-generated part of the log entry.
265  'maxlength' => CommentStore::COMMENT_CHARACTER_LIMIT - 155,
266  ] ) .
267  '</td>' .
268  "</tr><tr>\n" .
269  '<td></td>' .
270  '<td class="mw-submit">' .
271  Xml::submitButton( $this->msg( "tags-edit-{$this->typeName}-submit",
272  $numRevisions )->text(), [ 'name' => 'wpSubmit' ] ) .
273  '</td>' .
274  "</tr>\n" .
275  Xml::closeElement( 'table' ) .
276  Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() ) .
277  Html::hidden( 'target', $this->targetObj->getPrefixedText() ) .
278  Html::hidden( 'type', $this->typeName ) .
279  Html::hidden( 'ids', implode( ',', $this->ids ) ) .
280  Xml::closeElement( 'fieldset' ) . "\n" .
281  Xml::closeElement( 'form' ) . "\n";
282  } else {
283  $form = '';
284  }
285  $out->addHTML( $form );
286  }
287 
291  protected function buildCheckBoxes() {
292  // If there is just one item, provide the user with a multi-select field
293  $list = $this->getList();
294  $tags = [];
295  if ( $list->length() == 1 ) {
296  $list->reset();
297  $tags = $list->current()->getTags();
298  if ( $tags ) {
299  $tags = explode( ',', $tags );
300  } else {
301  $tags = [];
302  }
303 
304  $html = '<table id="mw-edittags-tags-selector">';
305  $html .= '<tr><td>' . $this->msg( 'tags-edit-existing-tags' )->escaped() .
306  '</td><td>';
307  if ( $tags ) {
308  $html .= $this->getLanguage()->commaList( array_map( 'htmlspecialchars', $tags ) );
309  } else {
310  $html .= $this->msg( 'tags-edit-existing-tags-none' )->parse();
311  }
312  $html .= '</td></tr>';
313  $tagSelect = $this->getTagSelect( $tags, $this->msg( 'tags-edit-new-tags' )->plain() );
314  $html .= '<tr><td>' . $tagSelect[0] . '</td><td>' . $tagSelect[1];
315  } else {
316  // Otherwise, use a multi-select field for adding tags, and a list of
317  // checkboxes for removing them
318 
319  for ( $list->reset(); $list->current(); $list->next() ) {
320  $currentTags = $list->current()->getTags();
321  if ( $currentTags ) {
322  $tags = array_merge( $tags, explode( ',', $currentTags ) );
323  }
324  }
325  $tags = array_unique( $tags );
326 
327  $html = '<table id="mw-edittags-tags-selector-multi"><tr><td>';
328  $tagSelect = $this->getTagSelect( [], $this->msg( 'tags-edit-add' )->plain() );
329  $html .= '<p>' . $tagSelect[0] . '</p>' . $tagSelect[1] . '</td><td>';
330  $html .= Xml::element( 'p', null, $this->msg( 'tags-edit-remove' )->plain() );
331  $html .= Xml::checkLabel( $this->msg( 'tags-edit-remove-all-tags' )->plain(),
332  'wpRemoveAllTags', 'mw-edittags-remove-all' );
333  $i = 0; // used for generating checkbox IDs only
334  foreach ( $tags as $tag ) {
335  $html .= Xml::element( 'br' ) . "\n" . Xml::checkLabel( $tag,
336  'wpTagsToRemove[]', 'mw-edittags-remove-' . $i++, false, [
337  'value' => $tag,
338  'class' => 'mw-edittags-remove-checkbox',
339  ] );
340  }
341  }
342 
343  // also output the tags currently applied as a hidden form field, so we
344  // know what to remove from the revision/log entry when the form is submitted
345  $html .= Html::hidden( 'wpExistingTags', implode( ',', $tags ) );
346  $html .= '</td></tr></table>';
347 
348  return $html;
349  }
350 
363  protected function getTagSelect( $selectedTags, $label ) {
364  $result = [];
365  $result[0] = Xml::label( $label, 'mw-edittags-tag-list' );
366 
367  $select = new XmlSelect( 'wpTagList[]', 'mw-edittags-tag-list', $selectedTags );
368  $select->setAttribute( 'multiple', 'multiple' );
369  $select->setAttribute( 'size', '8' );
370 
372  $tags = array_unique( array_merge( $tags, $selectedTags ) );
373 
374  // Values of $tags are also used as <option> labels
375  $select->addOptions( array_combine( $tags, $tags ) );
376 
377  $result[1] = $select->getHTML();
378  return $result;
379  }
380 
385  protected function submit() {
386  // Check edit token on submission
387  $request = $this->getRequest();
388  $token = $request->getVal( 'wpEditToken' );
389  if ( $this->submitClicked && !$this->getUser()->matchEditToken( $token ) ) {
390  $this->getOutput()->addWikiMsg( 'sessionfailure' );
391  return false;
392  }
393 
394  // Evaluate incoming request data
395  $tagList = $request->getArray( 'wpTagList' );
396  if ( is_null( $tagList ) ) {
397  $tagList = [];
398  }
399  $existingTags = $request->getVal( 'wpExistingTags' );
400  if ( is_null( $existingTags ) || $existingTags === '' ) {
401  $existingTags = [];
402  } else {
403  $existingTags = explode( ',', $existingTags );
404  }
405 
406  if ( count( $this->ids ) > 1 ) {
407  // multiple revisions selected
408  $tagsToAdd = $tagList;
409  if ( $request->getBool( 'wpRemoveAllTags' ) ) {
410  $tagsToRemove = $existingTags;
411  } else {
412  $tagsToRemove = $request->getArray( 'wpTagsToRemove' );
413  }
414  } else {
415  // single revision selected
416  // The user tells us which tags they want associated to the revision.
417  // We have to figure out which ones to add, and which to remove.
418  $tagsToAdd = array_diff( $tagList, $existingTags );
419  $tagsToRemove = array_diff( $existingTags, $tagList );
420  }
421 
422  if ( !$tagsToAdd && !$tagsToRemove ) {
423  $status = Status::newFatal( 'tags-edit-none-selected' );
424  } else {
425  $status = $this->getList()->updateChangeTagsOnAll( $tagsToAdd,
426  $tagsToRemove, null, $this->reason, $this->getUser() );
427  }
428 
429  if ( $status->isGood() ) {
430  $this->success();
431  return true;
432  } else {
433  $this->failure( $status );
434  return false;
435  }
436  }
437 
441  protected function success() {
442  $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
443  $this->getOutput()->wrapWikiMsg( "<div class=\"successbox\">\n$1\n</div>",
444  'tags-edit-success' );
445  $this->wasSaved = true;
446  $this->revList->reloadFromMaster();
447  $this->reason = ''; // no need to spew the reason back at the user
448  $this->showForm();
449  }
450 
455  protected function failure( $status ) {
456  $this->getOutput()->setPageTitle( $this->msg( 'actionfailed' ) );
457  $this->getOutput()->wrapWikiTextAsInterface(
458  'errorbox', $status->getWikiText( 'tags-edit-failure' )
459  );
460  $this->showForm();
461  }
462 
463  public function getDescription() {
464  return $this->msg( 'tags-edit-title' )->text();
465  }
466 
467  protected function getGroupName() {
468  return 'pagetools';
469  }
470 }
failure( $status)
Report that the submit operation failed.
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:1972
either a plain
Definition: hooks.txt:2033
Shortcut to construct a special page which is unlisted by default.
string $typeName
Deletion type, may be revision or logentry.
getContext()
Gets the context this SpecialPage is executed in.
getList()
Get the list object for this request.
Class for generating HTML <select> or <datalist> elements.
Definition: XmlSelect.php:26
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:274
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
static listExplicitlyDefinedTags()
Lists tags explicitly defined in the change_tag_def table of the database.
getOutput()
Get the OutputPage being used for this instance.
const COMMENT_CHARACTER_LIMIT
Maximum length of a comment in UTF-8 characters.
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
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2205
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:1970
Class to simplify the use of log pages.
Definition: LogPage.php:33
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:767
success()
Report that the submit operation succeeded.
Special page for adding and removing change tags to individual revisions.
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
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:1244
array $ids
Target ID list.
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:108
An error page which can definitely be safely rendered using the OutputPage.
showForm()
Show a list of items that we will operate on, and show a form which allows the user to modify the tag...
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
Definition: Xml.php:609
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:459
getSkin()
Shortcut to get the skin being used for this instance.
submit()
UI entry point for form submission.
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:767
bool $wasSaved
Was the DB modified in this request.
showConvenienceLinks()
Show some useful links in the subtitle.
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
bool $submitClicked
True if the submit button was clicked, and the form was posted.
Show an error when the user tries to do something whilst blocked.
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
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
Definition: Xml.php:358
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
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:117
static suggestTarget( $typeName, $target, array $ids)
Suggest a target for the revision deletion.
getUser()
Shortcut to get the User executing this instance.
Title $targetObj
Title object for target parameter.
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:796
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.
getTagSelect( $selectedTags, $label)
Returns a <select multiple>=""> element with a list of change tags that can be applied by users...
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
Definition: Xml.php:419
getRequest()
Get the WebRequest being used for this instance.
static factory( $typeName, IContextSource $context, Title $title, array $ids)
Creates a ChangeTags*List of the requested type.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
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:2621
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.
bool $isAllowed
Whether user is allowed to perform the action.
ChangeTagsList $revList
Storing the list of items to be tagged.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:67
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:322