From 5522a7a9b8a4b95d37aa12996d5fff98e3a24bc4 Mon Sep 17 00:00:00 2001
From: Reedy <reedy@wikimedia.org>
Date: Fri, 25 May 2018 01:59:49 +0100
Subject: [PATCH] Split ApiMessage to class per file

Change-Id: If8f51e6535d0ec6e35336a6702c5e35be35bcf09
---
 .phpcs.xml                       |   1 -
 autoload.php                     |   6 +-
 includes/api/ApiMessage.php      | 212 -------------------------------
 includes/api/ApiMessageTrait.php | 145 +++++++++++++++++++++
 includes/api/ApiRawMessage.php   |  52 ++++++++
 includes/api/IApiMessage.php     |  69 ++++++++++
 6 files changed, 269 insertions(+), 216 deletions(-)
 create mode 100644 includes/api/ApiMessageTrait.php
 create mode 100644 includes/api/ApiRawMessage.php
 create mode 100644 includes/api/IApiMessage.php

diff --git a/.phpcs.xml b/.phpcs.xml
index e83198b5e4..e86855606d 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -72,7 +72,6 @@
 			Whitelist existing violations, but enable the sniff to prevent
 			any new occurrences.
 		-->
-		<exclude-pattern>*/includes/api/ApiMessage\.php</exclude-pattern>
 		<exclude-pattern>*/includes/api/ApiUsageException\.php</exclude-pattern>
 		<exclude-pattern>*/includes/media/XCF\.php</exclude-pattern>
 		<exclude-pattern>*/includes/Feed\.php</exclude-pattern>
