* (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
*
- * The message key is often sufficient, but sometimes there are multiple
- * messages used for what is really the same underlying condition (e.g.
- * badaccess-groups and badaccess-group0)
+ * 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();
/**
* Sets the machine-readable code for use by the API
- * @param string|null $code If null, the message key should be returned by self::getApiCode()
+ * @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 );
* @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() {
- return $this->apiCode === null ? $this->getKey() : $this->apiCode;
+ 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 );
* @param Message|RawMessage|array|string $msg
* @param string|null $code
* @param array|null $data
- * @return ApiMessage
+ * @return IApiMessage
*/
public static function create( $msg, $code = null, array $data = null ) {
+ if ( is_array( $msg ) ) {
+ // From StatusValue
+ if ( isset( $msg['message'] ) ) {
+ if ( isset( $msg['params'] ) ) {
+ $msg = array_merge( [ $msg['message'] ], $msg['params'] );
+ } else {
+ $msg = [ $msg['message'] ];
+ }
+ }
+
+ // Weirdness that comes in sometimes, including the above
+ if ( $msg[0] instanceof MessageSpecifier ) {
+ $msg = $msg[0];
+ }
+ }
+
if ( $msg instanceof IApiMessage ) {
return $msg;
} elseif ( $msg instanceof RawMessage ) {
* - string: passed to Message::__construct
* @param string|null $code
* @param array|null $data
- * @return ApiMessage
*/
public function __construct( $msg, $code = null, array $data = null ) {
if ( $msg instanceof Message ) {
} else {
parent::__construct( $msg );
}
- $this->apiCode = $code;
- $this->apiData = (array)$data;
+ $this->setApiCode( $code, $data );
}
}
} else {
parent::__construct( $msg );
}
- $this->apiCode = $code;
- $this->apiData = (array)$data;
+ $this->setApiCode( $code, $data );
}
}
dépôts / lhc / web / wiklou.git / blobdiff