Add new core tags
[lhc/web/wiklou.git] / includes / changetags / ChangeTags.php
index 6ba9c10..b4a8ca8 100644 (file)
@@ -32,10 +32,44 @@ class ChangeTags {
         */
        const MAX_DELETE_USES = 5000;
 
+       private static $definedSoftwareTags = [
+               'mw-contentmodelchange',
+               'mw-new-redirect',
+               'mw-removed-redirect',
+               'mw-changed-redirect-target',
+               'mw-blank',
+               'mw-replace',
+               'mw-rollback'
+       ];
+
        /**
-        * @var string[]
+        * Loads defined core tags, checks for invalid types (if not array),
+        * and filters for supported and enabled (if $all is false) tags only.
+        *
+        * @param bool $all If true, return all valid defined tags. Otherwise, return only enabled ones.
+        * @return array Array of all defined/enabled tags.
         */
-       private static $coreTags = [ 'mw-contentmodelchange' ];
+       public static function getSoftwareTags( $all = false ) {
+               global $wgSoftwareTags;
+               $softwareTags = [];
+
+               if ( !is_array( $wgSoftwareTags ) ) {
+                       wfWarn( 'wgSoftwareTags should be associative array of enabled tags.
+                       Please refer to documentation for the list of tags you can enable' );
+                       return $softwareTags;
+               }
+
+               $availableSoftwareTags = !$all ?
+                       array_keys( array_filter( $wgSoftwareTags ) ) :
+                       array_keys( $wgSoftwareTags );
+
+               $softwareTags = array_intersect(
+                       $availableSoftwareTags,
+                       self::$definedSoftwareTags
+               );
+
+               return $softwareTags;
+       }
 
        /**
         * Creates HTML for the given tags
@@ -201,7 +235,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 );
 
@@ -275,8 +308,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 ];
                }
@@ -343,8 +376,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( [
@@ -419,9 +452,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' );
@@ -465,7 +496,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() ) {
@@ -491,8 +521,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' );
@@ -554,8 +584,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 = [];
                }
@@ -647,24 +677,32 @@ class ChangeTags {
         * Handles selecting tags, and filtering.
         * Needs $tables to be set up properly, so we can figure out which join conditions to use.
         *
-        * @param string|array $tables Table names, see Database::select
-        * @param string|array $fields Fields used in query, see Database::select
-        * @param string|array $conds Conditions used in query, see Database::select
-        * @param array $join_conds Join conditions, see Database::select
-        * @param array $options Options, see Database::select
-        * @param bool|string $filter_tag Tag to select on
+        * WARNING: If $filter_tag contains more than one tag, this function will add DISTINCT,
+        * which may cause performance problems for your query unless you put the ID field of your
+        * table at the end of the ORDER BY, and set a GROUP BY equal to the ORDER BY. For example,
+        * if you had ORDER BY foo_timestamp DESC, you will now need GROUP BY foo_timestamp, foo_id
+        * ORDER BY foo_timestamp DESC, foo_id DESC.
+        *
+        * @param string|array &$tables Table names, see Database::select
+        * @param string|array &$fields Fields used in query, see Database::select
+        * @param string|array &$conds Conditions used in query, see Database::select
+        * @param array &$join_conds Join conditions, see Database::select
+        * @param string|array &$options Options, see Database::select
+        * @param string|array $filter_tag Tag(s) to select on
         *
         * @throws MWException When unable to determine appropriate JOIN condition for tagging
         */
        public static function modifyDisplayQuery( &$tables, &$fields, &$conds,
-                                                                               &$join_conds, &$options, $filter_tag = false ) {
-               global $wgRequest, $wgUseTagFilter;
+                                                                               &$join_conds, &$options, $filter_tag = '' ) {
+               global $wgUseTagFilter;
 
-               if ( $filter_tag === false ) {
-                       $filter_tag = $wgRequest->getVal( 'tagfilter' );
-               }
+               // Normalize to arrays
+               $tables = (array)$tables;
+               $fields = (array)$fields;
+               $conds = (array)$conds;
+               $options = (array)$options;
 
-               // Figure out which conditions can be done.
+               // Figure out which ID field to use
                if ( in_array( 'recentchanges', $tables ) ) {
                        $join_cond = 'ct_rc_id=rc_id';
                } elseif ( in_array( 'logging', $tables ) ) {
@@ -687,7 +725,13 @@ class ChangeTags {
 
                        $tables[] = 'change_tag';
                        $join_conds['change_tag'] = [ 'INNER JOIN', $join_cond ];
-                       $conds['ct_tag'] = explode( '|', $filter_tag );
+                       $conds['ct_tag'] = $filter_tag;
+                       if (
+                               is_array( $filter_tag ) && count( $filter_tag ) > 1 &&
+                               !in_array( 'DISTINCT', $options )
+                       ) {
+                               $options[] = 'DISTINCT';
+                       }
                }
        }
 
@@ -792,8 +836,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 );
@@ -869,8 +913,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() ) {
@@ -932,8 +976,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() ) {
@@ -966,7 +1010,7 @@ class ChangeTags {
 
                // tags cannot contain commas (used as a delimiter in tag_summary table),
                // pipe (used as a delimiter between multiple tags in
-               // modifyDisplayQuery), or slashes (would break tag description messages in
+               // SpecialRecentchanges and friends), or slashes (would break tag description messages in
                // MediaWiki namespace)
                if ( strpos( $tag, ',' ) !== false || strpos( $tag, '|' ) !== false
                        || strpos( $tag, '/' ) !== false ) {
@@ -1034,8 +1078,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() ) {
@@ -1165,8 +1209,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() ) {
@@ -1200,7 +1244,7 @@ class ChangeTags {
         */
        public static function listSoftwareActivatedTags() {
                // core active tags
-               $tags = self::$coreTags;
+               $tags = self::getSoftwareTags();
                if ( !Hooks::isRegistered( 'ChangeTagsListActive' ) ) {
                        return $tags;
                }
@@ -1291,7 +1335,7 @@ class ChangeTags {
         */
        public static function listSoftwareDefinedTags() {
                // core defined tags
-               $tags = self::$coreTags;
+               $tags = self::getSoftwareTags( true );
                if ( !Hooks::isRegistered( 'ListDefinedTags' ) ) {
                        return $tags;
                }
@@ -1318,6 +1362,7 @@ class ChangeTags {
         *
         * @see listSoftwareDefinedTags
         * @deprecated since 1.28
+        * @return array
         */
        public static function listExtensionDefinedTags() {
                wfDeprecated( __METHOD__, '1.28' );