diff --git a/autoload.php b/autoload.php
index d4533a51ee..6c484768f9 100644
--- a/autoload.php
+++ b/autoload.php
@@ -64,7 +64,7 @@ $wgAutoloadLocalClasses = [
 	'ApiManageTags' => __DIR__ . '/includes/api/ApiManageTags.php',
 	'ApiMergeHistory' => __DIR__ . '/includes/api/ApiMergeHistory.php',
 	'ApiMessage' => __DIR__ . '/includes/api/ApiMessage.php',
-	'ApiMessageTrait' => __DIR__ . '/includes/api/ApiMessage.php',
+	'ApiMessageTrait' => __DIR__ . '/includes/api/ApiMessageTrait.php',
 	'ApiModuleManager' => __DIR__ . '/includes/api/ApiModuleManager.php',
 	'ApiMove' => __DIR__ . '/includes/api/ApiMove.php',
 	'ApiOpenSearch' => __DIR__ . '/includes/api/ApiOpenSearch.php',
@@ -134,7 +134,7 @@ $wgAutoloadLocalClasses = [
 	'ApiQueryUsers' => __DIR__ . '/includes/api/ApiQueryUsers.php',
 	'ApiQueryWatchlist' => __DIR__ . '/includes/api/ApiQueryWatchlist.php',
 	'ApiQueryWatchlistRaw' => __DIR__ . '/includes/api/ApiQueryWatchlistRaw.php',
-	'ApiRawMessage' => __DIR__ . '/includes/api/ApiMessage.php',
+	'ApiRawMessage' => __DIR__ . '/includes/api/ApiRawMessage.php',
 	'ApiRemoveAuthenticationData' => __DIR__ . '/includes/api/ApiRemoveAuthenticationData.php',
 	'ApiResetPassword' => __DIR__ . '/includes/api/ApiResetPassword.php',
 	'ApiResult' => __DIR__ . '/includes/api/ApiResult.php',
@@ -625,7 +625,7 @@ $wgAutoloadLocalClasses = [
 	'Http' => __DIR__ . '/includes/http/Http.php',
 	'HttpError' => __DIR__ . '/includes/exception/HttpError.php',
 	'HttpStatus' => __DIR__ . '/includes/libs/HttpStatus.php',
-	'IApiMessage' => __DIR__ . '/includes/api/ApiMessage.php',
+	'IApiMessage' => __DIR__ . '/includes/api/IApiMessage.php',
 	'IBufferingStatsdDataFactory' => __DIR__ . '/includes/libs/stats/IBufferingStatsdDataFactory.php',
 	'ICacheHelper' => __DIR__ . '/includes/cache/CacheHelper.php',
 	'IContextSource' => __DIR__ . '/includes/context/IContextSource.php',
diff --git a/includes/api/ApiMessage.php b/includes/api/ApiMessage.php
index 3347128757..6a8b7d0aed 100644
--- a/includes/api/ApiMessage.php
+++ b/includes/api/ApiMessage.php
@@ -1,8 +1,5 @@
 <?php
 /**
- * Defines an interface for messages with additional machine-readable data for
- * use by the API, and provides concrete implementations of that interface.
- *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
@@ -21,182 +18,6 @@
  * @file
  */
 
-/**
- * Interface for messages with machine-readable data for use by the API
- *
- * The idea is that it's a Message that has some extra data for the API to use when interpreting it
- * as an error (or, in the future, as a warning). Internals of MediaWiki often use messages (or
- * message keys, or Status objects containing messages) to pass information about errors to the user
- * (see e.g. Title::getUserPermissionsErrors()) and the API has to make do with that.
- *
- * @since 1.25
- * @note This interface exists to work around PHP's inheritance, so ApiMessage
- *  can extend Message and ApiRawMessage can extend RawMessage while still
- *  allowing an instanceof check for a Message object including this
- *  functionality. If for some reason you feel the need to implement this
- *  interface on some other class, that class must also implement all the
- *  public methods the Message class provides (not just those from
- *  MessageSpecifier, which as written is fairly useless).
- * @ingroup API
- */
-interface IApiMessage extends MessageSpecifier {
-	/**
-	 * Returns a machine-readable code for use by the API
-	 *
-	 * If no code was specifically set, the message key is used as the code
-	 * after removing "apiwarn-" or "apierror-" prefixes and applying
-	 * backwards-compatibility mappings.
-	 *
-	 * @return string
-	 */
-	public function getApiCode();
-
-	/**
-	 * Returns additional machine-readable data about the error condition
-	 * @return array
-	 */
-	public function getApiData();
-
-	/**
-	 * Sets the machine-readable code for use by the API
-	 * @param string|null $code If null, uses the default (see self::getApiCode())
-	 * @param array|null $data If non-null, passed to self::setApiData()
-	 */
-	public function setApiCode( $code, array $data = null );
-
-	/**
-	 * Sets additional machine-readable data about the error condition
-	 * @param array $data
-	 */
-	public function setApiData( array $data );
-}
-
-/**
- * Trait to implement the IApiMessage interface for Message subclasses
- * @since 1.27
- * @ingroup API
- */
-trait ApiMessageTrait {
-
-	/**
-	 * Compatibility code mappings for various MW messages.
-	 * @todo Ideally anything relying on this should be changed to use ApiMessage.
-	 */
-	protected static $messageMap = [
-		'actionthrottledtext' => 'ratelimited',
-		'autoblockedtext' => 'autoblocked',
-		'badaccess-group0' => 'permissiondenied',
-		'badaccess-groups' => 'permissiondenied',
-		'badipaddress' => 'invalidip',
-		'blankpage' => 'emptypage',
-		'blockedtext' => 'blocked',
-		'cannotdelete' => 'cantdelete',
-		'cannotundelete' => 'cantundelete',
-		'cantmove-titleprotected' => 'protectedtitle',
-		'cantrollback' => 'onlyauthor',
-		'confirmedittext' => 'confirmemail',
-		'content-not-allowed-here' => 'contentnotallowedhere',
-		'deleteprotected' => 'cantedit',
-		'delete-toobig' => 'bigdelete',
-		'edit-conflict' => 'editconflict',
-		'imagenocrossnamespace' => 'nonfilenamespace',
-		'imagetypemismatch' => 'filetypemismatch',
-		'importbadinterwiki' => 'badinterwiki',
-		'importcantopen' => 'cantopenfile',
-		'import-noarticle' => 'badinterwiki',
-		'importnofile' => 'nofile',
-		'importuploaderrorpartial' => 'partialupload',
-		'importuploaderrorsize' => 'filetoobig',
-		'importuploaderrortemp' => 'notempdir',
-		'ipb_already_blocked' => 'alreadyblocked',
-		'ipb_blocked_as_range' => 'blockedasrange',
-		'ipb_cant_unblock' => 'cantunblock',
-		'ipb_expiry_invalid' => 'invalidexpiry',
-		'ip_range_invalid' => 'invalidrange',
-		'mailnologin' => 'cantsend',
-		'markedaspatrollederror-noautopatrol' => 'noautopatrol',
-		'movenologintext' => 'cantmove-anon',
-		'movenotallowed' => 'cantmove',
-		'movenotallowedfile' => 'cantmovefile',
-		'namespaceprotected' => 'protectednamespace',
-		'nocreate-loggedin' => 'cantcreate',
-		'nocreatetext' => 'cantcreate-anon',
-		'noname' => 'invaliduser',
-		'nosuchusershort' => 'nosuchuser',
-		'notanarticle' => 'missingtitle',
-		'nouserspecified' => 'invaliduser',
-		'ns-specialprotected' => 'unsupportednamespace',
-		'protect-cantedit' => 'cantedit',
-		'protectedinterface' => 'protectednamespace-interface',
-		'protectedpagetext' => 'protectedpage',
-		'range_block_disabled' => 'rangedisabled',
-		'rcpatroldisabled' => 'patroldisabled',
-		'readonlytext' => 'readonly',
-		'sessionfailure' => 'badtoken',
-		'systemblockedtext' => 'blocked',
-		'titleprotected' => 'protectedtitle',
-		'undo-failure' => 'undofailure',
-		'userrights-nodatabase' => 'nosuchdatabase',
-		'userrights-no-interwiki' => 'nointerwikiuserrights',
-	];
-
-	protected $apiCode = null;
-	protected $apiData = [];
-
-	public function getApiCode() {
-		if ( $this->apiCode === null ) {
-			$key = $this->getKey();
-			if ( isset( self::$messageMap[$key] ) ) {
-				$this->apiCode = self::$messageMap[$key];
-			} elseif ( $key === 'apierror-missingparam' ) {
-				/// @todo: Kill this case along with ApiBase::$messageMap
-				$this->apiCode = 'no' . $this->getParams()[0];
-			} elseif ( substr( $key, 0, 8 ) === 'apiwarn-' ) {
-				$this->apiCode = substr( $key, 8 );
-			} elseif ( substr( $key, 0, 9 ) === 'apierror-' ) {
-				$this->apiCode = substr( $key, 9 );
-			} else {
-				$this->apiCode = $key;
-			}
-		}
-		return $this->apiCode;
-	}
-
-	public function setApiCode( $code, array $data = null ) {
-		if ( $code !== null && !( is_string( $code ) && $code !== '' ) ) {
-			throw new InvalidArgumentException( "Invalid code \"$code\"" );
-		}
-
-		$this->apiCode = $code;
-		if ( $data !== null ) {
-			$this->setApiData( $data );
-		}
-	}
-
-	public function getApiData() {
-		return $this->apiData;
-	}
-
-	public function setApiData( array $data ) {
-		$this->apiData = $data;
-	}
-
-	public function serialize() {
-		return serialize( [
-			'parent' => parent::serialize(),
-			'apiCode' => $this->apiCode,
-			'apiData' => $this->apiData,
-		] );
-	}
-
-	public function unserialize( $serialized ) {
-		$data = unserialize( $serialized );
-		parent::unserialize( $data['parent'] );
-		$this->apiCode = $data['apiCode'];
-		$this->apiData = $data['apiData'];
-	}
-}
-
 /**
  * Extension of Message implementing IApiMessage
  * @since 1.25
@@ -266,36 +87,3 @@ class ApiMessage extends Message implements IApiMessage {
 		$this->setApiCode( $code, $data );
 	}
 }
-
-/**
- * Extension of RawMessage implementing IApiMessage
- * @since 1.25
- * @ingroup API
- */
-class ApiRawMessage extends RawMessage implements IApiMessage {
-	use ApiMessageTrait;
-
-	/**
-	 * @param RawMessage|string|array $msg
-	 *  - RawMessage: is cloned
-	 *  - array: first element is $key, rest are $params to RawMessage::__construct
-	 *  - string: passed to RawMessage::__construct
-	 * @param string|null $code
-	 * @param array|null $data
-	 */
-	public function __construct( $msg, $code = null, array $data = null ) {
-		if ( $msg instanceof RawMessage ) {
-			foreach ( get_class_vars( get_class( $this ) ) as $key => $value ) {
-				if ( isset( $msg->$key ) ) {
-					$this->$key = $msg->$key;
-				}
-			}
-		} elseif ( is_array( $msg ) ) {
-			$key = array_shift( $msg );
-			parent::__construct( $key, $msg );
-		} else {
-			parent::__construct( $msg );
-		}
-		$this->setApiCode( $code, $data );
-	}
-}
diff --git a/includes/api/ApiMessageTrait.php b/includes/api/ApiMessageTrait.php
new file mode 100644
index 0000000000..18b6bc42c1
--- /dev/null
+++ b/includes/api/ApiMessageTrait.php
@@ -0,0 +1,145 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Trait to implement the IApiMessage interface for Message subclasses
+ * @since 1.27
+ * @ingroup API
+ */
+trait ApiMessageTrait {
+
+	/**
+	 * Compatibility code mappings for various MW messages.
+	 * @todo Ideally anything relying on this should be changed to use ApiMessage.
+	 */
+	protected static $messageMap = [
+		'actionthrottledtext' => 'ratelimited',
+		'autoblockedtext' => 'autoblocked',
+		'badaccess-group0' => 'permissiondenied',
+		'badaccess-groups' => 'permissiondenied',
+		'badipaddress' => 'invalidip',
+		'blankpage' => 'emptypage',
+		'blockedtext' => 'blocked',
+		'cannotdelete' => 'cantdelete',
+		'cannotundelete' => 'cantundelete',
+		'cantmove-titleprotected' => 'protectedtitle',
+		'cantrollback' => 'onlyauthor',
+		'confirmedittext' => 'confirmemail',
+		'content-not-allowed-here' => 'contentnotallowedhere',
+		'deleteprotected' => 'cantedit',
+		'delete-toobig' => 'bigdelete',
+		'edit-conflict' => 'editconflict',
+		'imagenocrossnamespace' => 'nonfilenamespace',
+		'imagetypemismatch' => 'filetypemismatch',
+		'importbadinterwiki' => 'badinterwiki',
+		'importcantopen' => 'cantopenfile',
+		'import-noarticle' => 'badinterwiki',
+		'importnofile' => 'nofile',
+		'importuploaderrorpartial' => 'partialupload',
+		'importuploaderrorsize' => 'filetoobig',
+		'importuploaderrortemp' => 'notempdir',
+		'ipb_already_blocked' => 'alreadyblocked',
+		'ipb_blocked_as_range' => 'blockedasrange',
+		'ipb_cant_unblock' => 'cantunblock',
+		'ipb_expiry_invalid' => 'invalidexpiry',
+		'ip_range_invalid' => 'invalidrange',
+		'mailnologin' => 'cantsend',
+		'markedaspatrollederror-noautopatrol' => 'noautopatrol',
+		'movenologintext' => 'cantmove-anon',
+		'movenotallowed' => 'cantmove',
+		'movenotallowedfile' => 'cantmovefile',
+		'namespaceprotected' => 'protectednamespace',
+		'nocreate-loggedin' => 'cantcreate',
+		'nocreatetext' => 'cantcreate-anon',
+		'noname' => 'invaliduser',
+		'nosuchusershort' => 'nosuchuser',
+		'notanarticle' => 'missingtitle',
+		'nouserspecified' => 'invaliduser',
+		'ns-specialprotected' => 'unsupportednamespace',
+		'protect-cantedit' => 'cantedit',
+		'protectedinterface' => 'protectednamespace-interface',
+		'protectedpagetext' => 'protectedpage',
+		'range_block_disabled' => 'rangedisabled',
+		'rcpatroldisabled' => 'patroldisabled',
+		'readonlytext' => 'readonly',
+		'sessionfailure' => 'badtoken',
+		'systemblockedtext' => 'blocked',
+		'titleprotected' => 'protectedtitle',
+		'undo-failure' => 'undofailure',
+		'userrights-nodatabase' => 'nosuchdatabase',
+		'userrights-no-interwiki' => 'nointerwikiuserrights',
+	];
+
+	protected $apiCode = null;
+	protected $apiData = [];
+
+	public function getApiCode() {
+		if ( $this->apiCode === null ) {
+			$key = $this->getKey();
+			if ( isset( self::$messageMap[$key] ) ) {
+				$this->apiCode = self::$messageMap[$key];
+			} elseif ( $key === 'apierror-missingparam' ) {
+				/// @todo: Kill this case along with ApiBase::$messageMap
+				$this->apiCode = 'no' . $this->getParams()[0];
+			} elseif ( substr( $key, 0, 8 ) === 'apiwarn-' ) {
+				$this->apiCode = substr( $key, 8 );
+			} elseif ( substr( $key, 0, 9 ) === 'apierror-' ) {
+				$this->apiCode = substr( $key, 9 );
+			} else {
+				$this->apiCode = $key;
+			}
+		}
+		return $this->apiCode;
+	}
+
+	public function setApiCode( $code, array $data = null ) {
+		if ( $code !== null && !( is_string( $code ) && $code !== '' ) ) {
+			throw new InvalidArgumentException( "Invalid code \"$code\"" );
+		}
+
+		$this->apiCode = $code;
+		if ( $data !== null ) {
+			$this->setApiData( $data );
+		}
+	}
+
+	public function getApiData() {
+		return $this->apiData;
+	}
+
+	public function setApiData( array $data ) {
+		$this->apiData = $data;
+	}
+
+	public function serialize() {
+		return serialize( [
+			'parent' => parent::serialize(),
+			'apiCode' => $this->apiCode,
+			'apiData' => $this->apiData,
+		] );
+	}
+
+	public function unserialize( $serialized ) {
+		$data = unserialize( $serialized );
+		parent::unserialize( $data['parent'] );
+		$this->apiCode = $data['apiCode'];
+		$this->apiData = $data['apiData'];
+	}
+}
diff --git a/includes/api/ApiRawMessage.php b/includes/api/ApiRawMessage.php
new file mode 100644
index 0000000000..ed3537a2b6
--- /dev/null
+++ b/includes/api/ApiRawMessage.php
@@ -0,0 +1,52 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Extension of RawMessage implementing IApiMessage
+ * @since 1.25
+ * @ingroup API
+ */
+class ApiRawMessage extends RawMessage implements IApiMessage {
+	use ApiMessageTrait;
+
+	/**
+	 * @param RawMessage|string|array $msg
+	 *  - RawMessage: is cloned
+	 *  - array: first element is $key, rest are $params to RawMessage::__construct
+	 *  - string: passed to RawMessage::__construct
+	 * @param string|null $code
+	 * @param array|null $data
+	 */
+	public function __construct( $msg, $code = null, array $data = null ) {
+		if ( $msg instanceof RawMessage ) {
+			foreach ( get_class_vars( get_class( $this ) ) as $key => $value ) {
+				if ( isset( $msg->$key ) ) {
+					$this->$key = $msg->$key;
+				}
+			}
+		} elseif ( is_array( $msg ) ) {
+			$key = array_shift( $msg );
+			parent::__construct( $key, $msg );
+		} else {
+			parent::__construct( $msg );
+		}
+		$this->setApiCode( $code, $data );
+	}
+}
diff --git a/includes/api/IApiMessage.php b/includes/api/IApiMessage.php
new file mode 100644
index 0000000000..fee62c5acb
--- /dev/null
+++ b/includes/api/IApiMessage.php
@@ -0,0 +1,69 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Interface for messages with machine-readable data for use by the API
+ *
+ * The idea is that it's a Message that has some extra data for the API to use when interpreting it
+ * as an error (or, in the future, as a warning). Internals of MediaWiki often use messages (or
+ * message keys, or Status objects containing messages) to pass information about errors to the user
+ * (see e.g. Title::getUserPermissionsErrors()) and the API has to make do with that.
+ *
+ * @since 1.25
+ * @note This interface exists to work around PHP's inheritance, so ApiMessage
+ *  can extend Message and ApiRawMessage can extend RawMessage while still
+ *  allowing an instanceof check for a Message object including this
+ *  functionality. If for some reason you feel the need to implement this
+ *  interface on some other class, that class must also implement all the
+ *  public methods the Message class provides (not just those from
+ *  MessageSpecifier, which as written is fairly useless).
+ * @ingroup API
+ */
+interface IApiMessage extends MessageSpecifier {
+	/**
+	 * Returns a machine-readable code for use by the API
+	 *
+	 * If no code was specifically set, the message key is used as the code
+	 * after removing "apiwarn-" or "apierror-" prefixes and applying
+	 * backwards-compatibility mappings.
+	 *
+	 * @return string
+	 */
+	public function getApiCode();
+
+	/**
+	 * Returns additional machine-readable data about the error condition
+	 * @return array
+	 */
+	public function getApiData();
+
+	/**
+	 * Sets the machine-readable code for use by the API
+	 * @param string|null $code If null, uses the default (see self::getApiCode())
+	 * @param array|null $data If non-null, passed to self::setApiData()
+	 */
+	public function setApiCode( $code, array $data = null );
+
+	/**
+	 * Sets additional machine-readable data about the error condition
+	 * @param array $data
+	 */
+	public function setApiData( array $data );
+}
-- 
2.20.1