3 * Implements Special:Tags
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
24 use MediaWiki\MediaWikiServices
;
27 * A special page that lists tags for edits
29 * @ingroup SpecialPage
31 class SpecialTags
extends SpecialPage
{
34 * @var array List of explicitly defined tags
36 protected $explicitlyDefinedTags;
39 * @var array List of software defined tags
41 protected $softwareDefinedTags;
44 * @var array List of software activated tags
46 protected $softwareActivatedTags;
48 function __construct() {
49 parent
::__construct( 'Tags' );
52 function execute( $par ) {
54 $this->outputHeader();
55 $this->addHelpLink( 'Manual:Tags' );
57 $request = $this->getRequest();
60 $this->showDeleteTagForm( $request->getVal( 'tag' ) );
63 $this->showActivateDeactivateForm( $request->getVal( 'tag' ), true );
66 $this->showActivateDeactivateForm( $request->getVal( 'tag' ), false );
69 // fall through, thanks to HTMLForm's logic
76 function showTagList() {
77 $out = $this->getOutput();
78 $out->setPageTitle( $this->msg( 'tags-title' ) );
79 $out->wrapWikiMsg( "<div class='mw-tags-intro'>\n$1\n</div>", 'tags-intro' );
81 $user = $this->getUser();
82 $permissionManager = MediaWikiServices
::getInstance()->getPermissionManager();
83 $userCanManage = $permissionManager->userHasRight( $user, 'managechangetags' );
84 $userCanDelete = $permissionManager->userHasRight( $user, 'deletechangetags' );
85 $userCanEditInterface = $permissionManager->userHasRight( $user, 'editinterface' );
87 // Show form to create a tag
88 if ( $userCanManage ) {
92 'label' => $this->msg( 'tags-create-tag-name' )->plain(),
97 'label' => $this->msg( 'tags-create-reason' )->plain(),
100 'IgnoreWarnings' => [
105 $form = HTMLForm
::factory( 'ooui', $fields, $this->getContext() );
106 $form->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
107 $form->setWrapperLegendMsg( 'tags-create-heading' );
108 $form->setHeaderText( $this->msg( 'tags-create-explanation' )->parseAsBlock() );
109 $form->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
110 $form->setSubmitTextMsg( 'tags-create-submit' );
113 // If processCreateTagForm generated a redirect, there's no point
114 // continuing with this, as the user is just going to end up getting sent
115 // somewhere else. Additionally, if we keep going here, we end up
116 // populating the memcache of tag data (see ChangeTags::listDefinedTags)
117 // with out-of-date data from the replica DB, because the replica DB hasn't caught
118 // up to the fact that a new tag has been created as part of an implicit,
119 // as yet uncommitted transaction on master.
120 if ( $out->getRedirect() !== '' ) {
125 // Used to get hitcounts for #doTagRow()
126 $tagStats = ChangeTags
::tagUsageStatistics();
128 // Used in #doTagRow()
129 $this->explicitlyDefinedTags
= array_fill_keys(
130 ChangeTags
::listExplicitlyDefinedTags(), true );
131 $this->softwareDefinedTags
= array_fill_keys(
132 ChangeTags
::listSoftwareDefinedTags(), true );
134 // List all defined tags, even if they were never applied
135 $definedTags = array_keys( $this->explicitlyDefinedTags +
$this->softwareDefinedTags
);
137 // Show header only if there exists atleast one tag
138 if ( !$tagStats && !$definedTags ) {
143 $thead = Xml
::tags( 'tr', null, Xml
::tags( 'th', null, $this->msg( 'tags-tag' )->parse() ) .
144 Xml
::tags( 'th', null, $this->msg( 'tags-display-header' )->parse() ) .
145 Xml
::tags( 'th', null, $this->msg( 'tags-description-header' )->parse() ) .
146 Xml
::tags( 'th', null, $this->msg( 'tags-source-header' )->parse() ) .
147 Xml
::tags( 'th', null, $this->msg( 'tags-active-header' )->parse() ) .
148 Xml
::tags( 'th', null, $this->msg( 'tags-hitcount-header' )->parse() ) .
149 ( ( $userCanManage ||
$userCanDelete ) ?
150 Xml
::tags( 'th', [ 'class' => 'unsortable' ],
151 $this->msg( 'tags-actions-header' )->parse() ) :
156 // Used in #doTagRow()
157 $this->softwareActivatedTags
= array_fill_keys(
158 ChangeTags
::listSoftwareActivatedTags(), true );
160 // Insert tags that have been applied at least once
161 foreach ( $tagStats as $tag => $hitcount ) {
162 $tbody .= $this->doTagRow( $tag, $hitcount, $userCanManage,
163 $userCanDelete, $userCanEditInterface );
165 // Insert tags defined somewhere but never applied
166 foreach ( $definedTags as $tag ) {
167 if ( !isset( $tagStats[$tag] ) ) {
168 $tbody .= $this->doTagRow( $tag, 0, $userCanManage, $userCanDelete, $userCanEditInterface );
172 $out->addModuleStyles( 'jquery.tablesorter.styles' );
173 $out->addModules( 'jquery.tablesorter' );
174 $out->addHTML( Xml
::tags(
176 [ 'class' => 'mw-datatable sortable mw-tags-table' ],
177 Xml
::tags( 'thead', null, $thead ) .
178 Xml
::tags( 'tbody', null, $tbody )
182 function doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks ) {
184 $newRow .= Xml
::tags( 'td', null, Xml
::element( 'code', null, $tag ) );
186 $linkRenderer = $this->getLinkRenderer();
187 $disp = ChangeTags
::tagDescription( $tag, $this->getContext() );
188 if ( $showEditLinks ) {
190 $editLink = $linkRenderer->makeLink(
191 $this->msg( "tag-$tag" )->inContentLanguage()->getTitle(),
192 $this->msg( 'tags-edit' )->text()
194 $disp .= $this->msg( 'parentheses' )->rawParams( $editLink )->escaped();
196 $newRow .= Xml
::tags( 'td', null, $disp );
198 $msg = $this->msg( "tag-$tag-description" );
199 $desc = !$msg->exists() ?
'' : $msg->parse();
200 if ( $showEditLinks ) {
202 $editDescLink = $linkRenderer->makeLink(
203 $this->msg( "tag-$tag-description" )->inContentLanguage()->getTitle(),
204 $this->msg( 'tags-edit' )->text()
206 $desc .= $this->msg( 'parentheses' )->rawParams( $editDescLink )->escaped();
208 $newRow .= Xml
::tags( 'td', null, $desc );
211 $isSoftware = isset( $this->softwareDefinedTags
[$tag] );
212 $isExplicit = isset( $this->explicitlyDefinedTags
[$tag] );
214 // TODO: Rename this message
215 $sourceMsgs[] = $this->msg( 'tags-source-extension' )->escaped();
218 $sourceMsgs[] = $this->msg( 'tags-source-manual' )->escaped();
220 if ( !$sourceMsgs ) {
221 $sourceMsgs[] = $this->msg( 'tags-source-none' )->escaped();
223 $newRow .= Xml
::tags( 'td', null, implode( Xml
::element( 'br' ), $sourceMsgs ) );
225 $isActive = $isExplicit ||
isset( $this->softwareActivatedTags
[$tag] );
226 $activeMsg = ( $isActive ?
'tags-active-yes' : 'tags-active-no' );
227 $newRow .= Xml
::tags( 'td', null, $this->msg( $activeMsg )->escaped() );
229 $hitcountLabelMsg = $this->msg( 'tags-hitcount' )->numParams( $hitcount );
230 if ( $this->getConfig()->get( 'UseTagFilter' ) ) {
231 $hitcountLabel = $linkRenderer->makeLink(
232 SpecialPage
::getTitleFor( 'Recentchanges' ),
233 $hitcountLabelMsg->text(),
235 [ 'tagfilter' => $tag ]
238 $hitcountLabel = $hitcountLabelMsg->escaped();
241 // add raw $hitcount for sorting, because tags-hitcount contains numbers and letters
242 $newRow .= Xml
::tags( 'td', [ 'data-sort-value' => $hitcount ], $hitcountLabel );
246 if ( $showDeleteActions && ChangeTags
::canDeleteTag( $tag )->isOK() ) {
247 $actionLinks[] = $linkRenderer->makeKnownLink(
248 $this->getPageTitle( 'delete' ),
249 $this->msg( 'tags-delete' )->text(),
254 if ( $showManageActions ) { // we've already checked that the user had the requisite userright
255 if ( ChangeTags
::canActivateTag( $tag )->isOK() ) {
256 $actionLinks[] = $linkRenderer->makeKnownLink(
257 $this->getPageTitle( 'activate' ),
258 $this->msg( 'tags-activate' )->text(),
263 if ( ChangeTags
::canDeactivateTag( $tag )->isOK() ) {
264 $actionLinks[] = $linkRenderer->makeKnownLink(
265 $this->getPageTitle( 'deactivate' ),
266 $this->msg( 'tags-deactivate' )->text(),
272 if ( $showDeleteActions ||
$showManageActions ) {
273 $newRow .= Xml
::tags( 'td', null, $this->getLanguage()->pipeList( $actionLinks ) );
276 return Xml
::tags( 'tr', null, $newRow ) . "\n";
279 public function processCreateTagForm( array $data, HTMLForm
$form ) {
280 $context = $form->getContext();
281 $out = $context->getOutput();
283 $tag = trim( strval( $data['Tag'] ) );
284 $ignoreWarnings = isset( $data['IgnoreWarnings'] ) && $data['IgnoreWarnings'] === '1';
285 $status = ChangeTags
::createTagWithChecks( $tag, $data['Reason'],
286 $context->getUser(), $ignoreWarnings );
288 if ( $status->isGood() ) {
289 $out->redirect( $this->getPageTitle()->getLocalURL() );
291 } elseif ( $status->isOK() ) {
292 // we have some warnings, so we show a confirmation form
296 'default' => $data['Tag'],
300 'default' => $data['Reason'],
302 'IgnoreWarnings' => [
308 // fool HTMLForm into thinking the form hasn't been submitted yet. Otherwise
309 // we get into an infinite loop!
310 $context->getRequest()->unsetVal( 'wpEditToken' );
312 $headerText = $this->msg( 'tags-create-warnings-above', $tag,
313 count( $status->getWarningsArray() ) )->parseAsBlock() .
314 $out->parseAsInterface( $status->getWikiText() ) .
315 $this->msg( 'tags-create-warnings-below' )->parseAsBlock();
317 $subform = HTMLForm
::factory( 'ooui', $fields, $this->getContext() );
318 $subform->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
319 $subform->setWrapperLegendMsg( 'tags-create-heading' );
320 $subform->setHeaderText( $headerText );
321 $subform->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
322 $subform->setSubmitTextMsg( 'htmlform-yes' );
325 $out->addBacklinkSubtitle( $this->getPageTitle() );
328 $out->wrapWikiTextAsInterface( 'error', $status->getWikiText() );
333 protected function showDeleteTagForm( $tag ) {
334 $user = $this->getUser();
335 if ( !MediaWikiServices
::getInstance()
336 ->getPermissionManager()
337 ->userHasRight( $user, 'deletechangetags' ) ) {
338 throw new PermissionsError( 'deletechangetags' );
341 $out = $this->getOutput();
342 $out->setPageTitle( $this->msg( 'tags-delete-title' ) );
343 $out->addBacklinkSubtitle( $this->getPageTitle() );
345 // is the tag actually able to be deleted?
346 $canDeleteResult = ChangeTags
::canDeleteTag( $tag, $user );
347 if ( !$canDeleteResult->isGood() ) {
348 $out->wrapWikiTextAsInterface( 'error', $canDeleteResult->getWikiText() );
349 if ( !$canDeleteResult->isOK() ) {
354 $preText = $this->msg( 'tags-delete-explanation-initial', $tag )->parseAsBlock();
355 $tagUsage = ChangeTags
::tagUsageStatistics();
356 if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > 0 ) {
357 $preText .= $this->msg( 'tags-delete-explanation-in-use', $tag,
358 $tagUsage[$tag] )->parseAsBlock();
360 $preText .= $this->msg( 'tags-delete-explanation-warning', $tag )->parseAsBlock();
362 // see if the tag is in use
363 $this->softwareActivatedTags
= array_fill_keys(
364 ChangeTags
::listSoftwareActivatedTags(), true );
365 if ( isset( $this->softwareActivatedTags
[$tag] ) ) {
366 $preText .= $this->msg( 'tags-delete-explanation-active', $tag )->parseAsBlock();
370 $fields['Reason'] = [
372 'label' => $this->msg( 'tags-delete-reason' )->plain(),
375 $fields['HiddenTag'] = [
382 $form = HTMLForm
::factory( 'ooui', $fields, $this->getContext() );
383 $form->setAction( $this->getPageTitle( 'delete' )->getLocalURL() );
384 // @phan-suppress-next-line PhanUndeclaredProperty
385 $form->tagAction
= 'delete'; // custom property on HTMLForm object
386 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
387 $form->setSubmitTextMsg( 'tags-delete-submit' );
388 $form->setSubmitDestructive(); // nasty!
389 $form->addPreText( $preText );
393 protected function showActivateDeactivateForm( $tag, $activate ) {
394 $actionStr = $activate ?
'activate' : 'deactivate';
396 $user = $this->getUser();
397 if ( !MediaWikiServices
::getInstance()
398 ->getPermissionManager()
399 ->userHasRight( $user, 'managechangetags' ) ) {
400 throw new PermissionsError( 'managechangetags' );
403 $out = $this->getOutput();
404 // tags-activate-title, tags-deactivate-title
405 $out->setPageTitle( $this->msg( "tags-$actionStr-title" ) );
406 $out->addBacklinkSubtitle( $this->getPageTitle() );
408 // is it possible to do this?
409 $func = $activate ?
'canActivateTag' : 'canDeactivateTag';
410 $result = ChangeTags
::$func( $tag, $user );
411 if ( !$result->isGood() ) {
412 $out->wrapWikiTextAsInterface( 'error', $result->getWikiText() );
413 if ( !$result->isOK() ) {
418 // tags-activate-question, tags-deactivate-question
419 $preText = $this->msg( "tags-$actionStr-question", $tag )->parseAsBlock();
422 // tags-activate-reason, tags-deactivate-reason
423 $fields['Reason'] = [
425 'label' => $this->msg( "tags-$actionStr-reason" )->plain(),
428 $fields['HiddenTag'] = [
435 $form = HTMLForm
::factory( 'ooui', $fields, $this->getContext() );
436 $form->setAction( $this->getPageTitle( $actionStr )->getLocalURL() );
437 // @phan-suppress-next-line PhanUndeclaredProperty
438 $form->tagAction
= $actionStr;
439 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
440 // tags-activate-submit, tags-deactivate-submit
441 $form->setSubmitTextMsg( "tags-$actionStr-submit" );
442 $form->addPreText( $preText );
448 * @param HTMLForm $form
450 * @suppress PhanUndeclaredProperty $form->tagAction
452 public function processTagForm( array $data, HTMLForm
$form ) {
453 $context = $form->getContext();
454 $out = $context->getOutput();
456 $tag = $data['HiddenTag'];
457 $status = call_user_func( [ ChangeTags
::class, "{$form->tagAction}TagWithChecks" ],
458 $tag, $data['Reason'], $context->getUser(), true );
460 if ( $status->isGood() ) {
461 $out->redirect( $this->getPageTitle()->getLocalURL() );
463 } elseif ( $status->isOK() && $form->tagAction
=== 'delete' ) {
464 // deletion succeeded, but hooks raised a warning
465 $out->addWikiTextAsInterface( $this->msg( 'tags-delete-warnings-after-delete', $tag,
466 count( $status->getWarningsArray() ) )->text() . "\n" .
467 $status->getWikitext() );
468 $out->addReturnTo( $this->getPageTitle() );
471 $out->wrapWikiTextAsInterface( 'error', $status->getWikitext() );
477 * Return an array of subpages that this special page will accept.
479 * @return string[] subpages
481 public function getSubpagesForPrefixSearch() {
482 // The subpages does not have an own form, so not listing it at the moment
491 protected function getGroupName() {