11 use Wikimedia\IPUtils;
83 public function validate( $name, $value, array $settings, array $options ) {
86 if ( !$user || !in_array(
$type, $settings[self::PARAM_ALLOWED_USER_TYPES],
true ) ) {
87 $this->
failure(
'baduser', $name, $value, $settings, $options );
90 return empty( $settings[self::PARAM_RETURN_OBJECT] ) ? $user->getName() : $user;
94 if ( isset( $settings[self::PARAM_ALLOWED_USER_TYPES] ) ) {
96 [
'name',
'ip',
'cidr',
'interwiki',
'id' ],
97 $settings[self::PARAM_ALLOWED_USER_TYPES]
100 if ( empty( $settings[self::PARAM_ALLOWED_USER_TYPES] ) ) {
104 return parent::normalizeSettings( $settings );
107 public function checkSettings(
string $name, $settings, array $options, array $ret ) : array {
108 $ret = parent::checkSettings( $name, $settings, $options, $ret );
110 $ret[
'allowedKeys'] = array_merge( $ret[
'allowedKeys'], [
111 self::PARAM_ALLOWED_USER_TYPES, self::PARAM_RETURN_OBJECT,
114 if ( !is_bool( $settings[self::PARAM_RETURN_OBJECT] ??
false ) ) {
116 . gettype( $settings[self::PARAM_RETURN_OBJECT] );
120 if ( isset( $settings[self::PARAM_ALLOWED_USER_TYPES] ) ) {
121 if ( !is_array( $settings[self::PARAM_ALLOWED_USER_TYPES] ) ) {
123 .
'got ' . gettype( $settings[self::PARAM_ALLOWED_USER_TYPES] );
124 } elseif ( $settings[self::PARAM_ALLOWED_USER_TYPES] === [] ) {
128 $settings[self::PARAM_ALLOWED_USER_TYPES],
129 [
'name',
'ip',
'cidr',
'interwiki',
'id' ]
133 'PARAM_ALLOWED_USER_TYPES contains invalid values: ' . implode(
', ', $bad );
136 $hasId = in_array(
'id', $settings[self::PARAM_ALLOWED_USER_TYPES],
true );
141 ( $hasId || !empty( $settings[self::PARAM_RETURN_OBJECT] ) ) &&
147 $ret[
'issues'][] =
'Multi-valued user-type parameters with PARAM_RETURN_OBJECT or allowing IDs '
148 .
'should set low values (<= 10) for PARAM_ISMULTI_LIMIT1 and PARAM_ISMULTI_LIMIT2.'
149 .
' (Note that "<= 10" is arbitrary. If something hits this, we can investigate a real limit '
150 .
'once we have a real use case to look at.)';
164 if ( preg_match(
'/^#(\d+)$/D', $value, $m ) ) {
165 return [
'id', $this->userFactory->newFromId( $m[1] ) ];
171 $name = $this->userNameUtils->getCanonical( $value, UserNameUtils::RIGOR_NONE );
174 is_string( $name ) ? $this->userFactory->newFromAnyId( 0, $value,
null ) : null
179 $user = $this->userFactory->newFromName( $value,
'valid' );
181 return [
'name', $user ];
186 if ( strpos( $value,
'#' ) !==
false ) {
190 $t = $this->titleFactory->newFromText( $value );
191 if ( !
$t ||
$t->getNamespace() !==
NS_USER ||
$t->isExternal() ) {
192 $t = $this->titleFactory->newFromText(
"User:$value" );
194 if ( !
$t ||
$t->getNamespace() !==
NS_USER ||
$t->isExternal() ) {
198 $value =
$t->getText();
202 if ( IPUtils::isValid( $value ) ||
207 preg_match(
"/^$b\.$b\.$b\.xxx$/D", $value )
209 return [
'ip', $this->userFactory->newAnonymous( IPUtils::sanitizeIP( $value ) ) ];
213 if ( IPUtils::isValidRange( $value ) ) {
214 return [
'cidr', $this->userFactory->newFromAnyId( 0, IPUtils::sanitizeIP( $value ),
null ) ];
221 public function getParamInfo( $name, array $settings, array $options ) {
222 $info = parent::getParamInfo( $name, $settings, $options );
229 public function getHelpInfo( $name, array $settings, array $options ) {
230 $info = parent::getParamInfo( $name, $settings, $options );
235 foreach ( $settings[self::PARAM_ALLOWED_USER_TYPES] as $st ) {
242 ->params( $isMulti ? 2 : 1 )
243 ->textListParams( $subtypes )
244 ->numParams( count( $subtypes ) );