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;
36 * A list of tags defined and used by MediaWiki itself.
38 private static $definedSoftwareTags = [
39 'mw-contentmodelchange',
41 'mw-removed-redirect',
42 'mw-changed-redirect-target',
50 * Loads defined core tags, checks for invalid types (if not array),
51 * and filters for supported and enabled (if $all is false) tags only.
53 * @param bool $all If true, return all valid defined tags. Otherwise, return only enabled ones.
54 * @return array Array of all defined/enabled tags.
56 public static function getSoftwareTags( $all = false ) {
57 global $wgSoftwareTags;
60 if ( !is_array( $wgSoftwareTags ) ) {
61 wfWarn( 'wgSoftwareTags should be associative array of enabled tags.
62 Please refer to documentation for the list of tags you can enable' );
66 $availableSoftwareTags = !$all ?
67 array_keys( array_filter( $wgSoftwareTags ) ) :
68 array_keys( $wgSoftwareTags );
70 $softwareTags = array_intersect(
71 $availableSoftwareTags,
72 self
::$definedSoftwareTags
79 * Creates HTML for the given tags
81 * @param string $tags Comma-separated list of tags
82 * @param string $page A label for the type of action which is being displayed,
83 * for example: 'history', 'contributions' or 'newpages'
84 * @param IContextSource|null $context
85 * @note Even though it takes null as a valid argument, an IContextSource is preferred
86 * in a new code, as the null value is subject to change in the future
87 * @return array Array with two items: (html, classes)
88 * - html: String: HTML for displaying the tags (empty string when param $tags is empty)
89 * - classes: Array of strings: CSS classes used in the generated html, one class for each tag
91 public static function formatSummaryRow( $tags, $page, IContextSource
$context = null ) {
96 $context = RequestContext
::getMain();
101 $tags = explode( ',', $tags );
103 foreach ( $tags as $tag ) {
107 $description = self
::tagDescription( $tag, $context );
108 if ( $description === false ) {
111 $displayTags[] = Xml
::tags(
113 [ 'class' => 'mw-tag-marker ' .
114 Sanitizer
::escapeClass( "mw-tag-marker-$tag" ) ],
117 $classes[] = Sanitizer
::escapeClass( "mw-tag-$tag" );
120 if ( !$displayTags ) {
124 $markers = $context->msg( 'tag-list-wrapper' )
125 ->numParams( count( $displayTags ) )
126 ->rawParams( $context->getLanguage()->commaList( $displayTags ) )
128 $markers = Xml
::tags( 'span', [ 'class' => 'mw-tag-markers' ], $markers );
130 return [ $markers, $classes ];
134 * Get a short description for a tag.
136 * Checks if message key "mediawiki:tag-$tag" exists. If it does not,
137 * returns the HTML-escaped tag name. Uses the message if the message
138 * exists, provided it is not disabled. If the message is disabled,
139 * we consider the tag hidden, and return false.
142 * @param IContextSource $context
143 * @return string|bool Tag description or false if tag is to be hidden.
144 * @since 1.25 Returns false if tag is to be hidden.
146 public static function tagDescription( $tag, IContextSource
$context ) {
147 $msg = $context->msg( "tag-$tag" );
148 if ( !$msg->exists() ) {
149 // No such message, so return the HTML-escaped tag name.
150 return htmlspecialchars( $tag );
152 if ( $msg->isDisabled() ) {
153 // The message exists but is disabled, hide the tag.
157 // Message exists and isn't disabled, use it.
158 return $msg->parse();
162 * Get the message object for the tag's long description.
164 * Checks if message key "mediawiki:tag-$tag-description" exists. If it does not,
165 * or if message is disabled, returns false. Otherwise, returns the message object
166 * for the long description.
169 * @param IContextSource $context
170 * @return Message|bool Message object of the tag long description or false if
171 * there is no description.
173 public static function tagLongDescriptionMessage( $tag, IContextSource
$context ) {
174 $msg = $context->msg( "tag-$tag-description" );
175 if ( !$msg->exists() ) {
178 if ( $msg->isDisabled() ) {
179 // The message exists but is disabled, hide the description.
183 // Message exists and isn't disabled, use it.
188 * Get truncated message for the tag's long description.
190 * @param string $tag Tag name.
191 * @param int $length Maximum length of truncated message, including ellipsis.
192 * @param IContextSource $context
194 * @return string Truncated long tag description.
196 public static function truncateTagDescription( $tag, $length, IContextSource
$context ) {
197 $originalDesc = self
::tagLongDescriptionMessage( $tag, $context );
198 // If there is no tag description, return empty string
199 if ( !$originalDesc ) {
203 $taglessDesc = Sanitizer
::stripAllTags( $originalDesc->parse() );
205 return $context->getLanguage()->truncateForVisual( $taglessDesc, $length );
209 * Add tags to a change given its rc_id, rev_id and/or log_id
211 * @param string|string[] $tags Tags to add to the change
212 * @param int|null $rc_id The rc_id of the change to add the tags to
213 * @param int|null $rev_id The rev_id of the change to add the tags to
214 * @param int|null $log_id The log_id of the change to add the tags to
215 * @param string|null $params Params to put in the ct_params field of table 'change_tag'
216 * @param RecentChange|null $rc Recent change, in case the tagging accompanies the action
217 * (this should normally be the case)
219 * @throws MWException
220 * @return bool False if no changes are made, otherwise true
222 public static function addTags( $tags, $rc_id = null, $rev_id = null,
223 $log_id = null, $params = null, RecentChange
$rc = null
225 $result = self
::updateTags( $tags, null, $rc_id, $rev_id, $log_id, $params, $rc );
226 return (bool)$result[0];
230 * Add and remove tags to/from a change given its rc_id, rev_id and/or log_id,
231 * without verifying that the tags exist or are valid. If a tag is present in
232 * both $tagsToAdd and $tagsToRemove, it will be removed.
234 * This function should only be used by extensions to manipulate tags they
235 * have registered using the ListDefinedTags hook. When dealing with user
236 * input, call updateTagsWithChecks() instead.
238 * @param string|array|null $tagsToAdd Tags to add to the change
239 * @param string|array|null $tagsToRemove Tags to remove from the change
240 * @param int|null &$rc_id The rc_id of the change to add the tags to.
241 * Pass a variable whose value is null if the rc_id is not relevant or unknown.
242 * @param int|null &$rev_id The rev_id of the change to add the tags to.
243 * Pass a variable whose value is null if the rev_id is not relevant or unknown.
244 * @param int|null &$log_id The log_id of the change to add the tags to.
245 * Pass a variable whose value is null if the log_id is not relevant or unknown.
246 * @param string|null $params Params to put in the ct_params field of table
247 * 'change_tag' when adding tags
248 * @param RecentChange|null $rc Recent change being tagged, in case the tagging accompanies
250 * @param User|null $user Tagging user, in case the tagging is subsequent to the tagged action
252 * @throws MWException When $rc_id, $rev_id and $log_id are all null
253 * @return array Index 0 is an array of tags actually added, index 1 is an
254 * array of tags actually removed, index 2 is an array of tags present on the
255 * revision or log entry before any changes were made
259 public static function updateTags( $tagsToAdd, $tagsToRemove, &$rc_id = null,
260 &$rev_id = null, &$log_id = null, $params = null, RecentChange
$rc = null,
263 global $wgChangeTagsSchemaMigrationStage;
265 $tagsToAdd = array_filter( (array)$tagsToAdd ); // Make sure we're submitting all tags...
266 $tagsToRemove = array_filter( (array)$tagsToRemove );
268 if ( !$rc_id && !$rev_id && !$log_id ) {
269 throw new MWException( 'At least one of: RCID, revision ID, and log ID MUST be ' .
270 'specified when adding or removing a tag from a change!' );
273 $dbw = wfGetDB( DB_MASTER
);
275 // Might as well look for rcids and so on.
277 // Info might be out of date, somewhat fractionally, on replica DB.
278 // LogEntry/LogPage and WikiPage match rev/log/rc timestamps,
279 // so use that relation to avoid full table scans.
281 $rc_id = $dbw->selectField(
282 [ 'logging', 'recentchanges' ],
286 'rc_timestamp = log_timestamp',
291 } elseif ( $rev_id ) {
292 $rc_id = $dbw->selectField(
293 [ 'revision', 'recentchanges' ],
297 'rc_timestamp = rev_timestamp',
298 'rc_this_oldid = rev_id'
303 } elseif ( !$log_id && !$rev_id ) {
304 // Info might be out of date, somewhat fractionally, on replica DB.
305 $log_id = $dbw->selectField(
308 [ 'rc_id' => $rc_id ],
311 $rev_id = $dbw->selectField(
314 [ 'rc_id' => $rc_id ],
319 if ( $log_id && !$rev_id ) {
320 $rev_id = $dbw->selectField(
323 [ 'ls_field' => 'associated_rev_id', 'ls_log_id' => $log_id ],
326 } elseif ( !$log_id && $rev_id ) {
327 $log_id = $dbw->selectField(
330 [ 'ls_field' => 'associated_rev_id', 'ls_value' => $rev_id ],
335 // update the tag_summary row
337 if ( !self
::updateTagSummaryRow( $tagsToAdd, $tagsToRemove, $rc_id, $rev_id,
341 return [ [], [], $prevTags ];
344 // insert a row into change_tag for each new tag
345 if ( count( $tagsToAdd ) ) {
346 $changeTagMapping = [];
347 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
) {
348 $changeTagDefStore = MediaWikiServices
::getInstance()->getChangeTagDefStore();
350 foreach ( $tagsToAdd as $tag ) {
351 $changeTagMapping[$tag] = $changeTagDefStore->acquireId( $tag );
356 [ 'ctd_count = ctd_count + 1' ],
357 [ 'ctd_name' => $tagsToAdd ],
363 foreach ( $tagsToAdd as $tag ) {
364 // Filter so we don't insert NULLs as zero accidentally.
365 // Keep in mind that $rc_id === null means "I don't care/know about the
366 // rc_id, just delete $tag on this revision/log entry". It doesn't
367 // mean "only delete tags on this revision/log WHERE rc_id IS NULL".
368 $tagsRows[] = array_filter(
371 'ct_rc_id' => $rc_id,
372 'ct_log_id' => $log_id,
373 'ct_rev_id' => $rev_id,
374 'ct_params' => $params,
375 'ct_tag_id' => $changeTagMapping[$tag] ??
null,
381 $dbw->insert( 'change_tag', $tagsRows, __METHOD__
, [ 'IGNORE' ] );
384 // delete from change_tag
385 if ( count( $tagsToRemove ) ) {
386 foreach ( $tagsToRemove as $tag ) {
387 $conds = array_filter(
390 'ct_rc_id' => $rc_id,
391 'ct_log_id' => $log_id,
392 'ct_rev_id' => $rev_id
395 $dbw->delete( 'change_tag', $conds, __METHOD__
);
396 if ( $dbw->affectedRows() && $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
) {
399 [ 'ctd_count = ctd_count - 1' ],
400 [ 'ctd_name' => $tag ],
406 [ 'ctd_name' => $tag, 'ctd_count' => 0, 'ctd_user_defined' => 0 ],
413 self
::purgeTagUsageCache();
415 Hooks
::run( 'ChangeTagsAfterUpdateTags', [ $tagsToAdd, $tagsToRemove, $prevTags,
416 $rc_id, $rev_id, $log_id, $params, $rc, $user ] );
418 return [ $tagsToAdd, $tagsToRemove, $prevTags ];
422 * Adds or removes a given set of tags to/from the relevant row of the
423 * tag_summary table. Modifies the tagsToAdd and tagsToRemove arrays to
424 * reflect the tags that were actually added and/or removed.
426 * @param array &$tagsToAdd
427 * @param array &$tagsToRemove If a tag is present in both $tagsToAdd and
428 * $tagsToRemove, it will be removed
429 * @param int|null $rc_id Null if not known or not applicable
430 * @param int|null $rev_id Null if not known or not applicable
431 * @param int|null $log_id Null if not known or not applicable
432 * @param array &$prevTags Optionally outputs a list of the tags that were
433 * in the tag_summary row to begin with
434 * @return bool True if any modifications were made, otherwise false
437 protected static function updateTagSummaryRow( &$tagsToAdd, &$tagsToRemove,
438 $rc_id, $rev_id, $log_id, &$prevTags = []
440 $dbw = wfGetDB( DB_MASTER
);
442 $tsConds = array_filter( [
443 'ts_rc_id' => $rc_id,
444 'ts_rev_id' => $rev_id,
445 'ts_log_id' => $log_id
448 // Can't both add and remove a tag at the same time...
449 $tagsToAdd = array_diff( $tagsToAdd, $tagsToRemove );
451 // Update the summary row.
452 // $prevTags can be out of date on replica DBs, especially when addTags is called consecutively,
453 // causing loss of tags added recently in tag_summary table.
454 $prevTags = $dbw->selectField( 'tag_summary', 'ts_tags', $tsConds, __METHOD__
);
455 $prevTags = $prevTags ?
: '';
456 $prevTags = array_filter( explode( ',', $prevTags ) );
459 $tagsToAdd = array_values( array_diff( $tagsToAdd, $prevTags ) );
460 $newTags = array_unique( array_merge( $prevTags, $tagsToAdd ) );
463 $tagsToRemove = array_values( array_intersect( $tagsToRemove, $newTags ) );
464 $newTags = array_values( array_diff( $newTags, $tagsToRemove ) );
468 if ( $prevTags == $newTags ) {
473 // No tags left, so delete the row altogether
474 $dbw->delete( 'tag_summary', $tsConds, __METHOD__
);
476 // Specify the non-DEFAULT value columns in the INSERT/REPLACE clause
477 $row = array_filter( [ 'ts_tags' => implode( ',', $newTags ) ] +
$tsConds );
478 // Check the unique keys for conflicts, ignoring any NULL *_id values
480 foreach ( [ 'ts_rev_id', 'ts_rc_id', 'ts_log_id' ] as $uniqueColumn ) {
481 if ( isset( $row[$uniqueColumn] ) ) {
482 $uniqueKeys[] = [ $uniqueColumn ];
486 $dbw->replace( 'tag_summary', $uniqueKeys, $row, __METHOD__
);
493 * Helper function to generate a fatal status with a 'not-allowed' type error.
495 * @param string $msgOne Message key to use in the case of one tag
496 * @param string $msgMulti Message key to use in the case of more than one tag
497 * @param array $tags Restricted tags (passed as $1 into the message, count of
498 * $tags passed as $2)
502 protected static function restrictedTagError( $msgOne, $msgMulti, $tags ) {
503 $lang = RequestContext
::getMain()->getLanguage();
504 $count = count( $tags );
505 return Status
::newFatal( ( $count > 1 ) ?
$msgMulti : $msgOne,
506 $lang->commaList( $tags ), $count );
510 * Is it OK to allow the user to apply all the specified tags at the same time
511 * as they edit/make the change?
513 * Extensions should not use this function, unless directly handling a user
514 * request to add a tag to a revision or log entry that the user is making.
516 * @param array $tags Tags that you are interested in applying
517 * @param User|null $user User whose permission you wish to check, or null to
518 * check for a generic non-blocked user with the relevant rights
522 public static function canAddTagsAccompanyingChange( array $tags, User
$user = null ) {
523 if ( !is_null( $user ) ) {
524 if ( !$user->isAllowed( 'applychangetags' ) ) {
525 return Status
::newFatal( 'tags-apply-no-permission' );
526 } elseif ( $user->isBlocked() ) {
527 return Status
::newFatal( 'tags-apply-blocked', $user->getName() );
531 // to be applied, a tag has to be explicitly defined
532 $allowedTags = self
::listExplicitlyDefinedTags();
533 Hooks
::run( 'ChangeTagsAllowedAdd', [ &$allowedTags, $tags, $user ] );
534 $disallowedTags = array_diff( $tags, $allowedTags );
535 if ( $disallowedTags ) {
536 return self
::restrictedTagError( 'tags-apply-not-allowed-one',
537 'tags-apply-not-allowed-multi', $disallowedTags );
540 return Status
::newGood();
544 * Adds tags to a given change, checking whether it is allowed first, but
545 * without adding a log entry. Useful for cases where the tag is being added
546 * along with the action that generated the change (e.g. tagging an edit as
549 * Extensions should not use this function, unless directly handling a user
550 * request to add a particular tag. Normally, extensions should call
551 * ChangeTags::updateTags() instead.
553 * @param array $tags Tags to apply
554 * @param int|null $rc_id The rc_id of the change to add the tags to
555 * @param int|null $rev_id The rev_id of the change to add the tags to
556 * @param int|null $log_id The log_id of the change to add the tags to
557 * @param string $params Params to put in the ct_params field of table
558 * 'change_tag' when adding tags
559 * @param User $user Who to give credit for the action
563 public static function addTagsAccompanyingChangeWithChecks(
564 array $tags, $rc_id, $rev_id, $log_id, $params, User
$user
566 // are we allowed to do this?
567 $result = self
::canAddTagsAccompanyingChange( $tags, $user );
568 if ( !$result->isOK() ) {
569 $result->value
= null;
574 self
::addTags( $tags, $rc_id, $rev_id, $log_id, $params );
576 return Status
::newGood( true );
580 * Is it OK to allow the user to adds and remove the given tags tags to/from a
583 * Extensions should not use this function, unless directly handling a user
584 * request to add or remove tags from an existing revision or log entry.
586 * @param array $tagsToAdd Tags that you are interested in adding
587 * @param array $tagsToRemove Tags that you are interested in removing
588 * @param User|null $user User whose permission you wish to check, or null to
589 * check for a generic non-blocked user with the relevant rights
593 public static function canUpdateTags( array $tagsToAdd, array $tagsToRemove,
596 if ( !is_null( $user ) ) {
597 if ( !$user->isAllowed( 'changetags' ) ) {
598 return Status
::newFatal( 'tags-update-no-permission' );
599 } elseif ( $user->isBlocked() ) {
600 return Status
::newFatal( 'tags-update-blocked', $user->getName() );
605 // to be added, a tag has to be explicitly defined
606 // @todo Allow extensions to define tags that can be applied by users...
607 $explicitlyDefinedTags = self
::listExplicitlyDefinedTags();
608 $diff = array_diff( $tagsToAdd, $explicitlyDefinedTags );
610 return self
::restrictedTagError( 'tags-update-add-not-allowed-one',
611 'tags-update-add-not-allowed-multi', $diff );
615 if ( $tagsToRemove ) {
616 // to be removed, a tag must not be defined by an extension, or equivalently it
617 // has to be either explicitly defined or not defined at all
618 // (assuming no edge case of a tag both explicitly-defined and extension-defined)
619 $softwareDefinedTags = self
::listSoftwareDefinedTags();
620 $intersect = array_intersect( $tagsToRemove, $softwareDefinedTags );
622 return self
::restrictedTagError( 'tags-update-remove-not-allowed-one',
623 'tags-update-remove-not-allowed-multi', $intersect );
627 return Status
::newGood();
631 * Adds and/or removes tags to/from a given change, checking whether it is
632 * allowed first, and adding a log entry afterwards.
634 * Includes a call to ChangeTags::canUpdateTags(), so your code doesn't need
635 * to do that. However, it doesn't check whether the *_id parameters are a
636 * valid combination. That is up to you to enforce. See ApiTag::execute() for
639 * Extensions should generally avoid this function. Call
640 * ChangeTags::updateTags() instead, unless directly handling a user request
641 * to add or remove tags from an existing revision or log entry.
643 * @param array|null $tagsToAdd If none, pass array() or null
644 * @param array|null $tagsToRemove If none, pass array() or null
645 * @param int|null $rc_id The rc_id of the change to add the tags to
646 * @param int|null $rev_id The rev_id of the change to add the tags to
647 * @param int|null $log_id The log_id of the change to add the tags to
648 * @param string $params Params to put in the ct_params field of table
649 * 'change_tag' when adding tags
650 * @param string $reason Comment for the log
651 * @param User $user Who to give credit for the action
652 * @return Status If successful, the value of this Status object will be an
653 * object (stdClass) with the following fields:
654 * - logId: the ID of the added log entry, or null if no log entry was added
655 * (i.e. no operation was performed)
656 * - addedTags: an array containing the tags that were actually added
657 * - removedTags: an array containing the tags that were actually removed
660 public static function updateTagsWithChecks( $tagsToAdd, $tagsToRemove,
661 $rc_id, $rev_id, $log_id, $params, $reason, User
$user
663 if ( is_null( $tagsToAdd ) ) {
666 if ( is_null( $tagsToRemove ) ) {
669 if ( !$tagsToAdd && !$tagsToRemove ) {
670 // no-op, don't bother
671 return Status
::newGood( (object)[
678 // are we allowed to do this?
679 $result = self
::canUpdateTags( $tagsToAdd, $tagsToRemove, $user );
680 if ( !$result->isOK() ) {
681 $result->value
= null;
685 // basic rate limiting
686 if ( $user->pingLimiter( 'changetag' ) ) {
687 return Status
::newFatal( 'actionthrottledtext' );
691 list( $tagsAdded, $tagsRemoved, $initialTags ) = self
::updateTags( $tagsToAdd,
692 $tagsToRemove, $rc_id, $rev_id, $log_id, $params, null, $user );
693 if ( !$tagsAdded && !$tagsRemoved ) {
694 // no-op, don't log it
695 return Status
::newGood( (object)[
703 $logEntry = new ManualLogEntry( 'tag', 'update' );
704 $logEntry->setPerformer( $user );
705 $logEntry->setComment( $reason );
707 // find the appropriate target page
709 $rev = Revision
::newFromId( $rev_id );
711 $logEntry->setTarget( $rev->getTitle() );
713 } elseif ( $log_id ) {
714 // This function is from revision deletion logic and has nothing to do with
715 // change tags, but it appears to be the only other place in core where we
716 // perform logged actions on log items.
717 $logEntry->setTarget( RevDelLogList
::suggestTarget( null, [ $log_id ] ) );
720 if ( !$logEntry->getTarget() ) {
721 // target is required, so we have to set something
722 $logEntry->setTarget( SpecialPage
::getTitleFor( 'Tags' ) );
726 '4::revid' => $rev_id,
727 '5::logid' => $log_id,
728 '6:list:tagsAdded' => $tagsAdded,
729 '7:number:tagsAddedCount' => count( $tagsAdded ),
730 '8:list:tagsRemoved' => $tagsRemoved,
731 '9:number:tagsRemovedCount' => count( $tagsRemoved ),
732 'initialTags' => $initialTags,
734 $logEntry->setParameters( $logParams );
735 $logEntry->setRelations( [ 'Tag' => array_merge( $tagsAdded, $tagsRemoved ) ] );
737 $dbw = wfGetDB( DB_MASTER
);
738 $logId = $logEntry->insert( $dbw );
739 // Only send this to UDP, not RC, similar to patrol events
740 $logEntry->publish( $logId, 'udp' );
742 return Status
::newGood( (object)[
744 'addedTags' => $tagsAdded,
745 'removedTags' => $tagsRemoved,
750 * Applies all tags-related changes to a query.
751 * Handles selecting tags, and filtering.
752 * Needs $tables to be set up properly, so we can figure out which join conditions to use.
754 * WARNING: If $filter_tag contains more than one tag, this function will add DISTINCT,
755 * which may cause performance problems for your query unless you put the ID field of your
756 * table at the end of the ORDER BY, and set a GROUP BY equal to the ORDER BY. For example,
757 * if you had ORDER BY foo_timestamp DESC, you will now need GROUP BY foo_timestamp, foo_id
758 * ORDER BY foo_timestamp DESC, foo_id DESC.
760 * @param string|array &$tables Table names, see Database::select
761 * @param string|array &$fields Fields used in query, see Database::select
762 * @param string|array &$conds Conditions used in query, see Database::select
763 * @param array &$join_conds Join conditions, see Database::select
764 * @param string|array &$options Options, see Database::select
765 * @param string|array $filter_tag Tag(s) to select on
767 * @throws MWException When unable to determine appropriate JOIN condition for tagging
769 public static function modifyDisplayQuery( &$tables, &$fields, &$conds,
770 &$join_conds, &$options, $filter_tag = ''
772 global $wgUseTagFilter;
774 // Normalize to arrays
775 $tables = (array)$tables;
776 $fields = (array)$fields;
777 $conds = (array)$conds;
778 $options = (array)$options;
780 // Figure out which ID field to use
781 if ( in_array( 'recentchanges', $tables ) ) {
782 $join_cond = 'ct_rc_id=rc_id';
783 } elseif ( in_array( 'logging', $tables ) ) {
784 $join_cond = 'ct_log_id=log_id';
785 } elseif ( in_array( 'revision', $tables ) ) {
786 $join_cond = 'ct_rev_id=rev_id';
787 } elseif ( in_array( 'archive', $tables ) ) {
788 $join_cond = 'ct_rev_id=ar_rev_id';
790 throw new MWException( 'Unable to determine appropriate JOIN condition for tagging.' );
793 $fields['ts_tags'] = wfGetDB( DB_REPLICA
)->buildGroupConcatField(
794 ',', 'change_tag', 'ct_tag', $join_cond
797 if ( $wgUseTagFilter && $filter_tag ) {
798 // Somebody wants to filter on a tag.
799 // Add an INNER JOIN on change_tag
801 $tables[] = 'change_tag';
802 $join_conds['change_tag'] = [ 'INNER JOIN', $join_cond ];
803 $conds['ct_tag'] = $filter_tag;
805 is_array( $filter_tag ) && count( $filter_tag ) > 1 &&
806 !in_array( 'DISTINCT', $options )
808 $options[] = 'DISTINCT';
814 * Build a text box to select a change tag
816 * @param string $selected Tag to select by default
817 * @param bool $ooui Use an OOUI TextInputWidget as selector instead of a non-OOUI input field
818 * You need to call OutputPage::enableOOUI() yourself.
819 * @param IContextSource|null $context
820 * @note Even though it takes null as a valid argument, an IContextSource is preferred
821 * in a new code, as the null value can change in the future
822 * @return array an array of (label, selector)
824 public static function buildTagFilterSelector(
825 $selected = '', $ooui = false, IContextSource
$context = null
828 $context = RequestContext
::getMain();
831 $config = $context->getConfig();
832 if ( !$config->get( 'UseTagFilter' ) ||
!count( self
::listDefinedTags() ) ) {
839 [ 'for' => 'tagfilter' ],
840 $context->msg( 'tag-filter' )->parse()
845 $data[] = new OOUI\
TextInputWidget( [
847 'name' => 'tagfilter',
848 'value' => $selected,
849 'classes' => 'mw-tagfilter-input',
852 $data[] = Xml
::input(
856 [ 'class' => 'mw-tagfilter-input mw-ui-input mw-ui-input-inline', 'id' => 'tagfilter' ]
864 * Defines a tag in the valid_tag table and/or update ctd_user_defined field in change_tag_def,
865 * without checking that the tag name is valid.
866 * Extensions should NOT use this function; they can use the ListDefinedTags
869 * @param string $tag Tag to create
872 public static function defineTag( $tag ) {
873 global $wgChangeTagsSchemaMigrationStage;
875 $dbw = wfGetDB( DB_MASTER
);
876 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
) {
879 'ctd_user_defined' => 1,
886 [ 'ctd_user_defined' => 1 ],
894 [ 'vt_tag' => $tag ],
898 // clear the memcache of defined tags
899 self
::purgeTagCacheAll();
903 * Removes a tag from the valid_tag table and/or update ctd_user_defined field in change_tag_def.
904 * The tag may remain in use by extensions, and may still show up as 'defined'
905 * if an extension is setting it from the ListDefinedTags hook.
907 * @param string $tag Tag to remove
910 public static function undefineTag( $tag ) {
911 global $wgChangeTagsSchemaMigrationStage;
913 $dbw = wfGetDB( DB_MASTER
);
915 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
) {
918 [ 'ctd_user_defined' => 0 ],
919 [ 'ctd_name' => $tag ],
925 [ 'ctd_name' => $tag, 'ctd_count' => 0 ],
930 $dbw->delete( 'valid_tag', [ 'vt_tag' => $tag ], __METHOD__
);
932 // clear the memcache of defined tags
933 self
::purgeTagCacheAll();
937 * Writes a tag action into the tag management log.
939 * @param string $action
941 * @param string $reason
942 * @param User $user Who to attribute the action to
943 * @param int|null $tagCount For deletion only, how many usages the tag had before
945 * @param array $logEntryTags Change tags to apply to the entry
946 * that will be created in the tag management log
947 * @return int ID of the inserted log entry
950 protected static function logTagManagementAction( $action, $tag, $reason,
951 User
$user, $tagCount = null, array $logEntryTags = []
953 $dbw = wfGetDB( DB_MASTER
);
955 $logEntry = new ManualLogEntry( 'managetags', $action );
956 $logEntry->setPerformer( $user );
957 // target page is not relevant, but it has to be set, so we just put in
958 // the title of Special:Tags
959 $logEntry->setTarget( Title
::newFromText( 'Special:Tags' ) );
960 $logEntry->setComment( $reason );
962 $params = [ '4::tag' => $tag ];
963 if ( !is_null( $tagCount ) ) {
964 $params['5:number:count'] = $tagCount;
966 $logEntry->setParameters( $params );
967 $logEntry->setRelations( [ 'Tag' => $tag ] );
968 $logEntry->setTags( $logEntryTags );
970 $logId = $logEntry->insert( $dbw );
971 $logEntry->publish( $logId );
976 * Is it OK to allow the user to activate this tag?
978 * @param string $tag Tag that you are interested in activating
979 * @param User|null $user User whose permission you wish to check, or null if
980 * you don't care (e.g. maintenance scripts)
984 public static function canActivateTag( $tag, User
$user = null ) {
985 if ( !is_null( $user ) ) {
986 if ( !$user->isAllowed( 'managechangetags' ) ) {
987 return Status
::newFatal( 'tags-manage-no-permission' );
988 } elseif ( $user->isBlocked() ) {
989 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
993 // defined tags cannot be activated (a defined tag is either extension-
994 // defined, in which case the extension chooses whether or not to active it;
995 // or user-defined, in which case it is considered active)
996 $definedTags = self
::listDefinedTags();
997 if ( in_array( $tag, $definedTags ) ) {
998 return Status
::newFatal( 'tags-activate-not-allowed', $tag );
1001 // non-existing tags cannot be activated
1002 $tagUsage = self
::tagUsageStatistics();
1003 if ( !isset( $tagUsage[$tag] ) ) { // we already know the tag is undefined
1004 return Status
::newFatal( 'tags-activate-not-found', $tag );
1007 return Status
::newGood();
1011 * Activates a tag, checking whether it is allowed first, and adding a log
1014 * Includes a call to ChangeTag::canActivateTag(), so your code doesn't need
1017 * @param string $tag
1018 * @param string $reason
1019 * @param User $user Who to give credit for the action
1020 * @param bool $ignoreWarnings Can be used for API interaction, default false
1021 * @param array $logEntryTags Change tags to apply to the entry
1022 * that will be created in the tag management log
1023 * @return Status If successful, the Status contains the ID of the added log
1024 * entry as its value
1027 public static function activateTagWithChecks( $tag, $reason, User
$user,
1028 $ignoreWarnings = false, array $logEntryTags = []
1030 // are we allowed to do this?
1031 $result = self
::canActivateTag( $tag, $user );
1032 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
1033 $result->value
= null;
1038 self
::defineTag( $tag );
1041 $logId = self
::logTagManagementAction( 'activate', $tag, $reason, $user,
1042 null, $logEntryTags );
1044 return Status
::newGood( $logId );
1048 * Is it OK to allow the user to deactivate this tag?
1050 * @param string $tag Tag that you are interested in deactivating
1051 * @param User|null $user User whose permission you wish to check, or null if
1052 * you don't care (e.g. maintenance scripts)
1056 public static function canDeactivateTag( $tag, User
$user = null ) {
1057 if ( !is_null( $user ) ) {
1058 if ( !$user->isAllowed( 'managechangetags' ) ) {
1059 return Status
::newFatal( 'tags-manage-no-permission' );
1060 } elseif ( $user->isBlocked() ) {
1061 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
1065 // only explicitly-defined tags can be deactivated
1066 $explicitlyDefinedTags = self
::listExplicitlyDefinedTags();
1067 if ( !in_array( $tag, $explicitlyDefinedTags ) ) {
1068 return Status
::newFatal( 'tags-deactivate-not-allowed', $tag );
1070 return Status
::newGood();
1074 * Deactivates a tag, checking whether it is allowed first, and adding a log
1077 * Includes a call to ChangeTag::canDeactivateTag(), so your code doesn't need
1080 * @param string $tag
1081 * @param string $reason
1082 * @param User $user Who to give credit for the action
1083 * @param bool $ignoreWarnings Can be used for API interaction, default false
1084 * @param array $logEntryTags Change tags to apply to the entry
1085 * that will be created in the tag management log
1086 * @return Status If successful, the Status contains the ID of the added log
1087 * entry as its value
1090 public static function deactivateTagWithChecks( $tag, $reason, User
$user,
1091 $ignoreWarnings = false, array $logEntryTags = []
1093 // are we allowed to do this?
1094 $result = self
::canDeactivateTag( $tag, $user );
1095 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
1096 $result->value
= null;
1101 self
::undefineTag( $tag );
1104 $logId = self
::logTagManagementAction( 'deactivate', $tag, $reason, $user,
1105 null, $logEntryTags );
1107 return Status
::newGood( $logId );
1111 * Is the tag name valid?
1113 * @param string $tag Tag that you are interested in creating
1117 public static function isTagNameValid( $tag ) {
1119 if ( $tag === '' ) {
1120 return Status
::newFatal( 'tags-create-no-name' );
1123 // tags cannot contain commas (used as a delimiter in tag_summary table),
1124 // pipe (used as a delimiter between multiple tags in
1125 // SpecialRecentchanges and friends), or slashes (would break tag description messages in
1126 // MediaWiki namespace)
1127 if ( strpos( $tag, ',' ) !== false ||
strpos( $tag, '|' ) !== false
1128 ||
strpos( $tag, '/' ) !== false ) {
1129 return Status
::newFatal( 'tags-create-invalid-chars' );
1132 // could the MediaWiki namespace description messages be created?
1133 $title = Title
::makeTitleSafe( NS_MEDIAWIKI
, "Tag-$tag-description" );
1134 if ( is_null( $title ) ) {
1135 return Status
::newFatal( 'tags-create-invalid-title-chars' );
1138 return Status
::newGood();
1142 * Is it OK to allow the user to create this tag?
1144 * Extensions should NOT use this function. In most cases, a tag can be
1145 * defined using the ListDefinedTags hook without any checking.
1147 * @param string $tag Tag that you are interested in creating
1148 * @param User|null $user User whose permission you wish to check, or null if
1149 * you don't care (e.g. maintenance scripts)
1153 public static function canCreateTag( $tag, User
$user = null ) {
1154 if ( !is_null( $user ) ) {
1155 if ( !$user->isAllowed( 'managechangetags' ) ) {
1156 return Status
::newFatal( 'tags-manage-no-permission' );
1157 } elseif ( $user->isBlocked() ) {
1158 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
1162 $status = self
::isTagNameValid( $tag );
1163 if ( !$status->isGood() ) {
1167 // does the tag already exist?
1168 $tagUsage = self
::tagUsageStatistics();
1169 if ( isset( $tagUsage[$tag] ) ||
in_array( $tag, self
::listDefinedTags() ) ) {
1170 return Status
::newFatal( 'tags-create-already-exists', $tag );
1174 $canCreateResult = Status
::newGood();
1175 Hooks
::run( 'ChangeTagCanCreate', [ $tag, $user, &$canCreateResult ] );
1176 return $canCreateResult;
1180 * Creates a tag by adding a row to the `valid_tag` table.
1181 * and/or add it to `change_tag_def` table.
1183 * Extensions should NOT use this function; they can use the ListDefinedTags
1186 * Includes a call to ChangeTag::canCreateTag(), so your code doesn't need to
1189 * @param string $tag
1190 * @param string $reason
1191 * @param User $user Who to give credit for the action
1192 * @param bool $ignoreWarnings Can be used for API interaction, default false
1193 * @param array $logEntryTags Change tags to apply to the entry
1194 * that will be created in the tag management log
1195 * @return Status If successful, the Status contains the ID of the added log
1196 * entry as its value
1199 public static function createTagWithChecks( $tag, $reason, User
$user,
1200 $ignoreWarnings = false, array $logEntryTags = []
1202 // are we allowed to do this?
1203 $result = self
::canCreateTag( $tag, $user );
1204 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
1205 $result->value
= null;
1210 self
::defineTag( $tag );
1213 $logId = self
::logTagManagementAction( 'create', $tag, $reason, $user,
1214 null, $logEntryTags );
1216 return Status
::newGood( $logId );
1220 * Permanently removes all traces of a tag from the DB. Good for removing
1221 * misspelt or temporary tags.
1223 * This function should be directly called by maintenance scripts only, never
1224 * by user-facing code. See deleteTagWithChecks() for functionality that can
1225 * safely be exposed to users.
1227 * @param string $tag Tag to remove
1228 * @return Status The returned status will be good unless a hook changed it
1231 public static function deleteTagEverywhere( $tag ) {
1232 global $wgChangeTagsSchemaMigrationStage;
1233 $dbw = wfGetDB( DB_MASTER
);
1234 $dbw->startAtomic( __METHOD__
);
1236 // delete from valid_tag and/or set ctd_user_defined = 0
1237 self
::undefineTag( $tag );
1239 // find out which revisions use this tag, so we can delete from tag_summary
1240 $result = $dbw->select( 'change_tag',
1241 [ 'ct_rc_id', 'ct_log_id', 'ct_rev_id', 'ct_tag' ],
1242 [ 'ct_tag' => $tag ],
1244 foreach ( $result as $row ) {
1245 // remove the tag from the relevant row of tag_summary
1247 $tagsToRemove = [ $tag ];
1248 self
::updateTagSummaryRow( $tagsToAdd, $tagsToRemove, $row->ct_rc_id
,
1249 $row->ct_rev_id
, $row->ct_log_id
);
1252 // delete from change_tag
1253 $dbw->delete( 'change_tag', [ 'ct_tag' => $tag ], __METHOD__
);
1255 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
) {
1256 $dbw->delete( 'change_tag_def', [ 'ctd_name' => $tag ], __METHOD__
);
1259 $dbw->endAtomic( __METHOD__
);
1261 // give extensions a chance
1262 $status = Status
::newGood();
1263 Hooks
::run( 'ChangeTagAfterDelete', [ $tag, &$status ] );
1264 // let's not allow error results, as the actual tag deletion succeeded
1265 if ( !$status->isOK() ) {
1266 wfDebug( 'ChangeTagAfterDelete error condition downgraded to warning' );
1267 $status->setOK( true );
1270 // clear the memcache of defined tags
1271 self
::purgeTagCacheAll();
1277 * Is it OK to allow the user to delete this tag?
1279 * @param string $tag Tag that you are interested in deleting
1280 * @param User|null $user User whose permission you wish to check, or null if
1281 * you don't care (e.g. maintenance scripts)
1285 public static function canDeleteTag( $tag, User
$user = null ) {
1286 $tagUsage = self
::tagUsageStatistics();
1288 if ( !is_null( $user ) ) {
1289 if ( !$user->isAllowed( 'deletechangetags' ) ) {
1290 return Status
::newFatal( 'tags-delete-no-permission' );
1291 } elseif ( $user->isBlocked() ) {
1292 return Status
::newFatal( 'tags-manage-blocked', $user->getName() );
1296 if ( !isset( $tagUsage[$tag] ) && !in_array( $tag, self
::listDefinedTags() ) ) {
1297 return Status
::newFatal( 'tags-delete-not-found', $tag );
1300 if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > self
::MAX_DELETE_USES
) {
1301 return Status
::newFatal( 'tags-delete-too-many-uses', $tag, self
::MAX_DELETE_USES
);
1304 $softwareDefined = self
::listSoftwareDefinedTags();
1305 if ( in_array( $tag, $softwareDefined ) ) {
1306 // extension-defined tags can't be deleted unless the extension
1307 // specifically allows it
1308 $status = Status
::newFatal( 'tags-delete-not-allowed' );
1310 // user-defined tags are deletable unless otherwise specified
1311 $status = Status
::newGood();
1314 Hooks
::run( 'ChangeTagCanDelete', [ $tag, $user, &$status ] );
1319 * Deletes a tag, checking whether it is allowed first, and adding a log entry
1322 * Includes a call to ChangeTag::canDeleteTag(), so your code doesn't need to
1325 * @param string $tag
1326 * @param string $reason
1327 * @param User $user Who to give credit for the action
1328 * @param bool $ignoreWarnings Can be used for API interaction, default false
1329 * @param array $logEntryTags Change tags to apply to the entry
1330 * that will be created in the tag management log
1331 * @return Status If successful, the Status contains the ID of the added log
1332 * entry as its value
1335 public static function deleteTagWithChecks( $tag, $reason, User
$user,
1336 $ignoreWarnings = false, array $logEntryTags = []
1338 // are we allowed to do this?
1339 $result = self
::canDeleteTag( $tag, $user );
1340 if ( $ignoreWarnings ?
!$result->isOK() : !$result->isGood() ) {
1341 $result->value
= null;
1345 // store the tag usage statistics
1346 $tagUsage = self
::tagUsageStatistics();
1347 $hitcount = $tagUsage[$tag] ??
0;
1350 $deleteResult = self
::deleteTagEverywhere( $tag );
1351 if ( !$deleteResult->isOK() ) {
1352 return $deleteResult;
1356 $logId = self
::logTagManagementAction( 'delete', $tag, $reason, $user,
1357 $hitcount, $logEntryTags );
1359 $deleteResult->value
= $logId;
1360 return $deleteResult;
1364 * Lists those tags which core or extensions report as being "active".
1369 public static function listSoftwareActivatedTags() {
1371 $tags = self
::getSoftwareTags();
1372 if ( !Hooks
::isRegistered( 'ChangeTagsListActive' ) ) {
1375 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1376 return $cache->getWithSetCallback(
1377 $cache->makeKey( 'active-tags' ),
1378 WANObjectCache
::TTL_MINUTE
* 5,
1379 function ( $oldValue, &$ttl, array &$setOpts ) use ( $tags ) {
1380 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
1382 // Ask extensions which tags they consider active
1383 Hooks
::run( 'ChangeTagsListActive', [ &$tags ] );
1387 'checkKeys' => [ $cache->makeKey( 'active-tags' ) ],
1388 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1389 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1395 * Basically lists defined tags which count even if they aren't applied to anything.
1396 * It returns a union of the results of listExplicitlyDefinedTags()
1398 * @return string[] Array of strings: tags
1400 public static function listDefinedTags() {
1401 $tags1 = self
::listExplicitlyDefinedTags();
1402 $tags2 = self
::listSoftwareDefinedTags();
1403 return array_values( array_unique( array_merge( $tags1, $tags2 ) ) );
1407 * Lists tags explicitly defined in the `valid_tag` table of the database.
1408 * Tags in table 'change_tag' which are not in table 'valid_tag' are not
1411 * Tries memcached first.
1413 * @return string[] Array of strings: tags
1416 public static function listExplicitlyDefinedTags() {
1417 $fname = __METHOD__
;
1419 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1420 return $cache->getWithSetCallback(
1421 $cache->makeKey( 'valid-tags-db' ),
1422 WANObjectCache
::TTL_MINUTE
* 5,
1423 function ( $oldValue, &$ttl, array &$setOpts ) use ( $fname ) {
1424 $dbr = wfGetDB( DB_REPLICA
);
1426 $setOpts +
= Database
::getCacheSetOptions( $dbr );
1428 $tags = $dbr->selectFieldValues( 'valid_tag', 'vt_tag', [], $fname );
1430 return array_filter( array_unique( $tags ) );
1433 'checkKeys' => [ $cache->makeKey( 'valid-tags-db' ) ],
1434 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1435 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1441 * Lists tags defined by core or extensions using the ListDefinedTags hook.
1442 * Extensions need only define those tags they deem to be in active use.
1444 * Tries memcached first.
1446 * @return string[] Array of strings: tags
1449 public static function listSoftwareDefinedTags() {
1450 // core defined tags
1451 $tags = self
::getSoftwareTags( true );
1452 if ( !Hooks
::isRegistered( 'ListDefinedTags' ) ) {
1455 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1456 return $cache->getWithSetCallback(
1457 $cache->makeKey( 'valid-tags-hook' ),
1458 WANObjectCache
::TTL_MINUTE
* 5,
1459 function ( $oldValue, &$ttl, array &$setOpts ) use ( $tags ) {
1460 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
1462 Hooks
::run( 'ListDefinedTags', [ &$tags ] );
1463 return array_filter( array_unique( $tags ) );
1466 'checkKeys' => [ $cache->makeKey( 'valid-tags-hook' ) ],
1467 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1468 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1474 * Invalidates the short-term cache of defined tags used by the
1475 * list*DefinedTags functions, as well as the tag statistics cache.
1478 public static function purgeTagCacheAll() {
1479 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1481 $cache->touchCheckKey( $cache->makeKey( 'active-tags' ) );
1482 $cache->touchCheckKey( $cache->makeKey( 'valid-tags-db' ) );
1483 $cache->touchCheckKey( $cache->makeKey( 'valid-tags-hook' ) );
1485 self
::purgeTagUsageCache();
1489 * Invalidates the tag statistics cache only.
1492 public static function purgeTagUsageCache() {
1493 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1495 $cache->touchCheckKey( $cache->makeKey( 'change-tag-statistics' ) );
1499 * Returns a map of any tags used on the wiki to number of edits
1500 * tagged with them, ordered descending by the hitcount.
1501 * This does not include tags defined somewhere that have never been applied.
1503 * Keeps a short-term cache in memory, so calling this multiple times in the
1504 * same request should be fine.
1506 * @return array Array of string => int
1508 public static function tagUsageStatistics() {
1509 global $wgChangeTagsSchemaMigrationStage, $wgTagStatisticsNewTable;
1510 if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH ||
1511 ( $wgTagStatisticsNewTable && $wgChangeTagsSchemaMigrationStage > MIGRATION_OLD
)
1513 return self
::newTagUsageStatistics();
1516 $fname = __METHOD__
;
1517 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1518 return $cache->getWithSetCallback(
1519 $cache->makeKey( 'change-tag-statistics' ),
1520 WANObjectCache
::TTL_MINUTE
* 5,
1521 function ( $oldValue, &$ttl, array &$setOpts ) use ( $fname ) {
1522 $dbr = wfGetDB( DB_REPLICA
, 'vslow' );
1524 $setOpts +
= Database
::getCacheSetOptions( $dbr );
1526 $res = $dbr->select(
1528 [ 'ct_tag', 'hitcount' => 'count(*)' ],
1531 [ 'GROUP BY' => 'ct_tag', 'ORDER BY' => 'hitcount DESC' ]
1535 foreach ( $res as $row ) {
1536 $out[$row->ct_tag
] = $row->hitcount
;
1542 'checkKeys' => [ $cache->makeKey( 'change-tag-statistics' ) ],
1543 'lockTSE' => WANObjectCache
::TTL_MINUTE
* 5,
1544 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
1550 * Same self::tagUsageStatistics() but uses change_tag_def.
1552 * @return array Array of string => int
1554 private static function newTagUsageStatistics() {
1555 $dbr = wfGetDB( DB_REPLICA
);
1556 $res = $dbr->select(
1558 [ 'ctd_name', 'ctd_count' ],
1561 [ 'ORDER BY' => 'ctd_count DESC' ]
1565 foreach ( $res as $row ) {
1566 $out[$row->ctd_name
] = $row->ctd_count
;
1573 * Indicate whether change tag editing UI is relevant
1575 * Returns true if the user has the necessary right and there are any
1576 * editable tags defined.
1578 * This intentionally doesn't check "any addable || any deletable", because
1579 * it seems like it would be more confusing than useful if the checkboxes
1580 * suddenly showed up because some abuse filter stopped defining a tag and
1581 * then suddenly disappeared when someone deleted all uses of that tag.
1586 public static function showTagEditingUI( User
$user ) {
1587 return $user->isAllowed( 'changetags' ) && (bool)self
::listExplicitlyDefinedTags();