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
|
<?php
namespace MediaWiki\HTMLForm\Field;
use MediaWiki\HTMLForm\HTMLFormField;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Request\WebRequest;
use MWRestrictions;
/**
* Class for updating an MWRestrictions value (which is, currently, basically just an IP address
* list).
*
* Will be represented as a textarea with one address per line, with intelligent defaults for
* label, help text and row count.
*
* The value returned will be an MWRestrictions or the input string if it was not a list of
* valid IP ranges.
*
*/
class HTMLRestrictionsField extends HTMLFormField {
protected const DEFAULT_ROWS = 5;
private HTMLTextAreaField $ipField;
private HTMLTagMultiselectField $pagesField;
/**
* @stable to call
* @inheritDoc
*/
public function __construct( array $params ) {
parent::__construct( $params );
$this->ipField = new HTMLTextAreaField( [
'parent' => $params['parent'],
'fieldname' => $params['fieldname'] . '-ip',
'rows' => self::DEFAULT_ROWS,
'required' => $params['required'] ?? false,
'help-message' => 'restrictionsfield-help',
'label-message' => 'restrictionsfield-label',
] );
// Cannot really use a TitlesMultiselect field as the pages could be
// on other wikis!
$this->pagesField = new HTMLTagMultiselectField( [
'parent' => $params['parent'],
'fieldname' => $params['fieldname'] . '-pages',
'label-message' => 'restrictionsfields-pages-label',
'help-message' => 'restrictionsfields-pages-help',
'allowArbitrary' => true,
'required' => false,
'max' => 25,
] );
}
/**
* @param WebRequest $request
* @return MWRestrictions Restrictions object
*/
public function loadDataFromRequest( $request ) {
if ( !$request->getCheck( $this->mName . '-ip' ) ) {
return $this->getDefault();
}
$ipValue = rtrim( $request->getText( $this->mName . '-ip' ), "\r\n" );
$ips = $ipValue === '' ? [] : explode( "\n", $ipValue );
$pagesValue = $request->getText( $this->mName . '-pages' );
$pageList = $pagesValue ? explode( "\n", $pagesValue ) : [];
return MWRestrictions::newFromArray( [ 'IPAddresses' => $ips, 'Pages' => $pageList ] );
}
/**
* @return MWRestrictions
*/
public function getDefault() {
return parent::getDefault() ?? MWRestrictions::newDefault();
}
/**
* @param MWRestrictions $value The value the field was submitted with
* @param array $alldata The data collected from the form
*
* @return bool|string|Message True on success, or String/Message error to display, or
* false to fail validation without displaying an error.
*/
public function validate( $value, $alldata ) {
if ( $this->isHidden( $alldata ) ) {
return true;
}
if (
isset( $this->mParams['required'] ) && $this->mParams['required'] !== false
&& !$value->toArray()['IPAddresses']
) {
return $this->msg( 'htmlform-required' );
}
if ( !$value->validity->isGood() ) {
$statusFormatter = MediaWikiServices::getInstance()->getFormatterFactory()->getStatusFormatter(
$this->mParent->getContext()
);
return $statusFormatter->getMessage( $value->validity );
}
if ( isset( $this->mValidationCallback ) ) {
return call_user_func( $this->mValidationCallback, $value, $alldata, $this->mParent );
}
return true;
}
/**
* @param MWRestrictions $value
* @return string
*/
public function getInputHTML( $value ) {
$ipValue = implode( "\n", $value->toArray()['IPAddresses'] );
$pagesValue = implode( "\n", $value->toArray()['Pages'] ?? [] );
return (
$this->ipField->getDiv( $ipValue ) .
$this->pagesField->getDiv( $pagesValue )
);
}
/**
* @param MWRestrictions $value
* @return string
* @suppress PhanParamSignatureMismatch
*/
public function getInputOOUI( $value ) {
$ipValue = implode( "\n", $value->toArray()['IPAddresses'] );
$pagesValue = implode( "\n", $value->toArray()['Pages'] ?? [] );
return (
$this->ipField->getOOUI( $ipValue ) .
$this->pagesField->getOOUI( $pagesValue )
);
}
}
/** @deprecated class alias since 1.42 */
class_alias( HTMLRestrictionsField::class, 'HTMLRestrictionsField' );
|
