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
165
166
167
168
169
170
171
|
<?php
namespace MediaWiki\HTMLForm\Field;
use MediaWiki\MediaWikiServices;
use MediaWiki\User\UserRigorOptions;
use MediaWiki\Widget\UsersMultiselectWidget;
use Wikimedia\IPUtils;
/**
* Implements a tag multiselect input field for user names.
*
* Besides the parameters recognized by HTMLUserTextField, additional recognized
* parameters are:
* default - (optional) String, newline-separated list of usernames to use as preset data
* placeholder - (optional) Custom placeholder message for input
*
* The result is the array of usernames
*
* @stable to extend
* @note This widget is not likely to remain functional in non-OOUI forms.
*/
class HTMLUsersMultiselectField extends HTMLUserTextField {
public function loadDataFromRequest( $request ) {
$value = $request->getText( $this->mName, $this->getDefault() ?? '' );
$usersArray = explode( "\n", $value );
// Remove empty lines
$usersArray = array_values( array_filter( $usersArray, static function ( $username ) {
return trim( $username ) !== '';
} ) );
// Normalize usernames
$normalizedUsers = [];
$userNameUtils = MediaWikiServices::getInstance()->getUserNameUtils();
$listOfIps = [];
foreach ( $usersArray as $user ) {
$canonicalUser = false;
if ( IPUtils::isIPAddress( $user ) ) {
$parsedIPRange = IPUtils::parseRange( $user );
if ( !in_array( $parsedIPRange, $listOfIps ) ) {
$canonicalUser = IPUtils::sanitizeRange( $user );
$listOfIps[] = $parsedIPRange;
}
} else {
$canonicalUser = $userNameUtils->getCanonical(
$user, UserRigorOptions::RIGOR_NONE );
}
if ( $canonicalUser !== false ) {
$normalizedUsers[] = $canonicalUser;
}
}
// Remove any duplicate usernames
$uniqueUsers = array_unique( $normalizedUsers );
// This function is expected to return a string
return implode( "\n", $uniqueUsers );
}
public function validate( $value, $alldata ) {
if ( !$this->mParams['exists'] ) {
return true;
}
if ( $value === null ) {
return false;
}
// $value is a string, because HTMLForm fields store their values as strings
$usersArray = explode( "\n", $value );
if ( isset( $this->mParams['max'] ) && ( count( $usersArray ) > $this->mParams['max'] ) ) {
return $this->msg( 'htmlform-multiselect-toomany', $this->mParams['max'] );
}
foreach ( $usersArray as $username ) {
$result = parent::validate( $username, $alldata );
if ( $result !== true ) {
return $result;
}
}
return true;
}
public function getInputHTML( $value ) {
$this->mParent->getOutput()->enableOOUI();
return $this->getInputOOUI( $value );
}
public function getInputOOUI( $value ) {
$this->mParent->getOutput()->addModuleStyles( 'mediawiki.widgets.TagMultiselectWidget.styles' );
$params = [ 'name' => $this->mName ];
if ( isset( $this->mParams['id'] ) ) {
$params['id'] = $this->mParams['id'];
}
if ( isset( $this->mParams['disabled'] ) ) {
$params['disabled'] = $this->mParams['disabled'];
}
if ( isset( $this->mParams['default'] ) ) {
$params['default'] = $this->mParams['default'];
}
$params['placeholder'] = $this->mParams['placeholder'] ??
$this->msg( 'mw-widgets-usersmultiselect-placeholder' )->plain();
if ( isset( $this->mParams['max'] ) ) {
$params['tagLimit'] = $this->mParams['max'];
}
if ( isset( $this->mParams['ipallowed'] ) ) {
$params['ipAllowed'] = $this->mParams['ipallowed'];
}
if ( isset( $this->mParams['iprange'] ) ) {
$params['ipRangeAllowed'] = $this->mParams['iprange'];
}
if ( isset( $this->mParams['iprangelimits'] ) ) {
$params['ipRangeLimits'] = $this->mParams['iprangelimits'];
}
if ( isset( $this->mParams['excludenamed'] ) ) {
$params['excludeNamed'] = $this->mParams['excludenamed'];
}
if ( isset( $this->mParams['excludetemp'] ) ) {
$params['excludeTemp'] = $this->mParams['excludetemp'];
}
if ( isset( $this->mParams['input'] ) ) {
$params['input'] = $this->mParams['input'];
}
if ( $value !== null ) {
// $value is a string, but the widget expects an array
$params['default'] = $value === '' ? [] : explode( "\n", $value );
}
// Make the field auto-infusable when it's used inside a legacy HTMLForm rather than OOUIHTMLForm
$params['infusable'] = true;
$params['classes'] = [ 'mw-htmlform-autoinfuse' ];
return $this->getInputWidget( $params );
}
/**
* @inheritDoc
*/
protected function getInputWidget( $params ) {
$widget = new UsersMultiselectWidget( $params );
$widget->setAttributes( [ 'data-mw-modules' => implode( ',', $this->getOOUIModules() ) ] );
return $widget;
}
protected function shouldInfuseOOUI() {
return true;
}
protected function getOOUIModules() {
return [ 'mediawiki.widgets.UsersMultiselectWidget' ];
}
}
/** @deprecated class alias since 1.42 */
class_alias( HTMLUsersMultiselectField::class, 'HTMLUsersMultiselectField' );
|
