Merge "Remove newline at end of MWExceptionRenderer::getShowBacktraceError"

[lhc/web/wiklou.git] / includes / changetags / ChangeTags.php

diff --git a/includes/changetags/ChangeTags.php b/includes/changetags/ChangeTags.php
index 146d9c6..c9b5f96 100644 (file)
--- a/includes/changetags/ChangeTags.php
+++ b/includes/changetags/ChangeTags.php
@@ -21,6 +21,7 @@
  * @ingroup Change tagging
  */
 
+use MediaWiki\MediaWikiServices;
 use Wikimedia\Rdbms\Database;
 
 class ChangeTags {
@@ -119,6 +120,32 @@ class ChangeTags {
                return $msg->parse();
        }
 
+       /**
+        * Get the message object for the tag's long description.
+        *
+        * Checks if message key "mediawiki:tag-$tag-description" exists. If it does not,
+        * or if message is disabled, returns false. Otherwise, returns the message object
+        * for the long description.
+        *
+        * @param string $tag Tag
+        * @param IContextSource $context
+        * @return Message|bool Message object of the tag long description or false if
+        *  there is no description.
+        */
+       public static function tagLongDescriptionMessage( $tag, IContextSource $context ) {
+               $msg = $context->msg( "tag-$tag-description" );
+               if ( !$msg->exists() ) {
+                       return false;
+               }
+               if ( $msg->isDisabled() ) {
+                       // The message exists but is disabled, hide the description.
+                       return false;
+               }
+
+               // Message exists and isn't disabled, use it.
+               return $msg;
+       }
+
        /**
         * Add tags to a change given its rc_id, rev_id and/or log_id
         *
@@ -174,7 +201,6 @@ class ChangeTags {
                &$rev_id = null, &$log_id = null, $params = null, RecentChange $rc = null,
                User $user = null
        ) {
-
                $tagsToAdd = array_filter( (array)$tagsToAdd ); // Make sure we're submitting all tags...
                $tagsToRemove = array_filter( (array)$tagsToRemove );
 
@@ -248,8 +274,8 @@ class ChangeTags {
                // update the tag_summary row
                $prevTags = [];
                if ( !self::updateTagSummaryRow( $tagsToAdd, $tagsToRemove, $rc_id, $rev_id,
-                       $log_id, $prevTags ) ) {
-
+                       $log_id, $prevTags )
+               ) {
                        // nothing to do
                        return [ [], [], $prevTags ];
                }
@@ -316,8 +342,8 @@ class ChangeTags {
         * @since 1.25
         */
        protected static function updateTagSummaryRow( &$tagsToAdd, &$tagsToRemove,
-               $rc_id, $rev_id, $log_id, &$prevTags = [] ) {
-
+               $rc_id, $rev_id, $log_id, &$prevTags = []
+       ) {
                $dbw = wfGetDB( DB_MASTER );
 
                $tsConds = array_filter( [
@@ -392,9 +418,7 @@ class ChangeTags {
         * @return Status
         * @since 1.25
         */
-       public static function canAddTagsAccompanyingChange( array $tags,
-               User $user = null ) {
-
+       public static function canAddTagsAccompanyingChange( array $tags, User $user = null ) {
                if ( !is_null( $user ) ) {
                        if ( !$user->isAllowed( 'applychangetags' ) ) {
                                return Status::newFatal( 'tags-apply-no-permission' );
@@ -438,7 +462,6 @@ class ChangeTags {
        public static function addTagsAccompanyingChangeWithChecks(
                array $tags, $rc_id, $rev_id, $log_id, $params, User $user
        ) {
-
                // are we allowed to do this?
                $result = self::canAddTagsAccompanyingChange( $tags, $user );
                if ( !$result->isOK() ) {
@@ -464,8 +487,8 @@ class ChangeTags {
         * @since 1.25
         */
        public static function canUpdateTags( array $tagsToAdd, array $tagsToRemove,
-               User $user = null ) {
-
+               User $user = null
+       ) {
                if ( !is_null( $user ) ) {
                        if ( !$user->isAllowed( 'changetags' ) ) {
                                return Status::newFatal( 'tags-update-no-permission' );
@@ -527,8 +550,8 @@ class ChangeTags {
         * @since 1.25
         */
        public static function updateTagsWithChecks( $tagsToAdd, $tagsToRemove,
-               $rc_id, $rev_id, $log_id, $params, $reason, User $user ) {
-
+               $rc_id, $rev_id, $log_id, $params, $reason, User $user
+       ) {
                if ( is_null( $tagsToAdd ) ) {
                        $tagsToAdd = [];
                }
@@ -765,8 +788,8 @@ class ChangeTags {
         * @since 1.25
         */
        protected static function logTagManagementAction( $action, $tag, $reason,
-               User $user, $tagCount = null, array $logEntryTags = [] ) {
-
+               User $user, $tagCount = null, array $logEntryTags = []
+       ) {
                $dbw = wfGetDB( DB_MASTER );
 
                $logEntry = new ManualLogEntry( 'managetags', $action );
@@ -842,8 +865,8 @@ class ChangeTags {
         * @since 1.25
         */
        public static function activateTagWithChecks( $tag, $reason, User $user,
-               $ignoreWarnings = false, array $logEntryTags = [] ) {
-
+               $ignoreWarnings = false, array $logEntryTags = []
+       ) {
                // are we allowed to do this?
                $result = self::canActivateTag( $tag, $user );
                if ( $ignoreWarnings ? !$result->isOK() : !$result->isGood() ) {
@@ -905,8 +928,8 @@ class ChangeTags {
         * @since 1.25
         */
        public static function deactivateTagWithChecks( $tag, $reason, User $user,
-               $ignoreWarnings = false, array $logEntryTags = [] ) {
-
+               $ignoreWarnings = false, array $logEntryTags = []
+       ) {
                // are we allowed to do this?
                $result = self::canDeactivateTag( $tag, $user );
                if ( $ignoreWarnings ? !$result->isOK() : !$result->isGood() ) {
@@ -1007,8 +1030,8 @@ class ChangeTags {
         * @since 1.25
         */
        public static function createTagWithChecks( $tag, $reason, User $user,
-               $ignoreWarnings = false, array $logEntryTags = [] ) {
-
+               $ignoreWarnings = false, array $logEntryTags = []
+       ) {
                // are we allowed to do this?
                $result = self::canCreateTag( $tag, $user );
                if ( $ignoreWarnings ? !$result->isOK() : !$result->isGood() ) {
@@ -1138,8 +1161,8 @@ class ChangeTags {
         * @since 1.25
         */
        public static function deleteTagWithChecks( $tag, $reason, User $user,
-               $ignoreWarnings = false, array $logEntryTags = [] ) {
-
+               $ignoreWarnings = false, array $logEntryTags = []
+       ) {
                // are we allowed to do this?
                $result = self::canDeleteTag( $tag, $user );
                if ( $ignoreWarnings ? !$result->isOK() : !$result->isGood() ) {
@@ -1177,8 +1200,9 @@ class ChangeTags {
                if ( !Hooks::isRegistered( 'ChangeTagsListActive' ) ) {
                        return $tags;
                }
-               return ObjectCache::getMainWANInstance()->getWithSetCallback(
-                       wfMemcKey( 'active-tags' ),
+               $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
+               return $cache->getWithSetCallback(
+                       $cache->makeKey( 'active-tags' ),
                        WANObjectCache::TTL_MINUTE * 5,
                        function ( $oldValue, &$ttl, array &$setOpts ) use ( $tags ) {
                                $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
@@ -1188,7 +1212,7 @@ class ChangeTags {
                                return $tags;
                        },
                        [
-                               'checkKeys' => [ wfMemcKey( 'active-tags' ) ],
+                               'checkKeys' => [ $cache->makeKey( 'active-tags' ) ],
                                'lockTSE' => WANObjectCache::TTL_MINUTE * 5,
                                'pcTTL' => WANObjectCache::TTL_PROC_LONG
                        ]
@@ -1231,8 +1255,9 @@ class ChangeTags {
        public static function listExplicitlyDefinedTags() {
                $fname = __METHOD__;
 
-               return ObjectCache::getMainWANInstance()->getWithSetCallback(
-                       wfMemcKey( 'valid-tags-db' ),
+               $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
+               return $cache->getWithSetCallback(
+                       $cache->makeKey( 'valid-tags-db' ),
                        WANObjectCache::TTL_MINUTE * 5,
                        function ( $oldValue, &$ttl, array &$setOpts ) use ( $fname ) {
                                $dbr = wfGetDB( DB_REPLICA );
@@ -1244,7 +1269,7 @@ class ChangeTags {
                                return array_filter( array_unique( $tags ) );
                        },
                        [
-                               'checkKeys' => [ wfMemcKey( 'valid-tags-db' ) ],
+                               'checkKeys' => [ $cache->makeKey( 'valid-tags-db' ) ],
                                'lockTSE' => WANObjectCache::TTL_MINUTE * 5,
                                'pcTTL' => WANObjectCache::TTL_PROC_LONG
                        ]
@@ -1266,8 +1291,9 @@ class ChangeTags {
                if ( !Hooks::isRegistered( 'ListDefinedTags' ) ) {
                        return $tags;
                }
-               return ObjectCache::getMainWANInstance()->getWithSetCallback(
-                       wfMemcKey( 'valid-tags-hook' ),
+               $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
+               return $cache->getWithSetCallback(
+                       $cache->makeKey( 'valid-tags-hook' ),
                        WANObjectCache::TTL_MINUTE * 5,
                        function ( $oldValue, &$ttl, array &$setOpts ) use ( $tags ) {
                                $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
@@ -1276,7 +1302,7 @@ class ChangeTags {
                                return array_filter( array_unique( $tags ) );
                        },
                        [
-                               'checkKeys' => [ wfMemcKey( 'valid-tags-hook' ) ],
+                               'checkKeys' => [ $cache->makeKey( 'valid-tags-hook' ) ],
                                'lockTSE' => WANObjectCache::TTL_MINUTE * 5,
                                'pcTTL' => WANObjectCache::TTL_PROC_LONG
                        ]
@@ -1300,11 +1326,11 @@ class ChangeTags {
         * @since 1.25
         */
        public static function purgeTagCacheAll() {
-               $cache = ObjectCache::getMainWANInstance();
+               $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
 
-               $cache->touchCheckKey( wfMemcKey( 'active-tags' ) );
-               $cache->touchCheckKey( wfMemcKey( 'valid-tags-db' ) );
-               $cache->touchCheckKey( wfMemcKey( 'valid-tags-hook' ) );
+               $cache->touchCheckKey( $cache->makeKey( 'active-tags' ) );
+               $cache->touchCheckKey( $cache->makeKey( 'valid-tags-db' ) );
+               $cache->touchCheckKey( $cache->makeKey( 'valid-tags-hook' ) );
 
                self::purgeTagUsageCache();
        }
@@ -1314,9 +1340,9 @@ class ChangeTags {
         * @since 1.25
         */
        public static function purgeTagUsageCache() {
-               $cache = ObjectCache::getMainWANInstance();
+               $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
 
-               $cache->touchCheckKey( wfMemcKey( 'change-tag-statistics' ) );
+               $cache->touchCheckKey( $cache->makeKey( 'change-tag-statistics' ) );
        }
 
        /**
@@ -1331,8 +1357,9 @@ class ChangeTags {
         */
        public static function tagUsageStatistics() {
                $fname = __METHOD__;
-               return ObjectCache::getMainWANInstance()->getWithSetCallback(
-                       wfMemcKey( 'change-tag-statistics' ),
+               $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
+               return $cache->getWithSetCallback(
+                       $cache->makeKey( 'change-tag-statistics' ),
                        WANObjectCache::TTL_MINUTE * 5,
                        function ( $oldValue, &$ttl, array &$setOpts ) use ( $fname ) {
                                $dbr = wfGetDB( DB_REPLICA, 'vslow' );
@@ -1355,7 +1382,7 @@ class ChangeTags {
                                return $out;
                        },
                        [
-                               'checkKeys' => [ wfMemcKey( 'change-tag-statistics' ) ],
+                               'checkKeys' => [ $cache->makeKey( 'change-tag-statistics' ) ],
                                'lockTSE' => WANObjectCache::TTL_MINUTE * 5,
                                'pcTTL' => WANObjectCache::TTL_PROC_LONG
                        ]