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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
<?php
namespace MediaWiki\Extension\AbuseFilter\EditBox;
use MediaWiki\Extension\AbuseFilter\AbuseFilterPermissionManager;
use MediaWiki\Extension\AbuseFilter\KeywordsManager;
use MediaWiki\Html\Html;
use MediaWiki\Output\OutputPage;
use MediaWiki\Permissions\Authority;
use MessageLocalizer;
use OOUI\ButtonWidget;
use OOUI\DropdownInputWidget;
use OOUI\FieldLayout;
use OOUI\FieldsetLayout;
use OOUI\Widget;
/**
* Base class for classes responsible for building filter edit boxes
*/
abstract class EditBoxBuilder {
/** @var AbuseFilterPermissionManager */
protected $afPermManager;
/** @var KeywordsManager */
protected $keywordsManager;
/** @var MessageLocalizer */
protected $localizer;
/** @var Authority */
protected $authority;
/** @var OutputPage */
protected $output;
/**
* @param AbuseFilterPermissionManager $afPermManager
* @param KeywordsManager $keywordsManager
* @param MessageLocalizer $messageLocalizer
* @param Authority $authority
* @param OutputPage $output
*/
public function __construct(
AbuseFilterPermissionManager $afPermManager,
KeywordsManager $keywordsManager,
MessageLocalizer $messageLocalizer,
Authority $authority,
OutputPage $output
) {
$this->afPermManager = $afPermManager;
$this->keywordsManager = $keywordsManager;
$this->localizer = $messageLocalizer;
$this->authority = $authority;
$this->output = $output;
}
/**
* @param string $rules
* @param bool $addResultDiv
* @param bool $externalForm
* @param bool $needsModifyRights
* @param-taint $rules none
* @return string
*/
public function buildEditBox(
string $rules,
bool $addResultDiv = true,
bool $externalForm = false,
bool $needsModifyRights = true
): string {
$this->output->addModules( 'ext.abuseFilter.edit' );
$this->output->enableOOUI();
$isUserAllowed = $needsModifyRights ?
$this->afPermManager->canEdit( $this->authority ) :
$this->afPermManager->canUseTestTools( $this->authority );
if ( !$isUserAllowed ) {
$addResultDiv = false;
}
$output = $this->getEditBox( $rules, $isUserAllowed, $externalForm );
if ( $isUserAllowed ) {
$dropdown = $this->getSuggestionsDropdown();
$formElements = [
new FieldLayout( $dropdown ),
new FieldLayout( $this->getEditorControls() )
];
$fieldSet = new FieldsetLayout( [
'items' => $formElements,
'classes' => [ 'mw-abusefilter-edit-buttons', 'mw-abusefilter-javascript-tools' ]
] );
$output .= $fieldSet;
}
if ( $addResultDiv ) {
$output .= Html::element(
'div',
[ 'id' => 'mw-abusefilter-syntaxresult', 'style' => 'display: none;' ]
);
}
return $output;
}
/**
* @return DropdownInputWidget
*/
private function getSuggestionsDropdown(): DropdownInputWidget {
$rawDropdown = $this->keywordsManager->getBuilderValues();
// The array needs to be rearranged to be understood by OOUI. It comes with the format
// [ group-msg-key => [ text-to-add => text-msg-key ] ] and we need it as
// [ group-msg => [ text-msg => text-to-add ] ]
// Also, the 'other' element must be the first one.
$dropdownOptions = [ $this->localizer->msg( 'abusefilter-edit-builder-select' )->text() => 'other' ];
foreach ( $rawDropdown as $group => $values ) {
// Give grep a chance to find the usages:
// abusefilter-edit-builder-group-op-arithmetic
// abusefilter-edit-builder-group-op-comparison
// abusefilter-edit-builder-group-op-bool
// abusefilter-edit-builder-group-misc
// abusefilter-edit-builder-group-funcs
// abusefilter-edit-builder-group-vars
$localisedGroup = $this->localizer->msg( "abusefilter-edit-builder-group-$group" )->text();
$dropdownOptions[ $localisedGroup ] = array_flip( $values );
$newKeys = array_map(
function ( $key ) use ( $group, $dropdownOptions, $localisedGroup ) {
// Force all operators and functions to be always shown as left to right text
// with the help of control characters:
// * 202A is LEFT-TO-RIGHT EMBEDDING (LRE)
// * 202C is POP DIRECTIONAL FORMATTING (PDF)
// This has to be done with control characters because
// markup cannot be used within <option> elements.
$operatorExample = "\u{202A}" .
$dropdownOptions[ $localisedGroup ][ $key ] .
"\u{202C}";
return $this->localizer->msg(
"abusefilter-edit-builder-$group-$key",
$operatorExample
)->text();
},
array_keys( $dropdownOptions[ $localisedGroup ] )
);
$dropdownOptions[ $localisedGroup ] = array_combine(
$newKeys,
$dropdownOptions[ $localisedGroup ]
);
}
$dropdownList = Html::listDropdownOptionsOoui( $dropdownOptions );
return new DropdownInputWidget( [
'name' => 'wpFilterBuilder',
'inputId' => 'wpFilterBuilder',
'options' => $dropdownList
] );
}
/**
* Get an additional widget that "controls" the editor, and is placed next to it
* Precondition: the user has full rights.
*
* @return Widget
*/
protected function getEditorControls(): Widget {
return new ButtonWidget(
[
'label' => $this->localizer->msg( 'abusefilter-edit-check' )->text(),
'id' => 'mw-abusefilter-syntaxcheck'
]
);
}
/**
* Generate the HTML for the actual edit box
*
* @param string $rules
* @param bool $isUserAllowed
* @param bool $externalForm
* @return string
*/
abstract protected function getEditBox( string $rules, bool $isUserAllowed, bool $externalForm ): string;
}
|
