3 * Recent changes tagging.
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 Change tagging
24 use MediaWiki\MediaWikiServices
;
25 use Wikimedia\Rdbms\Database
;
29 * Can't delete tags with more than this many uses. Similar in intent to
30 * the bigdelete user right
31 * @todo Use the job queue for tag deletion to avoid this restriction
33 const MAX_DELETE_USES
= 5000;
38 private static $coreTags = [ 'mw-contentmodelchange' ];
41 * Creates HTML for the given tags
43 * @param string $tags Comma-separated list of tags
44 * @param string $page A label for the type of action which is being displayed,
45 * for example: 'history', 'contributions' or 'newpages'
46 * @param IContextSource|null $context
47 * @note Even though it takes null as a valid argument, an IContextSource is preferred
48 * in a new code, as the null value is subject to change in the future
49 * @return array Array with two items: (html, classes)
50 * - html: String: HTML for displaying the tags (empty string when param $tags is empty)
51 * - classes: Array of strings: CSS classes used in the generated html, one class for each tag
53 public static function formatSummaryRow( $tags, $page, IContextSource
$context = null ) {
58 $context = RequestContext
::getMain();
63 $tags = explode( ',', $tags );
65 foreach ( $tags as $tag ) {
69 $description = self
::tagDescription( $tag, $context );
70 if ( $description === false ) {
73 $displayTags[] = Xml
::tags(
75 [ 'class' => 'mw-tag-marker ' .
76 Sanitizer
::escapeClass( "mw-tag-marker-$tag" ) ],
79 $classes[] = Sanitizer
::escapeClass( "mw-tag-$tag" );
82 if ( !$displayTags ) {
86 $markers = $context->msg( 'tag-list-wrapper' )
87 ->numParams( count( $displayTags ) )
88 ->rawParams( $context->getLanguage()->commaList( $displayTags ) )
90 $markers = Xml
::tags( 'span', [ 'class' => 'mw-tag-markers' ], $markers );
92 return [ $markers, $classes ];
96 * Get a short description for a tag.
98 * Checks if message key "mediawiki:tag-$tag" exists. If it does not,
99 * returns the HTML-escaped tag name. Uses the message if the message
100 * exists, provided it is not disabled. If the message is disabled,
101 * we consider the tag hidden, and return false.
103 * @param string $tag Tag
104 * @param IContextSource $context
105 * @return string|bool Tag description or false if tag is to be hidden.
106 * @since 1.25 Returns false if tag is to be hidden.
108 public static function tagDescription( $tag, IContextSource
$context ) {
109 $msg = $context->msg( "tag-$tag" );
110 if ( !$msg->exists() ) {
111 // No such message, so return the HTML-escaped tag name.
112 return htmlspecialchars( $tag );
114 if ( $msg->isDisabled() ) {
115 // The message exists but is disabled, hide the tag.
119 // Message exists and isn't disabled, use it.
120 return $msg->parse();
124 * Get the message object for the tag's long description.
126 * Checks if message key "mediawiki:tag-$tag-description" exists. If it does not,
127 * or if message is disabled, returns false. Otherwise, returns the message object
128 * for the long description.
130 * @param string $tag Tag
131 * @param IContextSource $context
132 * @return Message|bool Message object of the tag long description or false if
133 * there is no description.
135 public static function tagLongDescriptionMessage( $tag, IContextSource
$context ) {
136 $msg = $context->msg( "tag-$tag-description" );
137 if ( !$msg->exists() ) {
140 if ( $msg->isDisabled() ) {
141 // The message exists but is disabled, hide the description.
145 // Message exists and isn't disabled, use it.
150 * Add tags to a change given its rc_id, rev_id and/or log_id
152 * @param string|string[] $tags Tags to add to the change
153 * @param int|null $rc_id The rc_id of the change to add the tags to
154 * @param int|null $rev_id The rev_id of the change to add the tags to
155 * @param int|null $log_id The log_id of the change to add the tags to
156 * @param string $params Params to put in the ct_params field of table 'change_tag'
157 * @param RecentChange|null $rc Recent change, in case the tagging accompanies the action
158 * (this should normally be the case)
160 * @throws MWException
161 * @return bool False if no changes are made, otherwise true
163 public static function addTags( $tags, $rc_id = null, $rev_id = null,
164 $log_id = null, $params = null, RecentChange
$rc = null
166 $result = self
::updateTags( $tags, null, $rc_id, $rev_id, $log_id, $params, $rc );
167 return (bool)$result[0];
171 * Add and remove tags to/from a change given its rc_id, rev_id and/or log_id,
172 * without verifying that the tags exist or are valid. If a tag is present in
173 * both $tagsToAdd and $tagsToRemove, it will be removed.
175 * This function should only be used by extensions to manipulate tags they
176 * have registered using the ListDefinedTags hook. When dealing with user
177 * input, call updateTagsWithChecks() instead.
179 * @param string|array|null $tagsToAdd Tags to add to the change
180 * @param string|array|null $tagsToRemove Tags to remove from the change
181 * @param int|null &$rc_id The rc_id of the change to add the tags to.
182 * Pass a variable whose value is null if the rc_id is not relevant or unknown.
183 * @param int|null &$rev_id The rev_id of the change to add the tags to.
184 * Pass a variable whose value is null if the rev_id is not relevant or unknown.
185 * @param int|null &$log_id The log_id of the change to add the tags to.
186 * Pass a variable whose value is null if the log_id is not relevant or unknown.
187 * @param string $params Params to put in the ct_params field of table
188 * 'change_tag' when adding tags
189 * @param RecentChange|null $rc Recent change being tagged, in case the tagging accompanies
191 * @param User|null $user Tagging user, in case the tagging is subsequent to the tagged action
193 * @throws MWException When $rc_id, $rev_id and $log_id are all null
194 * @return array Index 0 is an array of tags actually added, index 1 is an
195 * array of tags actually removed, index 2 is an array of tags present on the
196 * revision or log entry before any changes were made
200 public static function updateTags( $tagsToAdd, $tagsToRemove, &$rc_id = null,
201 &$rev_id = null, &$log_id = null, $params = null, RecentChange
$rc = null,
204 $tagsToAdd = array_filter( (array)$tagsToAdd ); // Make sure we're submitting all tags...
205 $tagsToRemove = array_filter( (array)$tagsToRemove );
207 if ( !$rc_id && !$rev_id && !$log_id ) {
208 throw new MWException( 'At least one of: RCID, revision ID, and log ID MUST be ' .
209 'specified when adding or removing a tag from a change!' );
212 $dbw = wfGetDB( DB_MASTER
);
214 // Might as well look for rcids and so on.
216 // Info might be out of date, somewhat fractionally, on replica DB.
217 // LogEntry/LogPage and WikiPage match rev/log/rc timestamps,
218 // so use that relation to avoid full table scans.
220 $rc_id = $dbw->selectField(
221 [ 'logging', 'recentchanges' ],
225 'rc_timestamp = log_timestamp',
230 } elseif ( $rev_id ) {
231 $rc_id = $dbw->selectField(
232 [ 'revision', 'recentchanges' ],
236 'rc_timestamp = rev_timestamp',
237 'rc_this_oldid = rev_id'
242 } elseif ( !$log_id && !$rev_id ) {
243 // Info might be out of date, somewhat fractionally, on replica DB.
244 $log_id = $dbw->selectField(
247 [ 'rc_id' => $rc_id ],
250 $rev_id = $dbw->selectField(
253 [ 'rc_id' => $rc_id ],
258 if ( $log_id && !$rev_id ) {
259 $rev_id = $dbw->selectField(
262 [ 'ls_field' => 'associated_rev_id', 'ls_log_id' => $log_id ],
265 } elseif ( !$log_id && $rev_id ) {
266 $log_id = $dbw->selectField(
269 [ 'ls_field' => 'associated_rev_id', 'ls_value' => $rev_id ],
274 // update the tag_summary row
276 if ( !self
::updateTagSummaryRow( $tagsToAdd, $tagsToRemove, $rc_id, $rev_id,
280 return [ [], [], $prevTags ];
283 // insert a row into change_tag for each new tag
284 if ( count( $tagsToAdd ) ) {
286 foreach ( $tagsToAdd as $tag ) {
287 // Filter so we don't insert NULLs as zero accidentally.
288 // Keep in mind that $rc_id === null means "I don't care/know about the
289 // rc_id, just delete $tag on this revision/log entry". It doesn't
290 // mean "only delete tags on this revision/log WHERE rc_id IS NULL".
291 $tagsRows[] = array_filter(
294 'ct_rc_id' => $rc_id,
295 'ct_log_id' => $log_id,
296 'ct_rev_id' => $rev_id,
297 'ct_params' => $params
302 $dbw->insert( 'change_tag', $tagsRows, __METHOD__
, [ 'IGNORE' ] );
305 // delete from change_tag
306 if ( count( $tagsToRemove ) ) {
307 foreach ( $tagsToRemove as $tag ) {
308 $conds = array_filter(
311 'ct_rc_id' => $rc_id,
312 'ct_log_id' => $log_id,
313 'ct_rev_id' => $rev_id
316 $dbw->delete( 'change_tag', $conds, __METHOD__
);
320 self
::purgeTagUsageCache();
322 Hooks
::run( 'ChangeTagsAfterUpdateTags', [ $tagsToAdd, $tagsToRemove, $prevTags,
323 $rc_id, $rev_id, $log_id, $params, $rc, $user ] );
325 return [ $tagsToAdd, $tagsToRemove, $prevTags ];
329 * Adds or removes a given set of tags to/from the relevant row of the
330 * tag_summary table. Modifies the tagsToAdd and tagsToRemove arrays to
331 * reflect the tags that were actually added and/or removed.
333 * @param array &$tagsToAdd
334 * @param array &$tagsToRemove If a tag is present in both $tagsToAdd and
335 * $tagsToRemove, it will be removed
336 * @param int|null $rc_id Null if not known or not applicable
337 * @param int|null $rev_id Null if not known or not applicable
338 * @param int|null $log_id Null if not known or not applicable
339 * @param array &$prevTags Optionally outputs a list of the tags that were
340 * in the tag_summary row to begin with
341 * @return bool True if any modifications were made, otherwise false
344 protected static function updateTagSummaryRow( &$tagsToAdd, &$tagsToRemove,
345 $rc_id, $rev_id, $log_id, &$prevTags = []
347 $dbw = wfGetDB( DB_MASTER
);
349 $tsConds = array_filter( [
350 'ts_rc_id' => $rc_id,
351 'ts_rev_id' => $rev_id,
352 'ts_log_id' => $log_id
355 // Can't both add and remove a tag at the same time...
356 $tagsToAdd = array_diff( $tagsToAdd, $tagsToRemove );
358 // Update the summary row.
359 // $prevTags can be out of date on replica DBs, especially when addTags is called consecutively,
360 // causing loss of tags added recently in tag_summary table.
361 $prevTags = $dbw->selectField( 'tag_summary', 'ts_tags', $tsConds, __METHOD__
);
362 $prevTags = $prevTags ?
$prevTags : '';
363 $prevTags = array_filter( explode( ',', $prevTags ) );
366 $tagsToAdd = array_values( array_diff( $tagsToAdd, $prevTags ) );
367 $newTags = array_unique( array_merge( $prevTags, $tagsToAdd ) );
370 $tagsToRemove = array_values( array_intersect( $tagsToRemove, $newTags ) );
371 $newTags = array_values( array_diff( $newTags, $tagsToRemove ) );
375 if ( $prevTags == $newTags ) {
381 // no tags left, so delete the row altogether
382 $dbw->delete( 'tag_summary', $tsConds, __METHOD__
);
384 $dbw->replace( 'tag_summary',
385 [ 'ts_rev_id', 'ts_rc_id', 'ts_log_id' ],
386 array_filter( array_merge( $tsConds, [ 'ts_tags' => implode( ',', $newTags ) ] ) ),
395 * Helper function to generate a fatal status with a 'not-allowed' type error.
397 * @param string $msgOne Message key to use in the case of one tag
398 * @param string $msgMulti Message key to use in the case of more than one tag
399 * @param array $tags Restricted tags (passed as $1 into the message, count of
400 * $tags passed as $2)
404 protected static function restrictedTagError( $msgOne, $msgMulti, $tags ) {
405 $lang = RequestContext
::getMain()->getLanguage();
406 $count = count( $tags );
407 return Status
::newFatal( ( $count > 1 ) ?
$msgMulti : $msgOne,
408 $lang->commaList( $tags ), $count );
412 * Is it OK to allow the user to apply all the specified tags at the same time
413 * as they edit/make the change?
415 * @param array $tags Tags that you are interested in applying
416 * @param User|null $user User whose permission you wish to check, or null if
417 * you don't care (e.g. maintenance scripts)
421 public static function canAddTagsAccompanyingChange( array $tags, User
$user = null ) {
422 if ( !is_null( $user ) ) {
423 if ( !$user->isAllowed( 'applychangetags' ) ) {
424 return Status
::newFatal( 'tags-apply-no-permission' );
425 } elseif ( $user->isBlocked() ) {
426 return Status
::newFatal( 'tags-apply-blocked', $user->getName() );
430 // to be applied, a tag has to be explicitly defined
431 $allowedTags = self
::listExplicitlyDefinedTags();
432 Hooks
::run( 'ChangeTagsAllowedAdd', [ &$allowedTags, $tags, $user ] );
433 $disallowedTags = array_diff( $tags, $allowedTags );
434 if ( $disallowedTags ) {
435 return self
::restrictedTagError( 'tags-apply-not-allowed-one',
436 'tags-apply-not-allowed-multi', $disallowedTags );
439 return Status
::newGood();
443 * Adds tags to a given change, checking whether it is allowed first, but
444 * without adding a log entry. Useful for cases where the tag is being added
445 * along with the action that generated the change (e.g. tagging an edit as
448 * Extensions should not use this function, unless directly handling a user
449 * request to add a particular tag. Normally, extensions should call
450 * ChangeTags::updateTags() instead.
452 * @param array $tags Tags to apply
453 * @param int|null $rc_id The rc_id of the change to add the tags to
454 * @param int|null $rev_id The rev_id of the change to add the tags to
455 * @param int|null $log_id The log_id of the change to add the tags to
456 * @param string $params Params to put in the ct_params field of table
457 * 'change_tag' when adding tags
458 * @param User $user Who to give credit for the action
462 public static function addTagsAccompanyingChangeWithChecks(
463 array $tags, $rc_id, $rev_id, $log_id, $params, User
$user
465 // are we allowed to do this?
466 $result = self
::canAddTagsAccompanyingChange( $tags, $user );
467 if ( !$result->isOK() ) {
468 $result->value
= null;
473 self
::addTags( $tags, $rc_id, $rev_id, $log_id, $params );
475 return Status
::newGood( true );
479 * Is it OK to allow the user to adds and remove the given tags tags to/from a
482 * @param array $tagsToAdd Tags that you are interested in adding
483 * @param array $tagsToRemove Tags that you are interested in removing
484 * @param User|null $user User whose permission you wish to check, or null if
485 * you don't care (e.g. maintenance scripts)
489 public static function canUpdateTags( array $tagsToAdd, array $tagsToRemove,
492 if ( !is_null( $user ) ) {
493 if ( !$user->isAllowed( 'changetags' ) ) {
494 return Status
::newFatal( 'tags-update-no-permission' );
495 } elseif ( $user->isBlocked() ) {
496 return Status
::newFatal( 'tags-update-blocked', $user->getName() );
501 // to be added, a tag has to be explicitly defined
502 // @todo Allow extensions to define tags that can be applied by users...
503 $explicitlyDefinedTags = self
::listExplicitlyDefinedTags();
504 $diff = array_diff( $tagsToAdd, $explicitlyDefinedTags );
506 return self
::restrictedTagError( 'tags-update-add-not-allowed-one',
507 'tags-update-add-not-allowed-multi', $diff );
511 if ( $tagsToRemove ) {
512 // to be removed, a tag must not be defined by an extension, or equivalently it
513 // has to be either explicitly defined or not defined at all
514 // (assuming no edge case of a tag both explicitly-defined and extension-defined)
515 $softwareDefinedTags = self
::listSoftwareDefinedTags();
516 $intersect = array_intersect( $tagsToRemove, $softwareDefinedTags );
518 return self
::restrictedTagError( 'tags-update-remove-not-allowed-one',
519 'tags-update-remove-not-allowed-multi', $intersect );
523 return Status
::newGood();
527 * Adds and/or removes tags to/from a given change, checking whether it is
528 * allowed first, and adding a log entry afterwards.
530 * Includes a call to ChangeTag::canUpdateTags(), so your code doesn't need
531 * to do that. However, it doesn't check whether the *_id parameters are a
532 * valid combination. That is up to you to enforce. See ApiTag::execute() for
535 * @param array|null $tagsToAdd If none, pass array() or null
536 * @param array|null $tagsToRemove If none, pass array() or null
537 * @param int|null $rc_id The rc_id of the change to add the tags to
538 * @param int|null $rev_id The rev_id of the change to add the tags to
539 * @param int|null $log_id The log_id of the change to add the tags to
540 * @param string $params Params to put in the ct_params field of table
541 * 'change_tag' when adding tags
542 * @param string $reason Comment for the log
543 * @param User $user Who to give credit for the action
544 * @return Status If successful, the value of this Status object will be an
545 * object (stdClass) with the following fields:
546 * - logId: the ID of the added log entry, or null if no log entry was added
547 * (i.e. no operation was performed)
548 * - addedTags: an array containing the tags that were actually added
549 * - removedTags: an array containing the tags that were actually removed
552 public static function updateTagsWithChecks( $tagsToAdd, $tagsToRemove,
553 $rc_id, $rev_id, $log_id, $params, $reason, User
$user
555 if ( is_null( $tagsToAdd ) ) {
558 if ( is_null( $tagsToRemove ) ) {
561 if ( !$tagsToAdd && !$tagsToRemove ) {
562 // no-op, don't bother
563 return Status
::newGood( (object)[
570 // are we allowed to do this?
571 $result = self
::canUpdateTags( $tagsToAdd, $tagsToRemove, $user );
572 if ( !$result->isOK() ) {
573 $result->value
= null;
577 // basic rate limiting
578 if ( $user->pingLimiter( 'changetag' ) ) {
579 return Status
::newFatal( 'actionthrottledtext' );
583 list( $tagsAdded, $tagsRemoved, $initialTags ) = self
::updateTags( $tagsToAdd,
584 $tagsToRemove, $rc_id, $rev_id, $log_id, $params, null, $user );
585 if ( !$tagsAdded && !$tagsRemoved ) {
586 // no-op, don't log it
587 return Status
::newGood( (object)[
595 $logEntry = new ManualLogEntry( 'tag', 'update' );
596 $logEntry->setPerformer( $user );
597 $logEntry->setComment( $reason );
599 // find the appropriate target page
601 $rev = Revision
::newFromId( $rev_id );
603 $logEntry->setTarget( $rev->getTitle() );
605 } elseif ( $log_id ) {
606 // This function is from revision deletion logic and has nothing to do with
607 // change tags, but it appears to be the only other place in core where we
608 // perform logged actions on log items.
609 $logEntry->setTarget( RevDelLogList
::suggestTarget( null, [ $log_id ] ) );
612 if ( !$logEntry->getTarget() ) {
613 // target is required, so we have to set something
614 $logEntry->setTarget( SpecialPage
::getTitleFor( 'Tags' ) );
618 '4::revid' => $rev_id,
619 '5::logid' => $log_id,
620 '6:list:tagsAdded' => $tagsAdded,
621 '7:number:tagsAddedCount' => count( $tagsAdded ),
622 '8:list:tagsRemoved' => $tagsRemoved,
623 '9:number:tagsRemovedCount' => count( $tagsRemoved ),
624 'initialTags' => $initialTags,
626 $logEntry->setParameters( $logParams );
627 $logEntry->setRelations( [ 'Tag' => array_merge( $tagsAdded, $tagsRemoved ) ] );
629 $dbw = wfGetDB( DB_MASTER
);
630 $logId = $logEntry->insert( $dbw );
631 // Only send this to UDP, not RC, similar to patrol events
632 $logEntry->publish( $logId, 'udp' );
634 return Status
::newGood( (object)[
636 'addedTags' => $tagsAdded,
637 'removedTags' => $tagsRemoved,
642 * Applies all tags-related changes to a query.
643 * Handles selecting tags, and filtering.
644 * Needs $tables to be set up properly, so we can figure out which join conditions to use.
646 * @param string|array $tables Table names, see Database::select
647 * @param string|array $fields Fields used in query, see Database::select
648 * @param string|array $conds Conditions used in query, see Database::select
649 * @param array $join_conds Join conditions, see Database::select
650 * @param array $options Options, see Database::select
651 * @param bool|string $filter_tag Tag to select on
653 * @throws MWException When unable to determine appropriate JOIN condition for tagging
655 public static function modifyDisplayQuery( &$tables, &$fields, &$conds,
656 &$join_conds, &$options, $filter_tag = false ) {
657 global $wgRequest, $wgUseTagFilter;
659 if ( $filter_tag === false ) {
660 $filter_tag = $wgRequest->getVal( 'tagfilter' );
663 // Figure out which conditions can be done.
664 if ( in_array( 'recentchanges', $tables ) ) {
665 $join_cond = 'ct_rc_id=rc_id';
666 } elseif ( in_array( 'logging', $tables ) ) {
667 $join_cond = 'ct_log_id=log_id';
668 } elseif ( in_array( 'revision', $tables ) ) {
669 $join_cond = 'ct_rev_id=rev_id';
670 } elseif ( in_array( 'archive', $tables ) ) {
671 $join_cond = 'ct_rev_id=ar_rev_id';
673 throw new MWException( 'Unable to determine appropriate JOIN condition for tagging.' );
676 $fields['ts_tags'] = wfGetDB( DB_REPLICA
)->buildGroupConcatField(
677 ',', 'change_tag', 'ct_tag', $join_cond
680 if ( $wgUseTagFilter && $filter_tag ) {
681 // Somebody wants to filter on a tag.
682 // Add an INNER JOIN on change_tag
684 $tables[] = 'change_tag';
685 $join_conds['change_tag'] = [ 'INNER JOIN', $join_cond ];
686 $conds['ct_tag'] = explode( '|', $filter_tag );
691 * Build a text box to select a change tag
693 * @param string $selected Tag to select by default
694 * @param bool $ooui Use an OOUI TextInputWidget as selector instead of a non-OOUI input field
695 * You need to call OutputPage::enableOOUI() yourself.
696 * @param IContextSource|null $context
697 * @note Even though it takes null as a valid argument, an IContextSource is preferred
698 * in a new code, as the null value can change in the future
699 * @return array an array of (label, selector)
701 public static function buildTagFilterSelector(
702 $selected = '', $ooui = false, IContextSource
$context = null
705 $context = RequestContext
::getMain();
708 $config = $context->getConfig();
709 if ( !$config->get( 'UseTagFilter' ) ||
!count( self
::listDefinedTags() ) ) {
716 [ 'for' => 'tagfilter' ],
717 $context->msg( 'tag-filter' )->parse()
722 $data[] = new OOUI\
TextInputWidget( [
724 'name' => 'tagfilter',
725 'value' => $selected,
726 'classes' => 'mw-tagfilter-input',
729 $data[] = Xml
::input(
733 [ 'class' => 'mw-tagfilter-input mw-ui-input mw-ui-input-inline', 'id' => 'tagfilter' ]
741 * Defines a tag in the valid_tag table, without checking that the tag name
743 * Extensions should NOT use this function; they can use the ListDefinedTags
746 * @param string $tag Tag to create
749 public static function defineTag( $tag ) {
750 $dbw = wfGetDB( DB_MASTER
);
751 $dbw->replace( 'valid_tag',
753 [ 'vt_tag' => $tag ],
756 // clear the memcache of defined tags
757 self
::purgeTagCacheAll();
761 * Removes a tag from the valid_tag table. The tag may remain in use by
762 * extensions, and may still show up as 'defined' if an extension is setting
763 * it from the ListDefinedTags hook.
765 * @param string $tag Tag to remove
768 public static function undefineTag( $tag ) {
769 $dbw = wfGetDB( DB_MASTER
);
770 $dbw->delete( 'valid_tag', [ 'vt_tag' => $tag ], __METHOD__
);
772 // clear the memcache of defined tags
773 self
::purgeTagCacheAll();
777 * Writes a tag action into the tag management log.
779 * @param string $action
781 * @param string $reason
782 * @param User $user Who to attribute the action to
783 * @param int $tagCount For deletion only, how many usages the tag had before
785 * @param array $logEntryTags Change tags to apply to the entry
786 * that will be created in the tag management log
787 * @return int ID of the inserted log entry
790 protected static function logTagManagementAction( $action, $tag, $reason,
791 User
$user, $tagCount = null, array $logEntryTags = []
793 $dbw = wfGetDB( DB_MASTER
);
795 $logEntry = new ManualLogEntry( 'managetags', $action );
796 $logEntry->setPerformer( $user );
797 // target page is not relevant, but it has to be set, so we just put in
798 // the title of Special:Tags
799 $logEntry->setTarget( Title
::newFromText( 'Special:Tags' ) );
800 $logEntry->setComment( $reason );
802 $params = [ '4::tag' => $tag ];
803 if ( !is_null( $tagCount ) ) {
804 $params['5:number:count'] = $tagCount;
806 $logEntry->setParameters( $params );
807 $logEntry->setRelations( [ 'Tag' => $tag ] );
808 $logEntry->setTags( $logEntryTags );
810 $logId = $logEntry->insert( $dbw );
811 $logEntry->publish( $logId );
816 * Is it OK to allow the user to activate this tag?
818 * @param string $tag Tag that you are interested in activating
819 * @param User|null $user User whose permission you wish to check, or null if
820 * you don't care (e.g. maintenance scripts)
824 public static function canActivateTag( $tag, User
$user = null ) {
825 if ( !is_null( $user ) ) {
826 if ( !$user->isAllowed( 'managechangetags' ) ) {
827 return Status
::newFatal( 'tags-manage-no-permission' );
828 } elseif ( $user->isBlocked() ) {
829 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
833 // defined tags cannot be activated (a defined tag is either extension-
834 // defined, in which case the extension chooses whether or not to active it;
835 // or user-defined, in which case it is considered active)
836 $definedTags = self
::listDefinedTags();
837 if ( in_array( $tag, $definedTags ) ) {
838 return Status
::newFatal( 'tags-activate-not-allowed', $tag );
841 // non-existing tags cannot be activated
842 $tagUsage = self
::tagUsageStatistics();
843 if ( !isset( $tagUsage[$tag] ) ) { // we already know the tag is undefined
844 return Status
::newFatal( 'tags-activate-not-found', $tag );
847 return Status
::newGood();
851 * Activates a tag, checking whether it is allowed first, and adding a log
854 * Includes a call to ChangeTag::canActivateTag(), so your code doesn't need
858 * @param string $reason
859 * @param User $user Who to give credit for the action
860 * @param bool $ignoreWarnings Can be used for API interaction, default false
861 * @param array $logEntryTags Change tags to apply to the entry
862 * that will be created in the tag management log
863 * @return Status If successful, the Status contains the ID of the added log
867 public static function activateTagWithChecks( $tag, $reason, User
$user,
868 $ignoreWarnings = false, array $logEntryTags = []
870 // are we allowed to do this?
871 $result = self
::canActivateTag( $tag, $user );
872 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
873 $result->value
= null;
878 self
::defineTag( $tag );
881 $logId = self
::logTagManagementAction( 'activate', $tag, $reason, $user,
882 null, $logEntryTags );
884 return Status
::newGood( $logId );
888 * Is it OK to allow the user to deactivate this tag?
890 * @param string $tag Tag that you are interested in deactivating
891 * @param User|null $user User whose permission you wish to check, or null if
892 * you don't care (e.g. maintenance scripts)
896 public static function canDeactivateTag( $tag, User
$user = null ) {
897 if ( !is_null( $user ) ) {
898 if ( !$user->isAllowed( 'managechangetags' ) ) {
899 return Status
::newFatal( 'tags-manage-no-permission' );
900 } elseif ( $user->isBlocked() ) {
901 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
905 // only explicitly-defined tags can be deactivated
906 $explicitlyDefinedTags = self
::listExplicitlyDefinedTags();
907 if ( !in_array( $tag, $explicitlyDefinedTags ) ) {
908 return Status
::newFatal( 'tags-deactivate-not-allowed', $tag );
910 return Status
::newGood();
914 * Deactivates a tag, checking whether it is allowed first, and adding a log
917 * Includes a call to ChangeTag::canDeactivateTag(), so your code doesn't need
921 * @param string $reason
922 * @param User $user Who to give credit for the action
923 * @param bool $ignoreWarnings Can be used for API interaction, default false
924 * @param array $logEntryTags Change tags to apply to the entry
925 * that will be created in the tag management log
926 * @return Status If successful, the Status contains the ID of the added log
930 public static function deactivateTagWithChecks( $tag, $reason, User
$user,
931 $ignoreWarnings = false, array $logEntryTags = []
933 // are we allowed to do this?
934 $result = self
::canDeactivateTag( $tag, $user );
935 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
936 $result->value
= null;
941 self
::undefineTag( $tag );
944 $logId = self
::logTagManagementAction( 'deactivate', $tag, $reason, $user,
945 null, $logEntryTags );
947 return Status
::newGood( $logId );
951 * Is the tag name valid?
953 * @param string $tag Tag that you are interested in creating
957 public static function isTagNameValid( $tag ) {
960 return Status
::newFatal( 'tags-create-no-name' );
963 // tags cannot contain commas (used as a delimiter in tag_summary table),
964 // pipe (used as a delimiter between multiple tags in
965 // modifyDisplayQuery), or slashes (would break tag description messages in
966 // MediaWiki namespace)
967 if ( strpos( $tag, ',' ) !== false ||
strpos( $tag, '|' ) !== false
968 ||
strpos( $tag, '/' ) !== false ) {
969 return Status
::newFatal( 'tags-create-invalid-chars' );
972 // could the MediaWiki namespace description messages be created?
973 $title = Title
::makeTitleSafe( NS_MEDIAWIKI
, "Tag-$tag-description" );
974 if ( is_null( $title ) ) {
975 return Status
::newFatal( 'tags-create-invalid-title-chars' );
978 return Status
::newGood();
982 * Is it OK to allow the user to create this tag?
984 * @param string $tag Tag that you are interested in creating
985 * @param User|null $user User whose permission you wish to check, or null if
986 * you don't care (e.g. maintenance scripts)
990 public static function canCreateTag( $tag, User
$user = null ) {
991 if ( !is_null( $user ) ) {
992 if ( !$user->isAllowed( 'managechangetags' ) ) {
993 return Status
::newFatal( 'tags-manage-no-permission' );
994 } elseif ( $user->isBlocked() ) {
995 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
999 $status = self
::isTagNameValid( $tag );
1000 if ( !$status->isGood() ) {
1004 // does the tag already exist?
1005 $tagUsage = self
::tagUsageStatistics();
1006 if ( isset( $tagUsage[$tag] ) ||
in_array( $tag, self
::listDefinedTags() ) ) {
1007 return Status
::newFatal( 'tags-create-already-exists', $tag );
1011 $canCreateResult = Status
::newGood();
1012 Hooks
::run( 'ChangeTagCanCreate', [ $tag, $user, &$canCreateResult ] );
1013 return $canCreateResult;
1017 * Creates a tag by adding a row to the `valid_tag` table.
1019 * Includes a call to ChangeTag::canDeleteTag(), so your code doesn't need to
1022 * @param string $tag
1023 * @param string $reason
1024 * @param User $user Who to give credit for the action
1025 * @param bool $ignoreWarnings Can be used for API interaction, default false
1026 * @param array $logEntryTags Change tags to apply to the entry
1027 * that will be created in the tag management log
1028 * @return Status If successful, the Status contains the ID of the added log
1029 * entry as its value
1032 public static function createTagWithChecks( $tag, $reason, User
$user,
1033 $ignoreWarnings = false, array $logEntryTags = []
1035 // are we allowed to do this?
1036 $result = self
::canCreateTag( $tag, $user );
1037 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
1038 $result->value
= null;
1043 self
::defineTag( $tag );
1046 $logId = self
::logTagManagementAction( 'create', $tag, $reason, $user,
1047 null, $logEntryTags );
1049 return Status
::newGood( $logId );
1053 * Permanently removes all traces of a tag from the DB. Good for removing
1054 * misspelt or temporary tags.
1056 * This function should be directly called by maintenance scripts only, never
1057 * by user-facing code. See deleteTagWithChecks() for functionality that can
1058 * safely be exposed to users.
1060 * @param string $tag Tag to remove
1061 * @return Status The returned status will be good unless a hook changed it
1064 public static function deleteTagEverywhere( $tag ) {
1065 $dbw = wfGetDB( DB_MASTER
);
1066 $dbw->startAtomic( __METHOD__
);
1068 // delete from valid_tag
1069 self
::undefineTag( $tag );
1071 // find out which revisions use this tag, so we can delete from tag_summary
1072 $result = $dbw->select( 'change_tag',
1073 [ 'ct_rc_id', 'ct_log_id', 'ct_rev_id', 'ct_tag' ],
1074 [ 'ct_tag' => $tag ],
1076 foreach ( $result as $row ) {
1077 // remove the tag from the relevant row of tag_summary
1079 $tagsToRemove = [ $tag ];
1080 self
::updateTagSummaryRow( $tagsToAdd, $tagsToRemove, $row->ct_rc_id
,
1081 $row->ct_rev_id
, $row->ct_log_id
);
1084 // delete from change_tag
1085 $dbw->delete( 'change_tag', [ 'ct_tag' => $tag ], __METHOD__
);
1087 $dbw->endAtomic( __METHOD__
);
1089 // give extensions a chance
1090 $status = Status
::newGood();
1091 Hooks
::run( 'ChangeTagAfterDelete', [ $tag, &$status ] );
1092 // let's not allow error results, as the actual tag deletion succeeded
1093 if ( !$status->isOK() ) {
1094 wfDebug( 'ChangeTagAfterDelete error condition downgraded to warning' );
1095 $status->setOK( true );
1098 // clear the memcache of defined tags
1099 self
::purgeTagCacheAll();
1105 * Is it OK to allow the user to delete this tag?
1107 * @param string $tag Tag that you are interested in deleting
1108 * @param User|null $user User whose permission you wish to check, or null if
1109 * you don't care (e.g. maintenance scripts)
1113 public static function canDeleteTag( $tag, User
$user = null ) {
1114 $tagUsage = self
::tagUsageStatistics();
1116 if ( !is_null( $user ) ) {
1117 if ( !$user->isAllowed( 'deletechangetags' ) ) {
1118 return Status
::newFatal( 'tags-delete-no-permission' );
1119 } elseif ( $user->isBlocked() ) {
1120 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
1124 if ( !isset( $tagUsage[$tag] ) && !in_array( $tag, self
::listDefinedTags() ) ) {
1125 return Status
::newFatal( 'tags-delete-not-found', $tag );
1128 if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > self
::MAX_DELETE_USES
) {
1129 return Status
::newFatal( 'tags-delete-too-many-uses', $tag, self
::MAX_DELETE_USES
);
1132 $softwareDefined = self
::listSoftwareDefinedTags();
1133 if ( in_array( $tag, $softwareDefined ) ) {
1134 // extension-defined tags can't be deleted unless the extension
1135 // specifically allows it
1136 $status = Status
::newFatal( 'tags-delete-not-allowed' );
1138 // user-defined tags are deletable unless otherwise specified
1139 $status = Status
::newGood();
1142 Hooks
::run( 'ChangeTagCanDelete', [ $tag, $user, &$status ] );
1147 * Deletes a tag, checking whether it is allowed first, and adding a log entry
1150 * Includes a call to ChangeTag::canDeleteTag(), so your code doesn't need to
1153 * @param string $tag
1154 * @param string $reason
1155 * @param User $user Who to give credit for the action
1156 * @param bool $ignoreWarnings Can be used for API interaction, default false
1157 * @param array $logEntryTags Change tags to apply to the entry
1158 * that will be created in the tag management log
1159 * @return Status If successful, the Status contains the ID of the added log
1160 * entry as its value
1163 public static function deleteTagWithChecks( $tag, $reason, User
$user,
1164 $ignoreWarnings = false, array $logEntryTags = []
1166 // are we allowed to do this?
1167 $result = self
::canDeleteTag( $tag, $user );
1168 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
1169 $result->value
= null;
1173 // store the tag usage statistics
1174 $tagUsage = self
::tagUsageStatistics();
1175 $hitcount = isset( $tagUsage[$tag] ) ?
$tagUsage[$tag] : 0;
1178 $deleteResult = self
::deleteTagEverywhere( $tag );
1179 if ( !$deleteResult->isOK() ) {
1180 return $deleteResult;
1184 $logId = self
::logTagManagementAction( 'delete', $tag, $reason, $user,
1185 $hitcount, $logEntryTags );
1187 $deleteResult->value
= $logId;
1188 return $deleteResult;
1192 * Lists those tags which core or extensions report as being "active".
1197 public static function listSoftwareActivatedTags() {
1199 $tags = self
::$coreTags;
1200 if ( !Hooks
::isRegistered( 'ChangeTagsListActive' ) ) {
1203 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1204 return $cache->getWithSetCallback(
1205 $cache->makeKey( 'active-tags' ),
1206 WANObjectCache
::TTL_MINUTE
* 5,
1207 function ( $oldValue, &$ttl, array &$setOpts ) use ( $tags ) {
1208 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
1210 // Ask extensions which tags they consider active
1211 Hooks
::run( 'ChangeTagsListActive', [ &$tags ] );
1215 'checkKeys' => [ $cache->makeKey( 'active-tags' ) ],
1216 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1217 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1223 * @see listSoftwareActivatedTags
1224 * @deprecated since 1.28 call listSoftwareActivatedTags directly
1227 public static function listExtensionActivatedTags() {
1228 wfDeprecated( __METHOD__
, '1.28' );
1229 return self
::listSoftwareActivatedTags();
1233 * Basically lists defined tags which count even if they aren't applied to anything.
1234 * It returns a union of the results of listExplicitlyDefinedTags() and
1235 * listExtensionDefinedTags().
1237 * @return string[] Array of strings: tags
1239 public static function listDefinedTags() {
1240 $tags1 = self
::listExplicitlyDefinedTags();
1241 $tags2 = self
::listSoftwareDefinedTags();
1242 return array_values( array_unique( array_merge( $tags1, $tags2 ) ) );
1246 * Lists tags explicitly defined in the `valid_tag` table of the database.
1247 * Tags in table 'change_tag' which are not in table 'valid_tag' are not
1250 * Tries memcached first.
1252 * @return string[] Array of strings: tags
1255 public static function listExplicitlyDefinedTags() {
1256 $fname = __METHOD__
;
1258 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1259 return $cache->getWithSetCallback(
1260 $cache->makeKey( 'valid-tags-db' ),
1261 WANObjectCache
::TTL_MINUTE
* 5,
1262 function ( $oldValue, &$ttl, array &$setOpts ) use ( $fname ) {
1263 $dbr = wfGetDB( DB_REPLICA
);
1265 $setOpts +
= Database
::getCacheSetOptions( $dbr );
1267 $tags = $dbr->selectFieldValues( 'valid_tag', 'vt_tag', [], $fname );
1269 return array_filter( array_unique( $tags ) );
1272 'checkKeys' => [ $cache->makeKey( 'valid-tags-db' ) ],
1273 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1274 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1280 * Lists tags defined by core or extensions using the ListDefinedTags hook.
1281 * Extensions need only define those tags they deem to be in active use.
1283 * Tries memcached first.
1285 * @return string[] Array of strings: tags
1288 public static function listSoftwareDefinedTags() {
1289 // core defined tags
1290 $tags = self
::$coreTags;
1291 if ( !Hooks
::isRegistered( 'ListDefinedTags' ) ) {
1294 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1295 return $cache->getWithSetCallback(
1296 $cache->makeKey( 'valid-tags-hook' ),
1297 WANObjectCache
::TTL_MINUTE
* 5,
1298 function ( $oldValue, &$ttl, array &$setOpts ) use ( $tags ) {
1299 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
1301 Hooks
::run( 'ListDefinedTags', [ &$tags ] );
1302 return array_filter( array_unique( $tags ) );
1305 'checkKeys' => [ $cache->makeKey( 'valid-tags-hook' ) ],
1306 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1307 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1313 * Call listSoftwareDefinedTags directly
1315 * @see listSoftwareDefinedTags
1316 * @deprecated since 1.28
1318 public static function listExtensionDefinedTags() {
1319 wfDeprecated( __METHOD__
, '1.28' );
1320 return self
::listSoftwareDefinedTags();
1324 * Invalidates the short-term cache of defined tags used by the
1325 * list*DefinedTags functions, as well as the tag statistics cache.
1328 public static function purgeTagCacheAll() {
1329 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1331 $cache->touchCheckKey( $cache->makeKey( 'active-tags' ) );
1332 $cache->touchCheckKey( $cache->makeKey( 'valid-tags-db' ) );
1333 $cache->touchCheckKey( $cache->makeKey( 'valid-tags-hook' ) );
1335 self
::purgeTagUsageCache();
1339 * Invalidates the tag statistics cache only.
1342 public static function purgeTagUsageCache() {
1343 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1345 $cache->touchCheckKey( $cache->makeKey( 'change-tag-statistics' ) );
1349 * Returns a map of any tags used on the wiki to number of edits
1350 * tagged with them, ordered descending by the hitcount.
1351 * This does not include tags defined somewhere that have never been applied.
1353 * Keeps a short-term cache in memory, so calling this multiple times in the
1354 * same request should be fine.
1356 * @return array Array of string => int
1358 public static function tagUsageStatistics() {
1359 $fname = __METHOD__
;
1360 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1361 return $cache->getWithSetCallback(
1362 $cache->makeKey( 'change-tag-statistics' ),
1363 WANObjectCache
::TTL_MINUTE
* 5,
1364 function ( $oldValue, &$ttl, array &$setOpts ) use ( $fname ) {
1365 $dbr = wfGetDB( DB_REPLICA
, 'vslow' );
1367 $setOpts +
= Database
::getCacheSetOptions( $dbr );
1369 $res = $dbr->select(
1371 [ 'ct_tag', 'hitcount' => 'count(*)' ],
1374 [ 'GROUP BY' => 'ct_tag', 'ORDER BY' => 'hitcount DESC' ]
1378 foreach ( $res as $row ) {
1379 $out[$row->ct_tag
] = $row->hitcount
;
1385 'checkKeys' => [ $cache->makeKey( 'change-tag-statistics' ) ],
1386 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1387 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1393 * Indicate whether change tag editing UI is relevant
1395 * Returns true if the user has the necessary right and there are any
1396 * editable tags defined.
1398 * This intentionally doesn't check "any addable || any deletable", because
1399 * it seems like it would be more confusing than useful if the checkboxes
1400 * suddenly showed up because some abuse filter stopped defining a tag and
1401 * then suddenly disappeared when someone deleted all uses of that tag.
1406 public static function showTagEditingUI( User
$user ) {
1407 return $user->isAllowed( 'changetags' ) && (bool)self
::listExplicitlyDefinedTags();