MediaWiki master
UserDef.php
Go to the documentation of this file.
1<?php
2
4
13use Wikimedia\IPUtils;
18
27class UserDef extends TypeDef {
28
46 public const PARAM_ALLOWED_USER_TYPES = 'param-allowed-user-types';
47
57 public const PARAM_RETURN_OBJECT = 'param-return-object';
58
60 private $userIdentityLookup;
61
63 private $titleParser;
64
66 private $userNameUtils;
67
74 public function __construct(
76 UserIdentityLookup $userIdentityLookup,
77 TitleParser $titleParser,
78 UserNameUtils $userNameUtils
79 ) {
80 parent::__construct( $callbacks );
81 $this->userIdentityLookup = $userIdentityLookup;
82 $this->titleParser = $titleParser;
83 $this->userNameUtils = $userNameUtils;
84 }
85
86 public function validate( $name, $value, array $settings, array $options ) {
87 [ $type, $user ] = $this->processUser( $value );
88
89 if ( !$user || !in_array( $type, $settings[self::PARAM_ALLOWED_USER_TYPES], true ) ) {
90 // Message used: paramvalidator-baduser
91 $this->failure( 'baduser', $name, $value, $settings, $options );
92 }
93
94 return empty( $settings[self::PARAM_RETURN_OBJECT] ) ? $user->getName() : $user;
95 }
96
97 public function normalizeSettings( array $settings ) {
98 if ( isset( $settings[self::PARAM_ALLOWED_USER_TYPES] ) ) {
99 $settings[self::PARAM_ALLOWED_USER_TYPES] = array_values( array_intersect(
100 [ 'name', 'ip', 'temp', 'cidr', 'interwiki', 'id' ],
101 $settings[self::PARAM_ALLOWED_USER_TYPES]
102 ) );
103 }
104 if ( empty( $settings[self::PARAM_ALLOWED_USER_TYPES] ) ) {
105 $settings[self::PARAM_ALLOWED_USER_TYPES] = [ 'name', 'ip', 'temp', 'cidr', 'interwiki' ];
106 }
107
108 return parent::normalizeSettings( $settings );
109 }
110
111 public function checkSettings( string $name, $settings, array $options, array $ret ): array {
112 $ret = parent::checkSettings( $name, $settings, $options, $ret );
113
114 $ret['allowedKeys'] = array_merge( $ret['allowedKeys'], [
115 self::PARAM_ALLOWED_USER_TYPES, self::PARAM_RETURN_OBJECT,
116 ] );
117
118 if ( !is_bool( $settings[self::PARAM_RETURN_OBJECT] ?? false ) ) {
119 $ret['issues'][self::PARAM_RETURN_OBJECT] = 'PARAM_RETURN_OBJECT must be boolean, got '
120 . gettype( $settings[self::PARAM_RETURN_OBJECT] );
121 }
122
123 $hasId = false;
124 if ( isset( $settings[self::PARAM_ALLOWED_USER_TYPES] ) ) {
125 if ( !is_array( $settings[self::PARAM_ALLOWED_USER_TYPES] ) ) {
126 $ret['issues'][self::PARAM_ALLOWED_USER_TYPES] = 'PARAM_ALLOWED_USER_TYPES must be an array, '
127 . 'got ' . gettype( $settings[self::PARAM_ALLOWED_USER_TYPES] );
128 } elseif ( $settings[self::PARAM_ALLOWED_USER_TYPES] === [] ) {
129 $ret['issues'][self::PARAM_ALLOWED_USER_TYPES] = 'PARAM_ALLOWED_USER_TYPES cannot be empty';
130 } else {
131 $bad = array_diff(
132 $settings[self::PARAM_ALLOWED_USER_TYPES],
133 [ 'name', 'ip', 'temp', 'cidr', 'interwiki', 'id' ]
134 );
135 if ( $bad ) {
136 $ret['issues'][self::PARAM_ALLOWED_USER_TYPES] =
137 'PARAM_ALLOWED_USER_TYPES contains invalid values: ' . implode( ', ', $bad );
138 }
139
140 $hasId = in_array( 'id', $settings[self::PARAM_ALLOWED_USER_TYPES], true );
141 }
142 }
143
144 if ( !empty( $settings[ParamValidator::PARAM_ISMULTI] ) &&
145 ( $hasId || !empty( $settings[self::PARAM_RETURN_OBJECT] ) ) &&
146 (
147 ( $settings[ParamValidator::PARAM_ISMULTI_LIMIT1] ?? 100 ) > 10 ||
148 ( $settings[ParamValidator::PARAM_ISMULTI_LIMIT2] ?? 100 ) > 10
149 )
150 ) {
151 $ret['issues'][] = 'Multi-valued user-type parameters with PARAM_RETURN_OBJECT or allowing IDs '
152 . 'should set low values (<= 10) for PARAM_ISMULTI_LIMIT1 and PARAM_ISMULTI_LIMIT2.'
153 . ' (Note that "<= 10" is arbitrary. If something hits this, we can investigate a real limit '
154 . 'once we have a real use case to look at.)';
155 }
156
157 return $ret;
158 }
159
166 private function processUser( string $value ): array {
167 // A user ID?
168 if ( preg_match( '/^#(\d+)$/D', $value, $m ) ) {
169 // This used to use the IP address of the current request if the
170 // id was 0, to match the behavior of User objects, but was switched
171 // to "Unknown user" because the former behavior is likely unexpected.
172 // If the id corresponds to a user in the database, use that user, otherwise
173 // return a UserIdentityValue with id 0 (regardless of the input id) and
174 // the name "Unknown user"
175 $userId = (int)$m[1];
176 if ( $userId !== 0 ) {
177 // Check the database.
178 $userIdentity = $this->userIdentityLookup->getUserIdentityByUserId( $userId );
179 if ( $userIdentity ) {
180 return [ 'id', $userIdentity ];
181 }
182 }
183 // Fall back to "Unknown user"
184 return [
185 'id',
186 new UserIdentityValue( 0, "Unknown user" )
187 ];
188 }
189
190 // An interwiki username?
191 if ( ExternalUserNames::isExternal( $value ) ) {
192 $name = $this->userNameUtils->getCanonical( $value, UserRigorOptions::RIGOR_NONE );
193 // UserIdentityValue has the username which includes the > separating the external
194 // wiki database and the actual name, but is created for the *local* wiki, like
195 // for User objects (local is the default, but we specify it anyway to show
196 // that its intentional even though the username is for a different wiki)
197 // NOTE: We deliberately use the raw $value instead of the canonical $name
198 // to avoid converting the first character of the interwiki prefix to uppercase
199 $user = $name !== false ? new UserIdentityValue( 0, $value, UserIdentityValue::LOCAL ) : null;
200 return [ 'interwiki', $user ];
201 }
202
203 // A temp user?
204 if ( $this->userNameUtils->isTemp( $value ) ) {
205 $userIdentity = $this->userIdentityLookup->getUserIdentityByName( $value );
206 return [ 'temp', $userIdentity ];
207 }
208
209 // A valid user name?
210 // Match behavior of UserFactory::newFromName with RIGOR_VALID and User::getId()
211 // we know that if there is a canonical form from UserNameUtils then this can't
212 // look like an IP, and since we checked for external user names above it isn't
213 // that either, so if this is a valid user name then we check the database for
214 // the id, and if there is no user with this name the id is 0
215 $canonicalName = $this->userNameUtils->getCanonical( $value, UserRigorOptions::RIGOR_VALID );
216 if ( $canonicalName !== false ) {
217 $userIdentity = $this->userIdentityLookup->getUserIdentityByName( $canonicalName );
218 if ( $userIdentity ) {
219 return [ 'name', $userIdentity ];
220 }
221 // Fall back to id 0
222 return [
223 'name',
224 new UserIdentityValue( 0, $canonicalName )
225 ];
226 }
227
228 // (T232672) Reproduce the normalization applied in UserNameUtils::getCanonical() when
229 // performing the checks below.
230 if ( strpos( $value, '#' ) !== false ) {
231 return [ '', null ];
232 }
233
234 try {
235 $t = $this->titleParser->parseTitle( $value );
236 } catch ( MalformedTitleException $_ ) {
237 $t = null;
238 }
239 if ( !$t || $t->getNamespace() !== NS_USER || $t->isExternal() ) { // likely
240 try {
241 $t = $this->titleParser->parseTitle( "User:$value" );
242 } catch ( MalformedTitleException $_ ) {
243 $t = null;
244 }
245 }
246 if ( !$t || $t->getNamespace() !== NS_USER || $t->isExternal() ) {
247 // If it wasn't a valid User-namespace title, fail.
248 return [ '', null ];
249 }
250 $value = $t->getText();
251
252 // An IP?
253 $b = IPUtils::RE_IP_BYTE;
254 if ( IPUtils::isValid( $value ) ||
255 // See comment for UserNameUtils::isIP. We don't just call that function
256 // here because it also returns true for things like
257 // 300.300.300.300 that are neither valid usernames nor valid IP
258 // addresses.
259 preg_match( "/^$b\.$b\.$b\.xxx$/D", $value )
260 ) {
261 $name = IPUtils::sanitizeIP( $value );
262 // We don't really need to use UserNameUtils::getCanonical() because for anonymous
263 // users the only validation is that there is no `#` (which is already the case if its
264 // a valid IP or matches the regex) and the only normalization is making the first
265 // character uppercase (doesn't matter for numbers) and replacing underscores with
266 // spaces (doesn't apply to IPs). But, better safe than sorry?
267 $name = $this->userNameUtils->getCanonical( $name, UserRigorOptions::RIGOR_NONE );
268 return [ 'ip', UserIdentityValue::newAnonymous( $name ) ];
269 }
270
271 // A range?
272 if ( IPUtils::isValidRange( $value ) ) {
273 $name = IPUtils::sanitizeIP( $value );
274 // Per above, the UserNameUtils call isn't strictly needed, but doesn't hurt
275 $name = $this->userNameUtils->getCanonical( $name, UserRigorOptions::RIGOR_NONE );
276 return [ 'cidr', UserIdentityValue::newAnonymous( $name ) ];
277 }
278
279 // Fail.
280 return [ '', null ];
281 }
282
283 public function getParamInfo( $name, array $settings, array $options ) {
284 $info = parent::getParamInfo( $name, $settings, $options );
285
286 $info['subtypes'] = $settings[self::PARAM_ALLOWED_USER_TYPES];
287
288 return $info;
289 }
290
291 public function getHelpInfo( $name, array $settings, array $options ) {
292 $info = parent::getParamInfo( $name, $settings, $options );
293
294 $isMulti = !empty( $settings[ParamValidator::PARAM_ISMULTI] );
295
296 $subtypes = [];
297 foreach ( $settings[self::PARAM_ALLOWED_USER_TYPES] as $st ) {
298 // Messages: paramvalidator-help-type-user-subtype-name,
299 // paramvalidator-help-type-user-subtype-ip, paramvalidator-help-type-user-subtype-cidr,
300 // paramvalidator-help-type-user-subtype-interwiki, paramvalidator-help-type-user-subtype-id,
301 // paramvalidator-help-type-user-subtype-temp
302 $subtypes[] = MessageValue::new( "paramvalidator-help-type-user-subtype-$st" );
303 }
304 $info[ParamValidator::PARAM_TYPE] = MessageValue::new( 'paramvalidator-help-type-user' )
305 ->params( $isMulti ? 2 : 1 )
306 ->textListParams( $subtypes )
307 ->numParams( count( $subtypes ) );
308
309 return $info;
310 }
311
312}
const NS_USER
Definition Defines.php:66
if(!defined('MW_SETUP_CALLBACK'))
Definition WebStart.php:81
Type definition for user types.
Definition UserDef.php:27
const PARAM_RETURN_OBJECT
(bool) Whether to return a UserIdentity object.
Definition UserDef.php:57
checkSettings(string $name, $settings, array $options, array $ret)
Validate a parameter settings array.
Definition UserDef.php:111
validate( $name, $value, array $settings, array $options)
Validate the value.
Definition UserDef.php:86
getHelpInfo( $name, array $settings, array $options)
Describe parameter settings in human-readable format.
Definition UserDef.php:291
__construct(Callbacks $callbacks, UserIdentityLookup $userIdentityLookup, TitleParser $titleParser, UserNameUtils $userNameUtils)
Definition UserDef.php:74
normalizeSettings(array $settings)
Normalize a settings array.
Definition UserDef.php:97
const PARAM_ALLOWED_USER_TYPES
(string[]) Allowed types of user.
Definition UserDef.php:46
getParamInfo( $name, array $settings, array $options)
Describe parameter settings in a machine-readable format.
Definition UserDef.php:283
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
Class to parse and build external user names.
Value object representing a user's identity.
UserNameUtils service.
Value object representing a message for i18n.
Service for formatting and validating API parameters.
Base definition for ParamValidator types.
Definition TypeDef.php:19
failure( $failure, $name, $value, array $settings, array $options, $fatal=true)
Record a failure message.
Definition TypeDef.php:49
A title parser service for MediaWiki.
Interface for objects representing user identity.
Shared interface for rigor levels when dealing with User methods.
Interface defining callbacks needed by ParamValidator.
Definition Callbacks.php:21