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 $html = 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() ) :
151 // Used in #doTagRow()
152 $this->softwareActivatedTags = array_fill_keys(
153 ChangeTags::listSoftwareActivatedTags(), true );
155 // Insert tags that have been applied at least once
156 foreach ( $tagStats as $tag => $hitcount ) {
157 $html .= $this->doTagRow( $tag, $hitcount, $userCanManage,
158 $userCanDelete, $userCanEditInterface );
160 // Insert tags defined somewhere but never applied
161 foreach ( $definedTags as $tag ) {
162 if ( !isset( $tagStats[$tag] ) ) {
163 $html .= $this->doTagRow( $tag, 0, $userCanManage, $userCanDelete, $userCanEditInterface );
167 $out->addHTML( Xml::tags(
169 [ 'class' => 'mw-datatable sortable mw-tags-table' ],
174 function doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks ) {
176 $newRow .= Xml::tags( 'td', null, Xml::element( 'code', null, $tag ) );
178 $linkRenderer = $this->getLinkRenderer();
179 $disp = ChangeTags::tagDescription( $tag, $this->getContext() );
180 if ( $showEditLinks ) {
182 $editLink = $linkRenderer->makeLink(
183 $this->msg( "tag-$tag" )->inContentLanguage()->getTitle(),
184 $this->msg( 'tags-edit' )->text()
186 $disp .= $this->msg( 'parentheses' )->rawParams( $editLink )->escaped();
188 $newRow .= Xml::tags( 'td', null, $disp );
190 $msg = $this->msg( "tag-$tag-description" );
191 $desc = !$msg->exists() ? '' : $msg->parse();
192 if ( $showEditLinks ) {
194 $editDescLink = $linkRenderer->makeLink(
195 $this->msg( "tag-$tag-description" )->inContentLanguage()->getTitle(),
196 $this->msg( 'tags-edit' )->text()
198 $desc .= $this->msg( 'parentheses' )->rawParams( $editDescLink )->escaped();
200 $newRow .= Xml::tags( 'td', null, $desc );
203 $isSoftware = isset( $this->softwareDefinedTags[$tag] );
204 $isExplicit = isset( $this->explicitlyDefinedTags[$tag] );
206 // TODO: Rename this message
207 $sourceMsgs[] = $this->msg( 'tags-source-extension' )->escaped();
210 $sourceMsgs[] = $this->msg( 'tags-source-manual' )->escaped();
212 if ( !$sourceMsgs ) {
213 $sourceMsgs[] = $this->msg( 'tags-source-none' )->escaped();
215 $newRow .= Xml::tags( 'td', null, implode( Xml::element( 'br' ), $sourceMsgs ) );
217 $isActive = $isExplicit || isset( $this->softwareActivatedTags[$tag] );
218 $activeMsg = ( $isActive ? 'tags-active-yes' : 'tags-active-no' );
219 $newRow .= Xml::tags( 'td', null, $this->msg( $activeMsg )->escaped() );
221 $hitcountLabelMsg = $this->msg( 'tags-hitcount' )->numParams( $hitcount );
222 if ( $this->getConfig()->get( 'UseTagFilter' ) ) {
223 $hitcountLabel = $linkRenderer->makeLink(
224 SpecialPage::getTitleFor( 'Recentchanges' ),
225 $hitcountLabelMsg->text(),
227 [ 'tagfilter' => $tag ]
230 $hitcountLabel = $hitcountLabelMsg->escaped();
233 // add raw $hitcount for sorting, because tags-hitcount contains numbers and letters
234 $newRow .= Xml::tags( 'td', [ 'data-sort-value' => $hitcount ], $hitcountLabel );
240 if ( $showDeleteActions && ChangeTags::canDeleteTag( $tag )->isOK() ) {
241 $actionLinks[] = $linkRenderer->makeKnownLink(
242 $this->getPageTitle( 'delete' ),
243 $this->msg( 'tags-delete' )->text(),
248 if ( $showManageActions ) { // we've already checked that the user had the requisite userright
250 if ( ChangeTags::canActivateTag( $tag )->isOK() ) {
251 $actionLinks[] = $linkRenderer->makeKnownLink(
252 $this->getPageTitle( 'activate' ),
253 $this->msg( 'tags-activate' )->text(),
259 if ( ChangeTags::canDeactivateTag( $tag )->isOK() ) {
260 $actionLinks[] = $linkRenderer->makeKnownLink(
261 $this->getPageTitle( 'deactivate' ),
262 $this->msg( 'tags-deactivate' )->text(),
268 if ( $showDeleteActions || $showManageActions ) {
269 $newRow .= Xml::tags( 'td', null, $this->getLanguage()->pipeList( $actionLinks ) );
272 return Xml::tags( 'tr', null, $newRow ) . "\n";
275 public function processCreateTagForm( array $data, HTMLForm $form ) {
276 $context = $form->getContext();
277 $out = $context->getOutput();
279 $tag = trim( strval( $data['Tag'] ) );
280 $ignoreWarnings = isset( $data['IgnoreWarnings'] ) && $data['IgnoreWarnings'] === '1';
281 $status = ChangeTags::createTagWithChecks( $tag, $data['Reason'],
282 $context->getUser(), $ignoreWarnings );
284 if ( $status->isGood() ) {
285 $out->redirect( $this->getPageTitle()->getLocalURL() );
287 } elseif ( $status->isOK() ) {
288 // we have some warnings, so we show a confirmation form
292 'default' => $data['Tag'],
296 'default' => $data['Reason'],
298 'IgnoreWarnings' => [
304 // fool HTMLForm into thinking the form hasn't been submitted yet. Otherwise
305 // we get into an infinite loop!
306 $context->getRequest()->unsetVal( 'wpEditToken' );
308 $headerText = $this->msg( 'tags-create-warnings-above', $tag,
309 count( $status->getWarningsArray() ) )->parseAsBlock() .
310 $out->parse( $status->getWikiText() ) .
311 $this->msg( 'tags-create-warnings-below' )->parseAsBlock();
313 $subform = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
314 $subform->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
315 $subform->setWrapperLegendMsg( 'tags-create-heading' );
316 $subform->setHeaderText( $headerText );
317 $subform->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
318 $subform->setSubmitTextMsg( 'htmlform-yes' );
321 $out->addBacklinkSubtitle( $this->getPageTitle() );
324 $out->addWikiText( "<div class=\"error\">\n" . $status->getWikiText() .
330 protected function showDeleteTagForm( $tag ) {
331 $user = $this->getUser();
332 if ( !$user->isAllowed( 'deletechangetags' ) ) {
333 throw new PermissionsError( 'deletechangetags' );
336 $out = $this->getOutput();
337 $out->setPageTitle( $this->msg( 'tags-delete-title' ) );
338 $out->addBacklinkSubtitle( $this->getPageTitle() );
340 // is the tag actually able to be deleted?
341 $canDeleteResult = ChangeTags::canDeleteTag( $tag, $user );
342 if ( !$canDeleteResult->isGood() ) {
343 $out->addWikiText( "<div class=\"error\">\n" . $canDeleteResult->getWikiText() .
345 if ( !$canDeleteResult->isOK() ) {
350 $preText = $this->msg( 'tags-delete-explanation-initial', $tag )->parseAsBlock();
351 $tagUsage = ChangeTags::tagUsageStatistics();
352 if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > 0 ) {
353 $preText .= $this->msg( 'tags-delete-explanation-in-use', $tag,
354 $tagUsage[$tag] )->parseAsBlock();
356 $preText .= $this->msg( 'tags-delete-explanation-warning', $tag )->parseAsBlock();
358 // see if the tag is in use
359 $this->softwareActivatedTags = array_fill_keys(
360 ChangeTags::listSoftwareActivatedTags(), true );
361 if ( isset( $this->softwareActivatedTags[$tag] ) ) {
362 $preText .= $this->msg( 'tags-delete-explanation-active', $tag )->parseAsBlock();
366 $fields['Reason'] = [
368 'label' => $this->msg( 'tags-delete-reason' )->plain(),
371 $fields['HiddenTag'] = [
378 $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
379 $form->setAction( $this->getPageTitle( 'delete' )->getLocalURL() );
380 $form->tagAction = 'delete'; // custom property on HTMLForm object
381 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
382 $form->setSubmitTextMsg( 'tags-delete-submit' );
383 $form->setSubmitDestructive(); // nasty!
384 $form->addPreText( $preText );
388 protected function showActivateDeactivateForm( $tag, $activate ) {
389 $actionStr = $activate ? 'activate' : 'deactivate';
391 $user = $this->getUser();
392 if ( !$user->isAllowed( 'managechangetags' ) ) {
393 throw new PermissionsError( 'managechangetags' );
396 $out = $this->getOutput();
397 // tags-activate-title, tags-deactivate-title
398 $out->setPageTitle( $this->msg( "tags-$actionStr-title" ) );
399 $out->addBacklinkSubtitle( $this->getPageTitle() );
401 // is it possible to do this?
402 $func = $activate ? 'canActivateTag' : 'canDeactivateTag';
403 $result = ChangeTags::$func( $tag, $user );
404 if ( !$result->isGood() ) {
405 $out->addWikiText( "<div class=\"error\">\n" . $result->getWikiText() .
407 if ( !$result->isOK() ) {
412 // tags-activate-question, tags-deactivate-question
413 $preText = $this->msg( "tags-$actionStr-question", $tag )->parseAsBlock();
416 // tags-activate-reason, tags-deactivate-reason
417 $fields['Reason'] = [
419 'label' => $this->msg( "tags-$actionStr-reason" )->plain(),
422 $fields['HiddenTag'] = [
429 $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
430 $form->setAction( $this->getPageTitle( $actionStr )->getLocalURL() );
431 $form->tagAction = $actionStr;
432 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
433 // tags-activate-submit, tags-deactivate-submit
434 $form->setSubmitTextMsg( "tags-$actionStr-submit" );
435 $form->addPreText( $preText );
439 public function processTagForm( array $data, HTMLForm $form ) {
440 $context = $form->getContext();
441 $out = $context->getOutput();
443 $tag = $data['HiddenTag'];
444 $status = call_user_func( [ 'ChangeTags', "{$form->tagAction}TagWithChecks" ],
445 $tag, $data['Reason'], $context->getUser(), true );
447 if ( $status->isGood() ) {
448 $out->redirect( $this->getPageTitle()->getLocalURL() );
450 } elseif ( $status->isOK() && $form->tagAction === 'delete' ) {
451 // deletion succeeded, but hooks raised a warning
452 $out->addWikiText( $this->msg( 'tags-delete-warnings-after-delete', $tag,
453 count( $status->getWarningsArray() ) )->text() . "\n" .
454 $status->getWikitext() );
455 $out->addReturnTo( $this->getPageTitle() );
458 $out->addWikiText( "<div class=\"error\">\n" . $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() {