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 MediaWiki\Storage\NameTableAccessException
;
26 use Wikimedia\Rdbms\Database
;
30 * Can't delete tags with more than this many uses. Similar in intent to
31 * the bigdelete user right
32 * @todo Use the job queue for tag deletion to avoid this restriction
34 const MAX_DELETE_USES
= 5000;
37 * A list of tags defined and used by MediaWiki itself.
39 private static $definedSoftwareTags = [
40 'mw-contentmodelchange',
42 'mw-removed-redirect',
43 'mw-changed-redirect-target',
51 * Loads defined core tags, checks for invalid types (if not array),
52 * and filters for supported and enabled (if $all is false) tags only.
54 * @param bool $all If true, return all valid defined tags. Otherwise, return only enabled ones.
55 * @return array Array of all defined/enabled tags.
57 public static function getSoftwareTags( $all = false ) {
58 global $wgSoftwareTags;
61 if ( !is_array( $wgSoftwareTags ) ) {
62 wfWarn( 'wgSoftwareTags should be associative array of enabled tags.
63 Please refer to documentation for the list of tags you can enable' );
67 $availableSoftwareTags = !$all ?
68 array_keys( array_filter( $wgSoftwareTags ) ) :
69 array_keys( $wgSoftwareTags );
71 $softwareTags = array_intersect(
72 $availableSoftwareTags,
73 self
::$definedSoftwareTags
80 * Creates HTML for the given tags
82 * @param string $tags Comma-separated list of tags
83 * @param string $page A label for the type of action which is being displayed,
84 * for example: 'history', 'contributions' or 'newpages'
85 * @param IContextSource|null $context
86 * @note Even though it takes null as a valid argument, an IContextSource is preferred
87 * in a new code, as the null value is subject to change in the future
88 * @return array Array with two items: (html, classes)
89 * - html: String: HTML for displaying the tags (empty string when param $tags is empty)
90 * - classes: Array of strings: CSS classes used in the generated html, one class for each tag
91 * @return-taint onlysafefor_htmlnoent
93 public static function formatSummaryRow( $tags, $page, IContextSource
$context = null ) {
98 $context = RequestContext
::getMain();
103 $tags = explode( ',', $tags );
105 foreach ( $tags as $tag ) {
109 $description = self
::tagDescription( $tag, $context );
110 if ( $description === false ) {
113 $displayTags[] = Xml
::tags(
115 [ 'class' => 'mw-tag-marker ' .
116 Sanitizer
::escapeClass( "mw-tag-marker-$tag" ) ],
119 $classes[] = Sanitizer
::escapeClass( "mw-tag-$tag" );
122 if ( !$displayTags ) {
126 $markers = $context->msg( 'tag-list-wrapper' )
127 ->numParams( count( $displayTags ) )
128 ->rawParams( $context->getLanguage()->commaList( $displayTags ) )
130 $markers = Xml
::tags( 'span', [ 'class' => 'mw-tag-markers' ], $markers );
132 return [ $markers, $classes ];
136 * Get a short description for a tag.
138 * Checks if message key "mediawiki:tag-$tag" exists. If it does not,
139 * returns the HTML-escaped tag name. Uses the message if the message
140 * exists, provided it is not disabled. If the message is disabled,
141 * we consider the tag hidden, and return false.
144 * @param IContextSource $context
145 * @return string|bool Tag description or false if tag is to be hidden.
146 * @since 1.25 Returns false if tag is to be hidden.
148 public static function tagDescription( $tag, IContextSource
$context ) {
149 $msg = $context->msg( "tag-$tag" );
150 if ( !$msg->exists() ) {
151 // No such message, so return the HTML-escaped tag name.
152 return htmlspecialchars( $tag );
154 if ( $msg->isDisabled() ) {
155 // The message exists but is disabled, hide the tag.
159 // Message exists and isn't disabled, use it.
160 return $msg->parse();
164 * Get the message object for the tag's long description.
166 * Checks if message key "mediawiki:tag-$tag-description" exists. If it does not,
167 * or if message is disabled, returns false. Otherwise, returns the message object
168 * for the long description.
171 * @param IContextSource $context
172 * @return Message|bool Message object of the tag long description or false if
173 * there is no description.
175 public static function tagLongDescriptionMessage( $tag, IContextSource
$context ) {
176 $msg = $context->msg( "tag-$tag-description" );
177 if ( !$msg->exists() ) {
180 if ( $msg->isDisabled() ) {
181 // The message exists but is disabled, hide the description.
185 // Message exists and isn't disabled, use it.
190 * Get truncated message for the tag's long description.
192 * @param string $tag Tag name.
193 * @param int $length Maximum length of truncated message, including ellipsis.
194 * @param IContextSource $context
196 * @return string Truncated long tag description.
198 public static function truncateTagDescription( $tag, $length, IContextSource
$context ) {
199 $originalDesc = self
::tagLongDescriptionMessage( $tag, $context );
200 // If there is no tag description, return empty string
201 if ( !$originalDesc ) {
205 $taglessDesc = Sanitizer
::stripAllTags( $originalDesc->parse() );
207 return $context->getLanguage()->truncateForVisual( $taglessDesc, $length );
211 * Add tags to a change given its rc_id, rev_id and/or log_id
213 * @param string|string[] $tags Tags to add to the change
214 * @param int|null $rc_id The rc_id of the change to add the tags to
215 * @param int|null $rev_id The rev_id of the change to add the tags to
216 * @param int|null $log_id The log_id of the change to add the tags to
217 * @param string|null $params Params to put in the ct_params field of table 'change_tag'
218 * @param RecentChange|null $rc Recent change, in case the tagging accompanies the action
219 * (this should normally be the case)
221 * @throws MWException
222 * @return bool False if no changes are made, otherwise true
224 public static function addTags( $tags, $rc_id = null, $rev_id = null,
225 $log_id = null, $params = null, RecentChange
$rc = null
227 $result = self
::updateTags( $tags, null, $rc_id, $rev_id, $log_id, $params, $rc );
228 return (bool)$result[0];
232 * Add and remove tags to/from a change given its rc_id, rev_id and/or log_id,
233 * without verifying that the tags exist or are valid. If a tag is present in
234 * both $tagsToAdd and $tagsToRemove, it will be removed.
236 * This function should only be used by extensions to manipulate tags they
237 * have registered using the ListDefinedTags hook. When dealing with user
238 * input, call updateTagsWithChecks() instead.
240 * @param string|array|null $tagsToAdd Tags to add to the change
241 * @param string|array|null $tagsToRemove Tags to remove from the change
242 * @param int|null &$rc_id The rc_id of the change to add the tags to.
243 * Pass a variable whose value is null if the rc_id is not relevant or unknown.
244 * @param int|null &$rev_id The rev_id of the change to add the tags to.
245 * Pass a variable whose value is null if the rev_id is not relevant or unknown.
246 * @param int|null &$log_id The log_id of the change to add the tags to.
247 * Pass a variable whose value is null if the log_id is not relevant or unknown.
248 * @param string|null $params Params to put in the ct_params field of table
249 * 'change_tag' when adding tags
250 * @param RecentChange|null $rc Recent change being tagged, in case the tagging accompanies
252 * @param User|null $user Tagging user, in case the tagging is subsequent to the tagged action
254 * @throws MWException When $rc_id, $rev_id and $log_id are all null
255 * @return array Index 0 is an array of tags actually added, index 1 is an
256 * array of tags actually removed, index 2 is an array of tags present on the
257 * revision or log entry before any changes were made
261 public static function updateTags( $tagsToAdd, $tagsToRemove, &$rc_id = null,
262 &$rev_id = null, &$log_id = null, $params = null, RecentChange
$rc = null,
265 global $wgChangeTagsSchemaMigrationStage;
267 $tagsToAdd = array_filter( (array)$tagsToAdd ); // Make sure we're submitting all tags...
268 $tagsToRemove = array_filter( (array)$tagsToRemove );
270 if ( !$rc_id && !$rev_id && !$log_id ) {
271 throw new MWException( 'At least one of: RCID, revision ID, and log ID MUST be ' .
272 'specified when adding or removing a tag from a change!' );
275 $dbw = wfGetDB( DB_MASTER
);
277 // Might as well look for rcids and so on.
279 // Info might be out of date, somewhat fractionally, on replica DB.
280 // LogEntry/LogPage and WikiPage match rev/log/rc timestamps,
281 // so use that relation to avoid full table scans.
283 $rc_id = $dbw->selectField(
284 [ 'logging', 'recentchanges' ],
288 'rc_timestamp = log_timestamp',
293 } elseif ( $rev_id ) {
294 $rc_id = $dbw->selectField(
295 [ 'revision', 'recentchanges' ],
299 'rc_timestamp = rev_timestamp',
300 'rc_this_oldid = rev_id'
305 } elseif ( !$log_id && !$rev_id ) {
306 // Info might be out of date, somewhat fractionally, on replica DB.
307 $log_id = $dbw->selectField(
310 [ 'rc_id' => $rc_id ],
313 $rev_id = $dbw->selectField(
316 [ 'rc_id' => $rc_id ],
321 if ( $log_id && !$rev_id ) {
322 $rev_id = $dbw->selectField(
325 [ 'ls_field' => 'associated_rev_id', 'ls_log_id' => $log_id ],
328 } elseif ( !$log_id && $rev_id ) {
329 $log_id = $dbw->selectField(
332 [ 'ls_field' => 'associated_rev_id', 'ls_value' => $rev_id ],
337 // update the tag_summary row
339 if ( !self
::updateTagSummaryRow( $tagsToAdd, $tagsToRemove, $rc_id, $rev_id,
343 return [ [], [], $prevTags ];
346 // insert a row into change_tag for each new tag
347 $changeTagDefStore = MediaWikiServices
::getInstance()->getChangeTagDefStore();
348 if ( count( $tagsToAdd ) ) {
349 $changeTagMapping = [];
350 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
) {
351 foreach ( $tagsToAdd as $tag ) {
352 $changeTagMapping[$tag] = $changeTagDefStore->acquireId( $tag );
354 // T207881: update the counts at the end of the transaction
355 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $tagsToAdd ) {
358 [ 'ctd_count = ctd_count + 1' ],
359 [ 'ctd_name' => $tagsToAdd ],
366 foreach ( $tagsToAdd as $tag ) {
367 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH
) {
372 // Filter so we don't insert NULLs as zero accidentally.
373 // Keep in mind that $rc_id === null means "I don't care/know about the
374 // rc_id, just delete $tag on this revision/log entry". It doesn't
375 // mean "only delete tags on this revision/log WHERE rc_id IS NULL".
376 $tagsRows[] = array_filter(
378 'ct_tag' => $tagName,
379 'ct_rc_id' => $rc_id,
380 'ct_log_id' => $log_id,
381 'ct_rev_id' => $rev_id,
382 'ct_params' => $params,
383 'ct_tag_id' => $changeTagMapping[$tag] ??
null,
389 $dbw->insert( 'change_tag', $tagsRows, __METHOD__
, [ 'IGNORE' ] );
392 // delete from change_tag
393 if ( count( $tagsToRemove ) ) {
394 foreach ( $tagsToRemove as $tag ) {
395 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH
) {
397 $tagId = $changeTagDefStore->getId( $tag );
402 $conds = array_filter(
404 'ct_tag' => $tagName,
405 'ct_rc_id' => $rc_id,
406 'ct_log_id' => $log_id,
407 'ct_rev_id' => $rev_id,
408 'ct_tag_id' => $tagId,
411 $dbw->delete( 'change_tag', $conds, __METHOD__
);
412 if ( $dbw->affectedRows() && $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
) {
413 // T207881: update the counts at the end of the transaction
414 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $tag ) {
417 [ 'ctd_count = ctd_count - 1' ],
418 [ 'ctd_name' => $tag ],
424 [ 'ctd_name' => $tag, 'ctd_count' => 0, 'ctd_user_defined' => 0 ],
432 self
::purgeTagUsageCache();
434 Hooks
::run( 'ChangeTagsAfterUpdateTags', [ $tagsToAdd, $tagsToRemove, $prevTags,
435 $rc_id, $rev_id, $log_id, $params, $rc, $user ] );
437 return [ $tagsToAdd, $tagsToRemove, $prevTags ];
441 * Adds or removes a given set of tags to/from the relevant row of the
442 * tag_summary table. Modifies the tagsToAdd and tagsToRemove arrays to
443 * reflect the tags that were actually added and/or removed.
445 * @param array &$tagsToAdd
446 * @param array &$tagsToRemove If a tag is present in both $tagsToAdd and
447 * $tagsToRemove, it will be removed
448 * @param int|null $rc_id Null if not known or not applicable
449 * @param int|null $rev_id Null if not known or not applicable
450 * @param int|null $log_id Null if not known or not applicable
451 * @param array &$prevTags Optionally outputs a list of the tags that were
452 * in the tag_summary row to begin with
453 * @return bool True if any modifications were made, otherwise false
456 protected static function updateTagSummaryRow( &$tagsToAdd, &$tagsToRemove,
457 $rc_id, $rev_id, $log_id, &$prevTags = []
459 $dbw = wfGetDB( DB_MASTER
);
461 $tsConds = array_filter( [
462 'ts_rc_id' => $rc_id,
463 'ts_rev_id' => $rev_id,
464 'ts_log_id' => $log_id
467 // Can't both add and remove a tag at the same time...
468 $tagsToAdd = array_diff( $tagsToAdd, $tagsToRemove );
470 // Update the summary row.
471 // $prevTags can be out of date on replica DBs, especially when addTags is called consecutively,
472 // causing loss of tags added recently in tag_summary table.
473 $prevTags = $dbw->selectField( 'tag_summary', 'ts_tags', $tsConds, __METHOD__
);
474 $prevTags = $prevTags ?
: '';
475 $prevTags = array_filter( explode( ',', $prevTags ) );
478 $tagsToAdd = array_values( array_diff( $tagsToAdd, $prevTags ) );
479 $newTags = array_unique( array_merge( $prevTags, $tagsToAdd ) );
482 $tagsToRemove = array_values( array_intersect( $tagsToRemove, $newTags ) );
483 $newTags = array_values( array_diff( $newTags, $tagsToRemove ) );
487 if ( $prevTags == $newTags ) {
492 // No tags left, so delete the row altogether
493 $dbw->delete( 'tag_summary', $tsConds, __METHOD__
);
495 // Specify the non-DEFAULT value columns in the INSERT/REPLACE clause
496 $row = array_filter( [ 'ts_tags' => implode( ',', $newTags ) ] +
$tsConds );
497 // Check the unique keys for conflicts, ignoring any NULL *_id values
499 foreach ( [ 'ts_rev_id', 'ts_rc_id', 'ts_log_id' ] as $uniqueColumn ) {
500 if ( isset( $row[$uniqueColumn] ) ) {
501 $uniqueKeys[] = [ $uniqueColumn ];
505 $dbw->replace( 'tag_summary', $uniqueKeys, $row, __METHOD__
);
512 * Helper function to generate a fatal status with a 'not-allowed' type error.
514 * @param string $msgOne Message key to use in the case of one tag
515 * @param string $msgMulti Message key to use in the case of more than one tag
516 * @param array $tags Restricted tags (passed as $1 into the message, count of
517 * $tags passed as $2)
521 protected static function restrictedTagError( $msgOne, $msgMulti, $tags ) {
522 $lang = RequestContext
::getMain()->getLanguage();
523 $count = count( $tags );
524 return Status
::newFatal( ( $count > 1 ) ?
$msgMulti : $msgOne,
525 $lang->commaList( $tags ), $count );
529 * Is it OK to allow the user to apply all the specified tags at the same time
530 * as they edit/make the change?
532 * Extensions should not use this function, unless directly handling a user
533 * request to add a tag to a revision or log entry that the user is making.
535 * @param array $tags Tags that you are interested in applying
536 * @param User|null $user User whose permission you wish to check, or null to
537 * check for a generic non-blocked user with the relevant rights
541 public static function canAddTagsAccompanyingChange( array $tags, User
$user = null ) {
542 if ( !is_null( $user ) ) {
543 if ( !$user->isAllowed( 'applychangetags' ) ) {
544 return Status
::newFatal( 'tags-apply-no-permission' );
545 } elseif ( $user->isBlocked() ) {
546 return Status
::newFatal( 'tags-apply-blocked', $user->getName() );
550 // to be applied, a tag has to be explicitly defined
551 $allowedTags = self
::listExplicitlyDefinedTags();
552 Hooks
::run( 'ChangeTagsAllowedAdd', [ &$allowedTags, $tags, $user ] );
553 $disallowedTags = array_diff( $tags, $allowedTags );
554 if ( $disallowedTags ) {
555 return self
::restrictedTagError( 'tags-apply-not-allowed-one',
556 'tags-apply-not-allowed-multi', $disallowedTags );
559 return Status
::newGood();
563 * Adds tags to a given change, checking whether it is allowed first, but
564 * without adding a log entry. Useful for cases where the tag is being added
565 * along with the action that generated the change (e.g. tagging an edit as
568 * Extensions should not use this function, unless directly handling a user
569 * request to add a particular tag. Normally, extensions should call
570 * ChangeTags::updateTags() instead.
572 * @param array $tags Tags to apply
573 * @param int|null $rc_id The rc_id of the change to add the tags to
574 * @param int|null $rev_id The rev_id of the change to add the tags to
575 * @param int|null $log_id The log_id of the change to add the tags to
576 * @param string $params Params to put in the ct_params field of table
577 * 'change_tag' when adding tags
578 * @param User $user Who to give credit for the action
582 public static function addTagsAccompanyingChangeWithChecks(
583 array $tags, $rc_id, $rev_id, $log_id, $params, User
$user
585 // are we allowed to do this?
586 $result = self
::canAddTagsAccompanyingChange( $tags, $user );
587 if ( !$result->isOK() ) {
588 $result->value
= null;
593 self
::addTags( $tags, $rc_id, $rev_id, $log_id, $params );
595 return Status
::newGood( true );
599 * Is it OK to allow the user to adds and remove the given tags tags to/from a
602 * Extensions should not use this function, unless directly handling a user
603 * request to add or remove tags from an existing revision or log entry.
605 * @param array $tagsToAdd Tags that you are interested in adding
606 * @param array $tagsToRemove Tags that you are interested in removing
607 * @param User|null $user User whose permission you wish to check, or null to
608 * check for a generic non-blocked user with the relevant rights
612 public static function canUpdateTags( array $tagsToAdd, array $tagsToRemove,
615 if ( !is_null( $user ) ) {
616 if ( !$user->isAllowed( 'changetags' ) ) {
617 return Status
::newFatal( 'tags-update-no-permission' );
618 } elseif ( $user->isBlocked() ) {
619 return Status
::newFatal( 'tags-update-blocked', $user->getName() );
624 // to be added, a tag has to be explicitly defined
625 // @todo Allow extensions to define tags that can be applied by users...
626 $explicitlyDefinedTags = self
::listExplicitlyDefinedTags();
627 $diff = array_diff( $tagsToAdd, $explicitlyDefinedTags );
629 return self
::restrictedTagError( 'tags-update-add-not-allowed-one',
630 'tags-update-add-not-allowed-multi', $diff );
634 if ( $tagsToRemove ) {
635 // to be removed, a tag must not be defined by an extension, or equivalently it
636 // has to be either explicitly defined or not defined at all
637 // (assuming no edge case of a tag both explicitly-defined and extension-defined)
638 $softwareDefinedTags = self
::listSoftwareDefinedTags();
639 $intersect = array_intersect( $tagsToRemove, $softwareDefinedTags );
641 return self
::restrictedTagError( 'tags-update-remove-not-allowed-one',
642 'tags-update-remove-not-allowed-multi', $intersect );
646 return Status
::newGood();
650 * Adds and/or removes tags to/from a given change, checking whether it is
651 * allowed first, and adding a log entry afterwards.
653 * Includes a call to ChangeTags::canUpdateTags(), so your code doesn't need
654 * to do that. However, it doesn't check whether the *_id parameters are a
655 * valid combination. That is up to you to enforce. See ApiTag::execute() for
658 * Extensions should generally avoid this function. Call
659 * ChangeTags::updateTags() instead, unless directly handling a user request
660 * to add or remove tags from an existing revision or log entry.
662 * @param array|null $tagsToAdd If none, pass array() or null
663 * @param array|null $tagsToRemove If none, pass array() or null
664 * @param int|null $rc_id The rc_id of the change to add the tags to
665 * @param int|null $rev_id The rev_id of the change to add the tags to
666 * @param int|null $log_id The log_id of the change to add the tags to
667 * @param string $params Params to put in the ct_params field of table
668 * 'change_tag' when adding tags
669 * @param string $reason Comment for the log
670 * @param User $user Who to give credit for the action
671 * @return Status If successful, the value of this Status object will be an
672 * object (stdClass) with the following fields:
673 * - logId: the ID of the added log entry, or null if no log entry was added
674 * (i.e. no operation was performed)
675 * - addedTags: an array containing the tags that were actually added
676 * - removedTags: an array containing the tags that were actually removed
679 public static function updateTagsWithChecks( $tagsToAdd, $tagsToRemove,
680 $rc_id, $rev_id, $log_id, $params, $reason, User
$user
682 if ( is_null( $tagsToAdd ) ) {
685 if ( is_null( $tagsToRemove ) ) {
688 if ( !$tagsToAdd && !$tagsToRemove ) {
689 // no-op, don't bother
690 return Status
::newGood( (object)[
697 // are we allowed to do this?
698 $result = self
::canUpdateTags( $tagsToAdd, $tagsToRemove, $user );
699 if ( !$result->isOK() ) {
700 $result->value
= null;
704 // basic rate limiting
705 if ( $user->pingLimiter( 'changetag' ) ) {
706 return Status
::newFatal( 'actionthrottledtext' );
710 list( $tagsAdded, $tagsRemoved, $initialTags ) = self
::updateTags( $tagsToAdd,
711 $tagsToRemove, $rc_id, $rev_id, $log_id, $params, null, $user );
712 if ( !$tagsAdded && !$tagsRemoved ) {
713 // no-op, don't log it
714 return Status
::newGood( (object)[
722 $logEntry = new ManualLogEntry( 'tag', 'update' );
723 $logEntry->setPerformer( $user );
724 $logEntry->setComment( $reason );
726 // find the appropriate target page
728 $rev = Revision
::newFromId( $rev_id );
730 $logEntry->setTarget( $rev->getTitle() );
732 } elseif ( $log_id ) {
733 // This function is from revision deletion logic and has nothing to do with
734 // change tags, but it appears to be the only other place in core where we
735 // perform logged actions on log items.
736 $logEntry->setTarget( RevDelLogList
::suggestTarget( null, [ $log_id ] ) );
739 if ( !$logEntry->getTarget() ) {
740 // target is required, so we have to set something
741 $logEntry->setTarget( SpecialPage
::getTitleFor( 'Tags' ) );
745 '4::revid' => $rev_id,
746 '5::logid' => $log_id,
747 '6:list:tagsAdded' => $tagsAdded,
748 '7:number:tagsAddedCount' => count( $tagsAdded ),
749 '8:list:tagsRemoved' => $tagsRemoved,
750 '9:number:tagsRemovedCount' => count( $tagsRemoved ),
751 'initialTags' => $initialTags,
753 $logEntry->setParameters( $logParams );
754 $logEntry->setRelations( [ 'Tag' => array_merge( $tagsAdded, $tagsRemoved ) ] );
756 $dbw = wfGetDB( DB_MASTER
);
757 $logId = $logEntry->insert( $dbw );
758 // Only send this to UDP, not RC, similar to patrol events
759 $logEntry->publish( $logId, 'udp' );
761 return Status
::newGood( (object)[
763 'addedTags' => $tagsAdded,
764 'removedTags' => $tagsRemoved,
769 * Applies all tags-related changes to a query.
770 * Handles selecting tags, and filtering.
771 * Needs $tables to be set up properly, so we can figure out which join conditions to use.
773 * WARNING: If $filter_tag contains more than one tag, this function will add DISTINCT,
774 * which may cause performance problems for your query unless you put the ID field of your
775 * table at the end of the ORDER BY, and set a GROUP BY equal to the ORDER BY. For example,
776 * if you had ORDER BY foo_timestamp DESC, you will now need GROUP BY foo_timestamp, foo_id
777 * ORDER BY foo_timestamp DESC, foo_id DESC.
779 * @param string|array &$tables Table names, see Database::select
780 * @param string|array &$fields Fields used in query, see Database::select
781 * @param string|array &$conds Conditions used in query, see Database::select
782 * @param array &$join_conds Join conditions, see Database::select
783 * @param string|array &$options Options, see Database::select
784 * @param string|array $filter_tag Tag(s) to select on
786 * @throws MWException When unable to determine appropriate JOIN condition for tagging
788 public static function modifyDisplayQuery( &$tables, &$fields, &$conds,
789 &$join_conds, &$options, $filter_tag = ''
791 global $wgUseTagFilter, $wgChangeTagsSchemaMigrationStage;
793 // Normalize to arrays
794 $tables = (array)$tables;
795 $fields = (array)$fields;
796 $conds = (array)$conds;
797 $options = (array)$options;
799 // Figure out which ID field to use
800 if ( in_array( 'recentchanges', $tables ) ) {
801 $join_cond = 'ct_rc_id=rc_id';
802 } elseif ( in_array( 'logging', $tables ) ) {
803 $join_cond = 'ct_log_id=log_id';
804 } elseif ( in_array( 'revision', $tables ) ) {
805 $join_cond = 'ct_rev_id=rev_id';
806 } elseif ( in_array( 'archive', $tables ) ) {
807 $join_cond = 'ct_rev_id=ar_rev_id';
809 throw new MWException( 'Unable to determine appropriate JOIN condition for tagging.' );
812 $tagTables[] = 'change_tag';
813 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH
) {
814 $tagTables[] = 'change_tag_def';
815 $join_cond_ts_tags = [ 'change_tag_def' => [ 'INNER JOIN', 'ct_tag_id=ctd_id' ] ];
819 $join_cond_ts_tags = [];
822 $fields['ts_tags'] = wfGetDB( DB_REPLICA
)->buildGroupConcatField(
823 ',', $tagTables, $field, $join_cond, $join_cond_ts_tags
826 if ( $wgUseTagFilter && $filter_tag ) {
827 // Somebody wants to filter on a tag.
828 // Add an INNER JOIN on change_tag
830 $tables[] = 'change_tag';
831 $join_conds['change_tag'] = [ 'INNER JOIN', $join_cond ];
832 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH
) {
834 $changeTagDefStore = MediaWikiServices
::getInstance()->getChangeTagDefStore();
835 foreach ( (array)$filter_tag as $filterTagName ) {
837 $filterTagIds[] = $changeTagDefStore->getId( $filterTagName );
838 } catch ( NameTableAccessException
$exception ) {
845 if ( $filterTagIds !== [] ) {
846 $conds['ct_tag_id'] = $filterTagIds;
849 $conds['ct_tag'] = $filter_tag;
853 is_array( $filter_tag ) && count( $filter_tag ) > 1 &&
854 !in_array( 'DISTINCT', $options )
856 $options[] = 'DISTINCT';
862 * Build a text box to select a change tag
864 * @param string $selected Tag to select by default
865 * @param bool $ooui Use an OOUI TextInputWidget as selector instead of a non-OOUI input field
866 * You need to call OutputPage::enableOOUI() yourself.
867 * @param IContextSource|null $context
868 * @note Even though it takes null as a valid argument, an IContextSource is preferred
869 * in a new code, as the null value can change in the future
870 * @return array an array of (label, selector)
872 public static function buildTagFilterSelector(
873 $selected = '', $ooui = false, IContextSource
$context = null
876 $context = RequestContext
::getMain();
879 $config = $context->getConfig();
880 if ( !$config->get( 'UseTagFilter' ) ||
!count( self
::listDefinedTags() ) ) {
887 [ 'for' => 'tagfilter' ],
888 $context->msg( 'tag-filter' )->parse()
893 $data[] = new OOUI\
TextInputWidget( [
895 'name' => 'tagfilter',
896 'value' => $selected,
897 'classes' => 'mw-tagfilter-input',
900 $data[] = Xml
::input(
904 [ 'class' => 'mw-tagfilter-input mw-ui-input mw-ui-input-inline', 'id' => 'tagfilter' ]
912 * Defines a tag in the valid_tag table and/or update ctd_user_defined field in change_tag_def,
913 * without checking that the tag name is valid.
914 * Extensions should NOT use this function; they can use the ListDefinedTags
917 * @param string $tag Tag to create
920 public static function defineTag( $tag ) {
921 global $wgChangeTagsSchemaMigrationStage;
923 $dbw = wfGetDB( DB_MASTER
);
924 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
) {
927 'ctd_user_defined' => 1,
934 [ 'ctd_user_defined' => 1 ],
939 if ( $wgChangeTagsSchemaMigrationStage < MIGRATION_NEW
) {
943 [ 'vt_tag' => $tag ],
947 // clear the memcache of defined tags
948 self
::purgeTagCacheAll();
952 * Removes a tag from the valid_tag table and/or update ctd_user_defined field in change_tag_def.
953 * The tag may remain in use by extensions, and may still show up as 'defined'
954 * if an extension is setting it from the ListDefinedTags hook.
956 * @param string $tag Tag to remove
959 public static function undefineTag( $tag ) {
960 global $wgChangeTagsSchemaMigrationStage;
962 $dbw = wfGetDB( DB_MASTER
);
964 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
) {
967 [ 'ctd_user_defined' => 0 ],
968 [ 'ctd_name' => $tag ],
974 [ 'ctd_name' => $tag, 'ctd_count' => 0 ],
979 if ( $wgChangeTagsSchemaMigrationStage < MIGRATION_NEW
) {
980 $dbw->delete( 'valid_tag', [ 'vt_tag' => $tag ], __METHOD__
);
983 // clear the memcache of defined tags
984 self
::purgeTagCacheAll();
988 * Writes a tag action into the tag management log.
990 * @param string $action
992 * @param string $reason
993 * @param User $user Who to attribute the action to
994 * @param int|null $tagCount For deletion only, how many usages the tag had before
996 * @param array $logEntryTags Change tags to apply to the entry
997 * that will be created in the tag management log
998 * @return int ID of the inserted log entry
1001 protected static function logTagManagementAction( $action, $tag, $reason,
1002 User
$user, $tagCount = null, array $logEntryTags = []
1004 $dbw = wfGetDB( DB_MASTER
);
1006 $logEntry = new ManualLogEntry( 'managetags', $action );
1007 $logEntry->setPerformer( $user );
1008 // target page is not relevant, but it has to be set, so we just put in
1009 // the title of Special:Tags
1010 $logEntry->setTarget( Title
::newFromText( 'Special:Tags' ) );
1011 $logEntry->setComment( $reason );
1013 $params = [ '4::tag' => $tag ];
1014 if ( !is_null( $tagCount ) ) {
1015 $params['5:number:count'] = $tagCount;
1017 $logEntry->setParameters( $params );
1018 $logEntry->setRelations( [ 'Tag' => $tag ] );
1019 $logEntry->setTags( $logEntryTags );
1021 $logId = $logEntry->insert( $dbw );
1022 $logEntry->publish( $logId );
1027 * Is it OK to allow the user to activate this tag?
1029 * @param string $tag Tag that you are interested in activating
1030 * @param User|null $user User whose permission you wish to check, or null if
1031 * you don't care (e.g. maintenance scripts)
1035 public static function canActivateTag( $tag, User
$user = null ) {
1036 if ( !is_null( $user ) ) {
1037 if ( !$user->isAllowed( 'managechangetags' ) ) {
1038 return Status
::newFatal( 'tags-manage-no-permission' );
1039 } elseif ( $user->isBlocked() ) {
1040 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
1044 // defined tags cannot be activated (a defined tag is either extension-
1045 // defined, in which case the extension chooses whether or not to active it;
1046 // or user-defined, in which case it is considered active)
1047 $definedTags = self
::listDefinedTags();
1048 if ( in_array( $tag, $definedTags ) ) {
1049 return Status
::newFatal( 'tags-activate-not-allowed', $tag );
1052 // non-existing tags cannot be activated
1053 $tagUsage = self
::tagUsageStatistics();
1054 if ( !isset( $tagUsage[$tag] ) ) { // we already know the tag is undefined
1055 return Status
::newFatal( 'tags-activate-not-found', $tag );
1058 return Status
::newGood();
1062 * Activates a tag, checking whether it is allowed first, and adding a log
1065 * Includes a call to ChangeTag::canActivateTag(), so your code doesn't need
1068 * @param string $tag
1069 * @param string $reason
1070 * @param User $user Who to give credit for the action
1071 * @param bool $ignoreWarnings Can be used for API interaction, default false
1072 * @param array $logEntryTags Change tags to apply to the entry
1073 * that will be created in the tag management log
1074 * @return Status If successful, the Status contains the ID of the added log
1075 * entry as its value
1078 public static function activateTagWithChecks( $tag, $reason, User
$user,
1079 $ignoreWarnings = false, array $logEntryTags = []
1081 // are we allowed to do this?
1082 $result = self
::canActivateTag( $tag, $user );
1083 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
1084 $result->value
= null;
1089 self
::defineTag( $tag );
1092 $logId = self
::logTagManagementAction( 'activate', $tag, $reason, $user,
1093 null, $logEntryTags );
1095 return Status
::newGood( $logId );
1099 * Is it OK to allow the user to deactivate this tag?
1101 * @param string $tag Tag that you are interested in deactivating
1102 * @param User|null $user User whose permission you wish to check, or null if
1103 * you don't care (e.g. maintenance scripts)
1107 public static function canDeactivateTag( $tag, User
$user = null ) {
1108 if ( !is_null( $user ) ) {
1109 if ( !$user->isAllowed( 'managechangetags' ) ) {
1110 return Status
::newFatal( 'tags-manage-no-permission' );
1111 } elseif ( $user->isBlocked() ) {
1112 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
1116 // only explicitly-defined tags can be deactivated
1117 $explicitlyDefinedTags = self
::listExplicitlyDefinedTags();
1118 if ( !in_array( $tag, $explicitlyDefinedTags ) ) {
1119 return Status
::newFatal( 'tags-deactivate-not-allowed', $tag );
1121 return Status
::newGood();
1125 * Deactivates a tag, checking whether it is allowed first, and adding a log
1128 * Includes a call to ChangeTag::canDeactivateTag(), so your code doesn't need
1131 * @param string $tag
1132 * @param string $reason
1133 * @param User $user Who to give credit for the action
1134 * @param bool $ignoreWarnings Can be used for API interaction, default false
1135 * @param array $logEntryTags Change tags to apply to the entry
1136 * that will be created in the tag management log
1137 * @return Status If successful, the Status contains the ID of the added log
1138 * entry as its value
1141 public static function deactivateTagWithChecks( $tag, $reason, User
$user,
1142 $ignoreWarnings = false, array $logEntryTags = []
1144 // are we allowed to do this?
1145 $result = self
::canDeactivateTag( $tag, $user );
1146 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
1147 $result->value
= null;
1152 self
::undefineTag( $tag );
1155 $logId = self
::logTagManagementAction( 'deactivate', $tag, $reason, $user,
1156 null, $logEntryTags );
1158 return Status
::newGood( $logId );
1162 * Is the tag name valid?
1164 * @param string $tag Tag that you are interested in creating
1168 public static function isTagNameValid( $tag ) {
1170 if ( $tag === '' ) {
1171 return Status
::newFatal( 'tags-create-no-name' );
1174 // tags cannot contain commas (used as a delimiter in tag_summary table),
1175 // pipe (used as a delimiter between multiple tags in
1176 // SpecialRecentchanges and friends), or slashes (would break tag description messages in
1177 // MediaWiki namespace)
1178 if ( strpos( $tag, ',' ) !== false ||
strpos( $tag, '|' ) !== false
1179 ||
strpos( $tag, '/' ) !== false ) {
1180 return Status
::newFatal( 'tags-create-invalid-chars' );
1183 // could the MediaWiki namespace description messages be created?
1184 $title = Title
::makeTitleSafe( NS_MEDIAWIKI
, "Tag-$tag-description" );
1185 if ( is_null( $title ) ) {
1186 return Status
::newFatal( 'tags-create-invalid-title-chars' );
1189 return Status
::newGood();
1193 * Is it OK to allow the user to create this tag?
1195 * Extensions should NOT use this function. In most cases, a tag can be
1196 * defined using the ListDefinedTags hook without any checking.
1198 * @param string $tag Tag that you are interested in creating
1199 * @param User|null $user User whose permission you wish to check, or null if
1200 * you don't care (e.g. maintenance scripts)
1204 public static function canCreateTag( $tag, User
$user = null ) {
1205 if ( !is_null( $user ) ) {
1206 if ( !$user->isAllowed( 'managechangetags' ) ) {
1207 return Status
::newFatal( 'tags-manage-no-permission' );
1208 } elseif ( $user->isBlocked() ) {
1209 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
1213 $status = self
::isTagNameValid( $tag );
1214 if ( !$status->isGood() ) {
1218 // does the tag already exist?
1219 $tagUsage = self
::tagUsageStatistics();
1220 if ( isset( $tagUsage[$tag] ) ||
in_array( $tag, self
::listDefinedTags() ) ) {
1221 return Status
::newFatal( 'tags-create-already-exists', $tag );
1225 $canCreateResult = Status
::newGood();
1226 Hooks
::run( 'ChangeTagCanCreate', [ $tag, $user, &$canCreateResult ] );
1227 return $canCreateResult;
1231 * Creates a tag by adding a row to the `valid_tag` table.
1232 * and/or add it to `change_tag_def` table.
1234 * Extensions should NOT use this function; they can use the ListDefinedTags
1237 * Includes a call to ChangeTag::canCreateTag(), so your code doesn't need to
1240 * @param string $tag
1241 * @param string $reason
1242 * @param User $user Who to give credit for the action
1243 * @param bool $ignoreWarnings Can be used for API interaction, default false
1244 * @param array $logEntryTags Change tags to apply to the entry
1245 * that will be created in the tag management log
1246 * @return Status If successful, the Status contains the ID of the added log
1247 * entry as its value
1250 public static function createTagWithChecks( $tag, $reason, User
$user,
1251 $ignoreWarnings = false, array $logEntryTags = []
1253 // are we allowed to do this?
1254 $result = self
::canCreateTag( $tag, $user );
1255 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
1256 $result->value
= null;
1261 self
::defineTag( $tag );
1264 $logId = self
::logTagManagementAction( 'create', $tag, $reason, $user,
1265 null, $logEntryTags );
1267 return Status
::newGood( $logId );
1271 * Permanently removes all traces of a tag from the DB. Good for removing
1272 * misspelt or temporary tags.
1274 * This function should be directly called by maintenance scripts only, never
1275 * by user-facing code. See deleteTagWithChecks() for functionality that can
1276 * safely be exposed to users.
1278 * @param string $tag Tag to remove
1279 * @return Status The returned status will be good unless a hook changed it
1282 public static function deleteTagEverywhere( $tag ) {
1283 global $wgChangeTagsSchemaMigrationStage;
1284 $dbw = wfGetDB( DB_MASTER
);
1285 $dbw->startAtomic( __METHOD__
);
1287 // delete from valid_tag and/or set ctd_user_defined = 0
1288 self
::undefineTag( $tag );
1290 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH
) {
1291 $tagId = MediaWikiServices
::getInstance()->getChangeTagDefStore()->getId( $tag );
1292 $conditions = [ 'ct_tag_id' => $tagId ];
1294 $conditions = [ 'ct_tag' => $tag ];
1297 // find out which revisions use this tag, so we can delete from tag_summary
1298 $result = $dbw->select( 'change_tag',
1299 [ 'ct_rc_id', 'ct_log_id', 'ct_rev_id' ],
1302 foreach ( $result as $row ) {
1303 // remove the tag from the relevant row of tag_summary
1305 $tagsToRemove = [ $tag ];
1306 self
::updateTagSummaryRow( $tagsToAdd, $tagsToRemove, $row->ct_rc_id
,
1307 $row->ct_rev_id
, $row->ct_log_id
);
1310 // delete from change_tag
1311 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH
) {
1312 $tagId = MediaWikiServices
::getInstance()->getChangeTagDefStore()->getId( $tag );
1313 $dbw->delete( 'change_tag', [ 'ct_tag_id' => $tagId ], __METHOD__
);
1315 $dbw->delete( 'change_tag', [ 'ct_tag' => $tag ], __METHOD__
);
1318 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
) {
1319 $dbw->delete( 'change_tag_def', [ 'ctd_name' => $tag ], __METHOD__
);
1322 $dbw->endAtomic( __METHOD__
);
1324 // give extensions a chance
1325 $status = Status
::newGood();
1326 Hooks
::run( 'ChangeTagAfterDelete', [ $tag, &$status ] );
1327 // let's not allow error results, as the actual tag deletion succeeded
1328 if ( !$status->isOK() ) {
1329 wfDebug( 'ChangeTagAfterDelete error condition downgraded to warning' );
1330 $status->setOK( true );
1333 // clear the memcache of defined tags
1334 self
::purgeTagCacheAll();
1340 * Is it OK to allow the user to delete this tag?
1342 * @param string $tag Tag that you are interested in deleting
1343 * @param User|null $user User whose permission you wish to check, or null if
1344 * you don't care (e.g. maintenance scripts)
1348 public static function canDeleteTag( $tag, User
$user = null ) {
1349 $tagUsage = self
::tagUsageStatistics();
1351 if ( !is_null( $user ) ) {
1352 if ( !$user->isAllowed( 'deletechangetags' ) ) {
1353 return Status
::newFatal( 'tags-delete-no-permission' );
1354 } elseif ( $user->isBlocked() ) {
1355 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
1359 if ( !isset( $tagUsage[$tag] ) && !in_array( $tag, self
::listDefinedTags() ) ) {
1360 return Status
::newFatal( 'tags-delete-not-found', $tag );
1363 if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > self
::MAX_DELETE_USES
) {
1364 return Status
::newFatal( 'tags-delete-too-many-uses', $tag, self
::MAX_DELETE_USES
);
1367 $softwareDefined = self
::listSoftwareDefinedTags();
1368 if ( in_array( $tag, $softwareDefined ) ) {
1369 // extension-defined tags can't be deleted unless the extension
1370 // specifically allows it
1371 $status = Status
::newFatal( 'tags-delete-not-allowed' );
1373 // user-defined tags are deletable unless otherwise specified
1374 $status = Status
::newGood();
1377 Hooks
::run( 'ChangeTagCanDelete', [ $tag, $user, &$status ] );
1382 * Deletes a tag, checking whether it is allowed first, and adding a log entry
1385 * Includes a call to ChangeTag::canDeleteTag(), so your code doesn't need to
1388 * @param string $tag
1389 * @param string $reason
1390 * @param User $user Who to give credit for the action
1391 * @param bool $ignoreWarnings Can be used for API interaction, default false
1392 * @param array $logEntryTags Change tags to apply to the entry
1393 * that will be created in the tag management log
1394 * @return Status If successful, the Status contains the ID of the added log
1395 * entry as its value
1398 public static function deleteTagWithChecks( $tag, $reason, User
$user,
1399 $ignoreWarnings = false, array $logEntryTags = []
1401 // are we allowed to do this?
1402 $result = self
::canDeleteTag( $tag, $user );
1403 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
1404 $result->value
= null;
1408 // store the tag usage statistics
1409 $tagUsage = self
::tagUsageStatistics();
1410 $hitcount = $tagUsage[$tag] ??
0;
1413 $deleteResult = self
::deleteTagEverywhere( $tag );
1414 if ( !$deleteResult->isOK() ) {
1415 return $deleteResult;
1419 $logId = self
::logTagManagementAction( 'delete', $tag, $reason, $user,
1420 $hitcount, $logEntryTags );
1422 $deleteResult->value
= $logId;
1423 return $deleteResult;
1427 * Lists those tags which core or extensions report as being "active".
1432 public static function listSoftwareActivatedTags() {
1434 $tags = self
::getSoftwareTags();
1435 if ( !Hooks
::isRegistered( 'ChangeTagsListActive' ) ) {
1438 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1439 return $cache->getWithSetCallback(
1440 $cache->makeKey( 'active-tags' ),
1441 WANObjectCache
::TTL_MINUTE
* 5,
1442 function ( $oldValue, &$ttl, array &$setOpts ) use ( $tags ) {
1443 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
1445 // Ask extensions which tags they consider active
1446 Hooks
::run( 'ChangeTagsListActive', [ &$tags ] );
1450 'checkKeys' => [ $cache->makeKey( 'active-tags' ) ],
1451 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1452 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1458 * Basically lists defined tags which count even if they aren't applied to anything.
1459 * It returns a union of the results of listExplicitlyDefinedTags()
1461 * @return string[] Array of strings: tags
1463 public static function listDefinedTags() {
1464 $tags1 = self
::listExplicitlyDefinedTags();
1465 $tags2 = self
::listSoftwareDefinedTags();
1466 return array_values( array_unique( array_merge( $tags1, $tags2 ) ) );
1470 * Lists tags explicitly defined in the `valid_tag` table of the database.
1471 * Tags in table 'change_tag' which are not in table 'valid_tag' are not
1472 * included. In case of new backend loads the data from `change_tag_def` table.
1474 * Tries memcached first.
1476 * @return string[] Array of strings: tags
1479 public static function listExplicitlyDefinedTags() {
1480 $fname = __METHOD__
;
1482 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1483 return $cache->getWithSetCallback(
1484 $cache->makeKey( 'valid-tags-db' ),
1485 WANObjectCache
::TTL_MINUTE
* 5,
1486 function ( $oldValue, &$ttl, array &$setOpts ) use ( $fname ) {
1487 global $wgChangeTagsSchemaMigrationStage;
1488 $dbr = wfGetDB( DB_REPLICA
);
1490 $setOpts +
= Database
::getCacheSetOptions( $dbr );
1492 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH
) {
1493 $tags = self
::listExplicitlyDefinedTagsNewBackend();
1495 $tags = $dbr->selectFieldValues( 'valid_tag', 'vt_tag', [], $fname );
1498 return array_filter( array_unique( $tags ) );
1501 'checkKeys' => [ $cache->makeKey( 'valid-tags-db' ) ],
1502 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1503 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1509 * Lists tags explicitly user defined tags. When ctd_user_defined is true.
1511 * @return string[] Array of strings: tags
1514 private static function listExplicitlyDefinedTagsNewBackend() {
1515 $dbr = wfGetDB( DB_REPLICA
);
1516 return $dbr->selectFieldValues(
1519 [ 'ctd_user_defined' => 1 ],
1525 * Lists tags defined by core or extensions using the ListDefinedTags hook.
1526 * Extensions need only define those tags they deem to be in active use.
1528 * Tries memcached first.
1530 * @return string[] Array of strings: tags
1533 public static function listSoftwareDefinedTags() {
1534 // core defined tags
1535 $tags = self
::getSoftwareTags( true );
1536 if ( !Hooks
::isRegistered( 'ListDefinedTags' ) ) {
1539 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1540 return $cache->getWithSetCallback(
1541 $cache->makeKey( 'valid-tags-hook' ),
1542 WANObjectCache
::TTL_MINUTE
* 5,
1543 function ( $oldValue, &$ttl, array &$setOpts ) use ( $tags ) {
1544 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
1546 Hooks
::run( 'ListDefinedTags', [ &$tags ] );
1547 return array_filter( array_unique( $tags ) );
1550 'checkKeys' => [ $cache->makeKey( 'valid-tags-hook' ) ],
1551 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1552 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1558 * Invalidates the short-term cache of defined tags used by the
1559 * list*DefinedTags functions, as well as the tag statistics cache.
1562 public static function purgeTagCacheAll() {
1563 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1565 $cache->touchCheckKey( $cache->makeKey( 'active-tags' ) );
1566 $cache->touchCheckKey( $cache->makeKey( 'valid-tags-db' ) );
1567 $cache->touchCheckKey( $cache->makeKey( 'valid-tags-hook' ) );
1569 self
::purgeTagUsageCache();
1573 * Invalidates the tag statistics cache only.
1576 public static function purgeTagUsageCache() {
1577 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1579 $cache->touchCheckKey( $cache->makeKey( 'change-tag-statistics' ) );
1583 * Returns a map of any tags used on the wiki to number of edits
1584 * tagged with them, ordered descending by the hitcount.
1585 * This does not include tags defined somewhere that have never been applied.
1587 * Keeps a short-term cache in memory, so calling this multiple times in the
1588 * same request should be fine.
1590 * @return array Array of string => int
1592 public static function tagUsageStatistics() {
1593 global $wgChangeTagsSchemaMigrationStage, $wgTagStatisticsNewTable;
1594 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH ||
1595 ( $wgTagStatisticsNewTable && $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
)
1597 return self
::newTagUsageStatistics();
1600 $fname = __METHOD__
;
1601 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1602 return $cache->getWithSetCallback(
1603 $cache->makeKey( 'change-tag-statistics' ),
1604 WANObjectCache
::TTL_MINUTE
* 5,
1605 function ( $oldValue, &$ttl, array &$setOpts ) use ( $fname ) {
1606 $dbr = wfGetDB( DB_REPLICA
, 'vslow' );
1608 $setOpts +
= Database
::getCacheSetOptions( $dbr );
1610 $res = $dbr->select(
1612 [ 'ct_tag', 'hitcount' => 'count(*)' ],
1615 [ 'GROUP BY' => 'ct_tag', 'ORDER BY' => 'hitcount DESC' ]
1619 foreach ( $res as $row ) {
1620 $out[$row->ct_tag
] = $row->hitcount
;
1626 'checkKeys' => [ $cache->makeKey( 'change-tag-statistics' ) ],
1627 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1628 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1634 * Same self::tagUsageStatistics() but uses change_tag_def.
1636 * @return array Array of string => int
1638 private static function newTagUsageStatistics() {
1639 $dbr = wfGetDB( DB_REPLICA
);
1640 $res = $dbr->select(
1642 [ 'ctd_name', 'ctd_count' ],
1645 [ 'ORDER BY' => 'ctd_count DESC' ]
1649 foreach ( $res as $row ) {
1650 $out[$row->ctd_name
] = $row->ctd_count
;
1657 * Indicate whether change tag editing UI is relevant
1659 * Returns true if the user has the necessary right and there are any
1660 * editable tags defined.
1662 * This intentionally doesn't check "any addable || any deletable", because
1663 * it seems like it would be more confusing than useful if the checkboxes
1664 * suddenly showed up because some abuse filter stopped defining a tag and
1665 * then suddenly disappeared when someone deleted all uses of that tag.
1670 public static function showTagEditingUI( User
$user ) {
1671 return $user->isAllowed( 'changetags' ) && (bool)self
::listExplicitlyDefinedTags();