API: Some raw message cleanup
[mediawiki.git] / includes / specials / SpecialTags.php
blob47bed626428a45e08ad74501eda620d21bdd5ca1
1 <?php
2 /**
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
20 * @file
21 * @ingroup SpecialPage
24 /**
25 * A special page that lists tags for edits
27 * @ingroup SpecialPage
29 class SpecialTags extends SpecialPage {
31 /**
32 * @var array List of explicitly defined tags
34 protected $explicitlyDefinedTags;
36 /**
37 * @var array List of extension defined tags
39 protected $extensionDefinedTags;
41 /**
42 * @var array List of extension activated tags
44 protected $extensionActivatedTags;
46 function __construct() {
47 parent::__construct( 'Tags' );
50 function execute( $par ) {
51 $this->setHeaders();
52 $this->outputHeader();
54 $request = $this->getRequest();
55 switch ( $par ) {
56 case 'delete':
57 $this->showDeleteTagForm( $request->getVal( 'tag' ) );
58 break;
59 case 'activate':
60 $this->showActivateDeactivateForm( $request->getVal( 'tag' ), true );
61 break;
62 case 'deactivate':
63 $this->showActivateDeactivateForm( $request->getVal( 'tag' ), false );
64 break;
65 case 'create':
66 // fall through, thanks to HTMLForm's logic
67 default:
68 $this->showTagList();
69 break;
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 ) {
85 $fields = [
86 'Tag' => [
87 'type' => 'text',
88 'label' => $this->msg( 'tags-create-tag-name' )->plain(),
89 'required' => true,
91 'Reason' => [
92 'type' => 'text',
93 'label' => $this->msg( 'tags-create-reason' )->plain(),
94 'size' => 50,
96 'IgnoreWarnings' => [
97 'type' => 'hidden',
101 $form = new HTMLForm( $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' );
107 $form->show();
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 slave, because the slave 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() !== '' ) {
117 return;
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->extensionDefinedTags = array_fill_keys(
128 ChangeTags::listExtensionDefinedTags(), true );
130 // List all defined tags, even if they were never applied
131 $definedTags = array_keys( $this->explicitlyDefinedTags + $this->extensionDefinedTags );
133 // Show header only if there exists atleast one tag
134 if ( !$tagStats && !$definedTags ) {
135 return;
138 // Write the headers
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() ) :
148 '' )
151 // Used in #doTagRow()
152 $this->extensionActivatedTags = array_fill_keys(
153 ChangeTags::listExtensionActivatedTags(), 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(
168 'table',
169 [ 'class' => 'mw-datatable sortable mw-tags-table' ],
170 $html
171 ) );
174 function doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks ) {
175 $newRow = '';
176 $newRow .= Xml::tags( 'td', null, Xml::element( 'code', null, $tag ) );
178 $linkRenderer = $this->getLinkRenderer();
179 $disp = ChangeTags::tagDescription( $tag );
180 if ( $showEditLinks ) {
181 $disp .= ' ';
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 ) {
193 $desc .= ' ';
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 );
202 $sourceMsgs = [];
203 $isExtension = isset( $this->extensionDefinedTags[$tag] );
204 $isExplicit = isset( $this->explicitlyDefinedTags[$tag] );
205 if ( $isExtension ) {
206 $sourceMsgs[] = $this->msg( 'tags-source-extension' )->escaped();
208 if ( $isExplicit ) {
209 $sourceMsgs[] = $this->msg( 'tags-source-manual' )->escaped();
211 if ( !$sourceMsgs ) {
212 $sourceMsgs[] = $this->msg( 'tags-source-none' )->escaped();
214 $newRow .= Xml::tags( 'td', null, implode( Xml::element( 'br' ), $sourceMsgs ) );
216 $isActive = $isExplicit || isset( $this->extensionActivatedTags[$tag] );
217 $activeMsg = ( $isActive ? 'tags-active-yes' : 'tags-active-no' );
218 $newRow .= Xml::tags( 'td', null, $this->msg( $activeMsg )->escaped() );
220 $hitcountLabelMsg = $this->msg( 'tags-hitcount' )->numParams( $hitcount );
221 if ( $this->getConfig()->get( 'UseTagFilter' ) ) {
222 $hitcountLabel = $linkRenderer->makeLink(
223 SpecialPage::getTitleFor( 'Recentchanges' ),
224 $hitcountLabelMsg->text(),
226 [ 'tagfilter' => $tag ]
228 } else {
229 $hitcountLabel = $hitcountLabelMsg->escaped();
232 // add raw $hitcount for sorting, because tags-hitcount contains numbers and letters
233 $newRow .= Xml::tags( 'td', [ 'data-sort-value' => $hitcount ], $hitcountLabel );
235 // actions
236 $actionLinks = [];
238 // delete
239 if ( $showDeleteActions && ChangeTags::canDeleteTag( $tag )->isOK() ) {
240 $actionLinks[] = $linkRenderer->makeKnownLink(
241 $this->getPageTitle( 'delete' ),
242 $this->msg( 'tags-delete' )->text(),
244 [ 'tag' => $tag ] );
247 if ( $showManageActions ) { // we've already checked that the user had the requisite userright
249 // activate
250 if ( ChangeTags::canActivateTag( $tag )->isOK() ) {
251 $actionLinks[] = $linkRenderer->makeKnownLink(
252 $this->getPageTitle( 'activate' ),
253 $this->msg( 'tags-activate' )->text(),
255 [ 'tag' => $tag ] );
258 // deactivate
259 if ( ChangeTags::canDeactivateTag( $tag )->isOK() ) {
260 $actionLinks[] = $linkRenderer->makeKnownLink(
261 $this->getPageTitle( 'deactivate' ),
262 $this->msg( 'tags-deactivate' )->text(),
264 [ 'tag' => $tag ] );
269 if ( $showDeleteActions || $showManageActions ) {
270 $newRow .= Xml::tags( 'td', null, $this->getLanguage()->pipeList( $actionLinks ) );
273 return Xml::tags( 'tr', null, $newRow ) . "\n";
276 public function processCreateTagForm( array $data, HTMLForm $form ) {
277 $context = $form->getContext();
278 $out = $context->getOutput();
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 );
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'],
295 'Reason' => [
296 'type' => 'hidden',
297 'default' => $data['Reason'],
299 'IgnoreWarnings' => [
300 'type' => 'hidden',
301 'default' => '1',
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' );
309 $headerText = $this->msg( 'tags-create-warnings-above', $tag,
310 count( $status->getWarningsArray() ) )->parseAsBlock() .
311 $out->parse( $status->getWikiText() ) .
312 $this->msg( 'tags-create-warnings-below' )->parseAsBlock();
314 $subform = new HTMLForm( $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();
322 $out->addBacklinkSubtitle( $this->getPageTitle() );
323 return true;
324 } else {
325 $out->addWikiText( "<div class=\"error\">\n" . $status->getWikiText() .
326 "\n</div>" );
327 return false;
331 protected function showDeleteTagForm( $tag ) {
332 $user = $this->getUser();
333 if ( !$user->isAllowed( 'deletechangetags' ) ) {
334 throw new PermissionsError( 'deletechangetags' );
337 $out = $this->getOutput();
338 $out->setPageTitle( $this->msg( 'tags-delete-title' ) );
339 $out->addBacklinkSubtitle( $this->getPageTitle() );
341 // is the tag actually able to be deleted?
342 $canDeleteResult = ChangeTags::canDeleteTag( $tag, $user );
343 if ( !$canDeleteResult->isGood() ) {
344 $out->addWikiText( "<div class=\"error\">\n" . $canDeleteResult->getWikiText() .
345 "\n</div>" );
346 if ( !$canDeleteResult->isOK() ) {
347 return;
351 $preText = $this->msg( 'tags-delete-explanation-initial', $tag )->parseAsBlock();
352 $tagUsage = ChangeTags::tagUsageStatistics();
353 if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > 0 ) {
354 $preText .= $this->msg( 'tags-delete-explanation-in-use', $tag,
355 $tagUsage[$tag] )->parseAsBlock();
357 $preText .= $this->msg( 'tags-delete-explanation-warning', $tag )->parseAsBlock();
359 // see if the tag is in use
360 $this->extensionActivatedTags = array_fill_keys(
361 ChangeTags::listExtensionActivatedTags(), true );
362 if ( isset( $this->extensionActivatedTags[$tag] ) ) {
363 $preText .= $this->msg( 'tags-delete-explanation-active', $tag )->parseAsBlock();
366 $fields = [];
367 $fields['Reason'] = [
368 'type' => 'text',
369 'label' => $this->msg( 'tags-delete-reason' )->plain(),
370 'size' => 50,
372 $fields['HiddenTag'] = [
373 'type' => 'hidden',
374 'name' => 'tag',
375 'default' => $tag,
376 'required' => true,
379 $form = new HTMLForm( $fields, $this->getContext() );
380 $form->setAction( $this->getPageTitle( 'delete' )->getLocalURL() );
381 $form->tagAction = 'delete'; // custom property on HTMLForm object
382 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
383 $form->setSubmitTextMsg( 'tags-delete-submit' );
384 $form->setSubmitDestructive(); // nasty!
385 $form->addPreText( $preText );
386 $form->show();
389 protected function showActivateDeactivateForm( $tag, $activate ) {
390 $actionStr = $activate ? 'activate' : 'deactivate';
392 $user = $this->getUser();
393 if ( !$user->isAllowed( 'managechangetags' ) ) {
394 throw new PermissionsError( 'managechangetags' );
397 $out = $this->getOutput();
398 // tags-activate-title, tags-deactivate-title
399 $out->setPageTitle( $this->msg( "tags-$actionStr-title" ) );
400 $out->addBacklinkSubtitle( $this->getPageTitle() );
402 // is it possible to do this?
403 $func = $activate ? 'canActivateTag' : 'canDeactivateTag';
404 $result = ChangeTags::$func( $tag, $user );
405 if ( !$result->isGood() ) {
406 $out->addWikiText( "<div class=\"error\">\n" . $result->getWikiText() .
407 "\n</div>" );
408 if ( !$result->isOK() ) {
409 return;
413 // tags-activate-question, tags-deactivate-question
414 $preText = $this->msg( "tags-$actionStr-question", $tag )->parseAsBlock();
416 $fields = [];
417 // tags-activate-reason, tags-deactivate-reason
418 $fields['Reason'] = [
419 'type' => 'text',
420 'label' => $this->msg( "tags-$actionStr-reason" )->plain(),
421 'size' => 50,
423 $fields['HiddenTag'] = [
424 'type' => 'hidden',
425 'name' => 'tag',
426 'default' => $tag,
427 'required' => true,
430 $form = new HTMLForm( $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 );
437 $form->show();
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', "{$form->tagAction}TagWithChecks" ],
446 $tag, $data['Reason'], $context->getUser(), true );
448 if ( $status->isGood() ) {
449 $out->redirect( $this->getPageTitle()->getLocalURL() );
450 return true;
451 } elseif ( $status->isOK() && $form->tagAction === 'delete' ) {
452 // deletion succeeded, but hooks raised a warning
453 $out->addWikiText( $this->msg( 'tags-delete-warnings-after-delete', $tag,
454 count( $status->getWarningsArray() ) )->text() . "\n" .
455 $status->getWikitext() );
456 $out->addReturnTo( $this->getPageTitle() );
457 return true;
458 } else {
459 $out->addWikiText( "<div class=\"error\">\n" . $status->getWikitext() .
460 "\n</div>" );
461 return false;
466 * Return an array of subpages that this special page will accept.
468 * @return string[] subpages
470 public function getSubpagesForPrefixSearch() {
471 // The subpages does not have an own form, so not listing it at the moment
472 return [
473 // 'delete',
474 // 'activate',
475 // 'deactivate',
476 // 'create',
480 protected function getGroupName() {
481 return 'changes';