Add logic for "tags" in ApiBase

Bug: T97720
Change-Id: I275c516b4744e243333ec0818d2be1e5508e54a3

diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php
index 13d13a6..c60a870 100644 (file)
--- a/includes/api/ApiBase.php
+++ b/includes/api/ApiBase.php
@@ -74,6 +74,8 @@ abstract class ApiBase extends ContextSource {
         * - string: Any non-empty string, not expected to be very long or contain newlines.
         *   <input type="text"> would be an appropriate HTML form field.
         * - submodule: The name of a submodule of this module, see PARAM_SUBMODULE_MAP.
+        * - tags: A string naming an existing, explicitly-defined tag. Should usually be
+        *   used with PARAM_ISMULTI.
         * - text: Any non-empty string, expected to be very long or contain newlines.
         *   <textarea> would be an appropriate HTML form field.
         * - timestamp: A timestamp in any format recognized by MWTimestamp, or the
@@ -1063,6 +1065,16 @@ abstract class ApiBase extends ContextSource {
                                                break;
                                        case 'upload': // nothing to do
                                                break;
+                                       case 'tags':
+                                               // If change tagging was requested, check that the tags are valid.
+                                               if ( !is_array( $value ) && !$multi ) {
+                                                       $value = array( $value );
+                                               }
+                                               $tagsStatus = ChangeTags::canAddTagsAccompanyingChange( $value );
+                                               if ( !$tagsStatus->isGood() ) {
+                                                       $this->dieStatus( $tagsStatus );
+                                               }
+                                               break;
                                        default:
                                                ApiBase::dieDebug( __METHOD__, "Param $encParamName's type is unknown - $type" );
                                }

diff --git a/includes/api/ApiDelete.php b/includes/api/ApiDelete.php
index edcee86..b0bf5dd 100644 (file)
--- a/includes/api/ApiDelete.php
+++ b/includes/api/ApiDelete.php
@@ -188,7 +188,7 @@ class ApiDelete extends ApiBase {
                        ),
                        'reason' => null,
                        'tags' => array(
-                               ApiBase::PARAM_TYPE => ChangeTags::listExplicitlyDefinedTags(),
+                               ApiBase::PARAM_TYPE => 'tags',
                                ApiBase::PARAM_ISMULTI => true,
                        ),
                        'watch' => array(

diff --git a/includes/api/ApiEditPage.php b/includes/api/ApiEditPage.php
index 59264e8..4a83129 100644 (file)
--- a/includes/api/ApiEditPage.php
+++ b/includes/api/ApiEditPage.php
@@ -363,10 +363,11 @@ class ApiEditPage extends ApiBase {
 
                // Apply change tags
                if ( count( $params['tags'] ) ) {
-                       if ( $user->isAllowed( 'applychangetags' ) ) {
+                       $tagStatus = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
+                       if ( $tagStatus->isOk() ) {
                                $requestArray['wpChangeTags'] = implode( ',', $params['tags'] );
                        } else {
-                               $this->dieUsage( 'You don\'t have permission to set change tags.', 'taggingnotallowed' );
+                               $this->dieStatus( $tagStatus );
                        }
                }
 
@@ -579,7 +580,7 @@ class ApiEditPage extends ApiBase {
                        ),
                        'summary' => null,
                        'tags' => array(
-                               ApiBase::PARAM_TYPE => ChangeTags::listExplicitlyDefinedTags(),
+                               ApiBase::PARAM_TYPE => 'tags',
                                ApiBase::PARAM_ISMULTI => true,
                        ),
                        'minor' => false,

diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php
index bbea20b..c4bf7d8 100644 (file)
--- a/includes/api/ApiHelp.php
+++ b/includes/api/ApiHelp.php
@@ -533,6 +533,17 @@ class ApiHelp extends ApiBase {
                                                                        $type = null;
                                                                        break;
 
+                                                               case 'tags':
+                                                                       $tags = ChangeTags::listExplicitlyDefinedTags();
+                                                                       $count = count( $tags );
+                                                                       $info[] = $context->msg( 'api-help-param-list' )
+                                                                               ->params( $multi ? 2 : 1 )
+                                                                               ->params( $context->getLanguage()->commaList( $tags ) )
+                                                                               ->parse();
+                                                                       $hintPipeSeparated = false;
+                                                                       $type = null;
+                                                                       break;
+
                                                                case 'limit':
                                                                        if ( isset( $settings[ApiBase::PARAM_MAX2] ) ) {
                                                                                $info[] = $context->msg( 'api-help-param-limit2' )

diff --git a/includes/api/ApiParamInfo.php b/includes/api/ApiParamInfo.php
index 18ca0ab..a8e5629 100644 (file)
--- a/includes/api/ApiParamInfo.php
+++ b/includes/api/ApiParamInfo.php
@@ -338,6 +338,8 @@ class ApiParamInfo extends ApiBase {
                                        if ( isset( $settings[ApiBase::PARAM_SUBMODULE_PARAM_PREFIX] ) ) {
                                                $item['submoduleparamprefix'] = $settings[ApiBase::PARAM_SUBMODULE_PARAM_PREFIX];
                                        }
+                               } elseif ( $settings[ApiBase::PARAM_TYPE] === 'tags' ) {
+                                       $item['type'] = ChangeTags::listExplicitlyDefinedTags();
                                } else {
                                        $item['type'] = $settings[ApiBase::PARAM_TYPE];
                                }

diff --git a/includes/api/ApiRollback.php b/includes/api/ApiRollback.php
index 0fa2e31..055c7fe 100644 (file)
--- a/includes/api/ApiRollback.php
+++ b/includes/api/ApiRollback.php
@@ -122,7 +122,7 @@ class ApiRollback extends ApiBase {
                                ApiBase::PARAM_TYPE => 'integer'
                        ),
                        'tags' => array(
-                               ApiBase::PARAM_TYPE => ChangeTags::listExplicitlyDefinedTags(),
+                               ApiBase::PARAM_TYPE => 'tags',
                                ApiBase::PARAM_ISMULTI => true,
                        ),
                        'user' => array(

diff --git a/includes/api/ApiTag.php b/includes/api/ApiTag.php
index 4bf799e..c1a6810 100644 (file)
--- a/includes/api/ApiTag.php
+++ b/includes/api/ApiTag.php
@@ -25,10 +25,6 @@
  */
 class ApiTag extends ApiBase {
 
-       protected function getAvailableTags() {
-               return ChangeTags::listExplicitlyDefinedTags();
-       }
-
        public function execute() {
                $params = $this->extractRequestParams();
                $user = $this->getUser();
@@ -150,7 +146,7 @@ class ApiTag extends ApiBase {
                                ApiBase::PARAM_ISMULTI => true,
                        ),
                        'add' => array(
-                               ApiBase::PARAM_TYPE => $this->getAvailableTags(),
+                               ApiBase::PARAM_TYPE => 'tags',
                                ApiBase::PARAM_ISMULTI => true,
                        ),
                        'remove' => array(