1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
<?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
*/
namespace MediaWiki\Api;
use InvalidArgumentException;
/**
* Trait to implement the IApiMessage interface for Message subclasses
* @since 1.27
* @ingroup API
* @phan-file-suppress PhanTraitParentReference
* @phan-file-suppress PhanUndeclaredMethod
*/
trait ApiMessageTrait {
/**
* Compatibility code mappings for various MW messages.
* @todo Ideally anything relying on this should be changed to use ApiMessage.
* @var string[]
*/
protected static $messageMap = [
'actionthrottledtext' => 'ratelimited',
'autoblockedtext' => 'autoblocked',
'autoblockedtext-tempuser' => 'autoblocked',
'badaccess-group0' => 'permissiondenied',
'badaccess-groups' => 'permissiondenied',
'badipaddress' => 'invalidip',
'blankpage' => 'emptypage',
'blockedtext' => 'blocked',
'blockedtext-composite' => 'blocked',
'blockedtext-partial' => 'blocked',
'blockedtext-tempuser' => '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-block-not-found' => 'alreadyblocked',
'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',
];
/** @var string|null */
protected $apiCode = null;
/** @var array */
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 ( str_starts_with( $key, 'apiwarn-' ) ) {
$this->apiCode = substr( $key, 8 );
} elseif ( str_starts_with( $key, 'apierror-' ) ) {
$this->apiCode = substr( $key, 9 );
} else {
$this->apiCode = $key;
}
// Ensure the code is actually valid
$this->apiCode = preg_replace( '/[^a-zA-Z0-9_-]/', '_', $this->apiCode );
}
return $this->apiCode;
}
public function setApiCode( $code, ?array $data = null ) {
if ( $code !== null && !ApiErrorFormatter::isValidApiCode( $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 [
'parent' => parent::__serialize(),
'apiCode' => $this->apiCode,
'apiData' => $this->apiData,
];
}
public function __unserialize( $data ) {
parent::__unserialize( $data['parent'] );
$this->apiCode = $data['apiCode'];
$this->apiData = $data['apiData'];
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiMessageTrait::class, 'ApiMessageTrait' );
|
