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
25 * A special page that lists tags for edits
27 * @ingroup SpecialPage
29 class SpecialTags
extends SpecialPage
{
32 * @var array List of explicitly defined tags
34 protected $explicitlyDefinedTags;
37 * @var array List of software defined tags
39 protected $softwareDefinedTags;
42 * @var array List of software activated tags
44 protected $softwareActivatedTags;
46 function __construct() {
47 parent
::__construct( 'Tags' );
50 function execute( $par ) {
52 $this->outputHeader();
54 $request = $this->getRequest();
57 $this->showDeleteTagForm( $request->getVal( 'tag' ) );
60 $this->showActivateDeactivateForm( $request->getVal( 'tag' ), true );
63 $this->showActivateDeactivateForm( $request->getVal( 'tag' ), false );
66 // fall through, thanks to HTMLForm's logic
73 function showTagList() {
74 $out = $this->getOutput();
75 $out->setPageTitle( $this->msg( 'tags-title' ) );
76 $out->wrapWikiMsg( "<div class='mw-tags-intro'>\n$1\n</div>", 'tags-intro' );
78 $user = $this->getUser();
79 $userCanManage = $user->isAllowed( 'managechangetags' );
80 $userCanDelete = $user->isAllowed( 'deletechangetags' );
81 $userCanEditInterface = $user->isAllowed( 'editinterface' );
83 // Show form to create a tag
84 if ( $userCanManage ) {
88 'label' => $this->msg( 'tags-create-tag-name' )->plain(),
93 'label' => $this->msg( 'tags-create-reason' )->plain(),
101 $form = HTMLForm
::factory( 'ooui', $fields, $this->getContext() );
102 $form->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
103 $form->setWrapperLegendMsg( 'tags-create-heading' );
104 $form->setHeaderText( $this->msg( 'tags-create-explanation' )->parseAsBlock() );
105 $form->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
106 $form->setSubmitTextMsg( 'tags-create-submit' );
109 // If processCreateTagForm generated a redirect, there's no point
110 // continuing with this, as the user is just going to end up getting sent
111 // somewhere else. Additionally, if we keep going here, we end up
112 // populating the memcache of tag data (see ChangeTags::listDefinedTags)
113 // with out-of-date data from the replica DB, because the replica DB hasn't caught
114 // up to the fact that a new tag has been created as part of an implicit,
115 // as yet uncommitted transaction on master.
116 if ( $out->getRedirect() !== '' ) {
121 // Used to get hitcounts for #doTagRow()
122 $tagStats = ChangeTags
::tagUsageStatistics();
124 // Used in #doTagRow()
125 $this->explicitlyDefinedTags
= array_fill_keys(
126 ChangeTags
::listExplicitlyDefinedTags(), true );
127 $this->softwareDefinedTags
= array_fill_keys(
128 ChangeTags
::listSoftwareDefinedTags(), true );
130 // List all defined tags, even if they were never applied
131 $definedTags = array_keys( $this->explicitlyDefinedTags +
$this->softwareDefinedTags
);
133 // Show header only if there exists atleast one tag
134 if ( !$tagStats && !$definedTags ) {
139 $thead = Xml
::tags( 'tr', null, Xml
::tags( 'th', null, $this->msg( 'tags-tag' )->parse() ) .
140 Xml
::tags( 'th', null, $this->msg( 'tags-display-header' )->parse() ) .
141 Xml
::tags( 'th', null, $this->msg( 'tags-description-header' )->parse() ) .
142 Xml
::tags( 'th', null, $this->msg( 'tags-source-header' )->parse() ) .
143 Xml
::tags( 'th', null, $this->msg( 'tags-active-header' )->parse() ) .
144 Xml
::tags( 'th', null, $this->msg( 'tags-hitcount-header' )->parse() ) .
145 ( ( $userCanManage ||
$userCanDelete ) ?
146 Xml
::tags( 'th', [ 'class' => 'unsortable' ],
147 $this->msg( 'tags-actions-header' )->parse() ) :
152 // Used in #doTagRow()
153 $this->softwareActivatedTags
= array_fill_keys(
154 ChangeTags
::listSoftwareActivatedTags(), true );
156 // Insert tags that have been applied at least once
157 foreach ( $tagStats as $tag => $hitcount ) {
158 $tbody .= $this->doTagRow( $tag, $hitcount, $userCanManage,
159 $userCanDelete, $userCanEditInterface );
161 // Insert tags defined somewhere but never applied
162 foreach ( $definedTags as $tag ) {
163 if ( !isset( $tagStats[$tag] ) ) {
164 $tbody .= $this->doTagRow( $tag, 0, $userCanManage, $userCanDelete, $userCanEditInterface );
168 $out->addModuleStyles( 'jquery.tablesorter.styles' );
169 $out->addModules( 'jquery.tablesorter' );
170 $out->addHTML( Xml
::tags(
172 [ 'class' => 'mw-datatable sortable mw-tags-table' ],
173 Xml
::tags( 'thead', null, $thead ) .
174 Xml
::tags( 'tbody', null, $tbody )
178 function doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks ) {
180 $newRow .= Xml
::tags( 'td', null, Xml
::element( 'code', null, $tag ) );
182 $linkRenderer = $this->getLinkRenderer();
183 $disp = ChangeTags
::tagDescription( $tag, $this->getContext() );
184 if ( $showEditLinks ) {
186 $editLink = $linkRenderer->makeLink(
187 $this->msg( "tag-$tag" )->inContentLanguage()->getTitle(),
188 $this->msg( 'tags-edit' )->text()
190 $disp .= $this->msg( 'parentheses' )->rawParams( $editLink )->escaped();
192 $newRow .= Xml
::tags( 'td', null, $disp );
194 $msg = $this->msg( "tag-$tag-description" );
195 $desc = !$msg->exists() ?
'' : $msg->parse();
196 if ( $showEditLinks ) {
198 $editDescLink = $linkRenderer->makeLink(
199 $this->msg( "tag-$tag-description" )->inContentLanguage()->getTitle(),
200 $this->msg( 'tags-edit' )->text()
202 $desc .= $this->msg( 'parentheses' )->rawParams( $editDescLink )->escaped();
204 $newRow .= Xml
::tags( 'td', null, $desc );
207 $isSoftware = isset( $this->softwareDefinedTags
[$tag] );
208 $isExplicit = isset( $this->explicitlyDefinedTags
[$tag] );
210 // TODO: Rename this message
211 $sourceMsgs[] = $this->msg( 'tags-source-extension' )->escaped();
214 $sourceMsgs[] = $this->msg( 'tags-source-manual' )->escaped();
216 if ( !$sourceMsgs ) {
217 $sourceMsgs[] = $this->msg( 'tags-source-none' )->escaped();
219 $newRow .= Xml
::tags( 'td', null, implode( Xml
::element( 'br' ), $sourceMsgs ) );
221 $isActive = $isExplicit ||
isset( $this->softwareActivatedTags
[$tag] );
222 $activeMsg = ( $isActive ?
'tags-active-yes' : 'tags-active-no' );
223 $newRow .= Xml
::tags( 'td', null, $this->msg( $activeMsg )->escaped() );
225 $hitcountLabelMsg = $this->msg( 'tags-hitcount' )->numParams( $hitcount );
226 if ( $this->getConfig()->get( 'UseTagFilter' ) ) {
227 $hitcountLabel = $linkRenderer->makeLink(
228 SpecialPage
::getTitleFor( 'Recentchanges' ),
229 $hitcountLabelMsg->text(),
231 [ 'tagfilter' => $tag ]
234 $hitcountLabel = $hitcountLabelMsg->escaped();
237 // add raw $hitcount for sorting, because tags-hitcount contains numbers and letters
238 $newRow .= Xml
::tags( 'td', [ 'data-sort-value' => $hitcount ], $hitcountLabel );
244 if ( $showDeleteActions && ChangeTags
::canDeleteTag( $tag )->isOK() ) {
245 $actionLinks[] = $linkRenderer->makeKnownLink(
246 $this->getPageTitle( 'delete' ),
247 $this->msg( 'tags-delete' )->text(),
252 if ( $showManageActions ) { // we've already checked that the user had the requisite userright
254 if ( ChangeTags
::canActivateTag( $tag )->isOK() ) {
255 $actionLinks[] = $linkRenderer->makeKnownLink(
256 $this->getPageTitle( 'activate' ),
257 $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 ( !$user->isAllowed( 'deletechangetags' ) ) {
336 throw new PermissionsError( 'deletechangetags' );
339 $out = $this->getOutput();
340 $out->setPageTitle( $this->msg( 'tags-delete-title' ) );
341 $out->addBacklinkSubtitle( $this->getPageTitle() );
343 // is the tag actually able to be deleted?
344 $canDeleteResult = ChangeTags
::canDeleteTag( $tag, $user );
345 if ( !$canDeleteResult->isGood() ) {
346 $out->wrapWikiTextAsInterface( 'error', $canDeleteResult->getWikiText() );
347 if ( !$canDeleteResult->isOK() ) {
352 $preText = $this->msg( 'tags-delete-explanation-initial', $tag )->parseAsBlock();
353 $tagUsage = ChangeTags
::tagUsageStatistics();
354 if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > 0 ) {
355 $preText .= $this->msg( 'tags-delete-explanation-in-use', $tag,
356 $tagUsage[$tag] )->parseAsBlock();
358 $preText .= $this->msg( 'tags-delete-explanation-warning', $tag )->parseAsBlock();
360 // see if the tag is in use
361 $this->softwareActivatedTags
= array_fill_keys(
362 ChangeTags
::listSoftwareActivatedTags(), true );
363 if ( isset( $this->softwareActivatedTags
[$tag] ) ) {
364 $preText .= $this->msg( 'tags-delete-explanation-active', $tag )->parseAsBlock();
368 $fields['Reason'] = [
370 'label' => $this->msg( 'tags-delete-reason' )->plain(),
373 $fields['HiddenTag'] = [
380 $form = HTMLForm
::factory( 'ooui', $fields, $this->getContext() );
381 $form->setAction( $this->getPageTitle( 'delete' )->getLocalURL() );
382 $form->tagAction
= 'delete'; // custom property on HTMLForm object
383 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
384 $form->setSubmitTextMsg( 'tags-delete-submit' );
385 $form->setSubmitDestructive(); // nasty!
386 $form->addPreText( $preText );
390 protected function showActivateDeactivateForm( $tag, $activate ) {
391 $actionStr = $activate ?
'activate' : 'deactivate';
393 $user = $this->getUser();
394 if ( !$user->isAllowed( 'managechangetags' ) ) {
395 throw new PermissionsError( 'managechangetags' );
398 $out = $this->getOutput();
399 // tags-activate-title, tags-deactivate-title
400 $out->setPageTitle( $this->msg( "tags-$actionStr-title" ) );
401 $out->addBacklinkSubtitle( $this->getPageTitle() );
403 // is it possible to do this?
404 $func = $activate ?
'canActivateTag' : 'canDeactivateTag';
405 $result = ChangeTags
::$func( $tag, $user );
406 if ( !$result->isGood() ) {
407 $out->wrapWikiTextAsInterface( 'error', $result->getWikiText() );
408 if ( !$result->isOK() ) {
413 // tags-activate-question, tags-deactivate-question
414 $preText = $this->msg( "tags-$actionStr-question", $tag )->parseAsBlock();
417 // tags-activate-reason, tags-deactivate-reason
418 $fields['Reason'] = [
420 'label' => $this->msg( "tags-$actionStr-reason" )->plain(),
423 $fields['HiddenTag'] = [
430 $form = HTMLForm
::factory( 'ooui', $fields, $this->getContext() );
431 $form->setAction( $this->getPageTitle( $actionStr )->getLocalURL() );
432 $form->tagAction
= $actionStr;
433 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
434 // tags-activate-submit, tags-deactivate-submit
435 $form->setSubmitTextMsg( "tags-$actionStr-submit" );
436 $form->addPreText( $preText );
440 public function processTagForm( array $data, HTMLForm
$form ) {
441 $context = $form->getContext();
442 $out = $context->getOutput();
444 $tag = $data['HiddenTag'];
445 $status = call_user_func( [ ChangeTags
::class, "{$form->tagAction}TagWithChecks" ],
446 $tag, $data['Reason'], $context->getUser(), true );
448 if ( $status->isGood() ) {
449 $out->redirect( $this->getPageTitle()->getLocalURL() );
451 } elseif ( $status->isOK() && $form->tagAction
=== 'delete' ) {
452 // deletion succeeded, but hooks raised a warning
453 $out->addWikiTextAsInterface( $this->msg( 'tags-delete-warnings-after-delete', $tag,
454 count( $status->getWarningsArray() ) )->text() . "\n" .
455 $status->getWikitext() );
456 $out->addReturnTo( $this->getPageTitle() );
459 $out->wrapWikiTextAsInterface( 'error', $status->getWikitext() );
465 * Return an array of subpages that this special page will accept.
467 * @return string[] subpages
469 public function getSubpagesForPrefixSearch() {
470 // The subpages does not have an own form, so not listing it at the moment
479 protected function getGroupName() {