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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Benchmark
*/
use MediaWiki\MainConfigNames;
use MediaWiki\Parser\Sanitizer;
// @codeCoverageIgnoreStart
require_once __DIR__ . '/../includes/Benchmarker.php';
// @codeCoverageIgnoreEnd
/**
* Maintenance script that benchmarks Sanitizer methods.
*
* @ingroup Benchmark
*/
class BenchmarkSanitizer extends Benchmarker {
public function __construct() {
parent::__construct();
$this->addDescription( 'Benchmark for Sanitizer methods.' );
$this->addOption( 'method', 'One of "validateEmail", "encodeAttribute", '
. '"safeEncodeAttribute", "internalRemoveHtmlTags", "removeSomeTags", "tidy", or "stripAllTags". '
. 'Default: (All)', false, true );
}
public function execute() {
# text with no html simulates an interface message string or a title
$textWithNoHtml = 'This could be an article title';
$textWithHtmlSm = 'Before <wrap><in>and</in> another <unclose> <in>word</in></wrap>.';
$textWithHtmlLg = str_repeat(
// 28K (28 chars * 1000)
wfRandomString( 3 ) . ' <tag>' . wfRandomString( 5 ) . '</tag> ' . wfRandomString( 7 ),
1000
);
$method = $this->getOption( 'method' );
$benches = [];
if ( !$method || $method === 'validateEmail' ) {
$benches['Sanitizer::validateEmail (valid)'] = static function () {
Sanitizer::validateEmail( 'user@example.org' );
};
$benches['Sanitizer::validateEmail (invalid)'] = static function () {
Sanitizer::validateEmail( 'username@example! org' );
};
}
if ( !$method || $method === 'encodeAttribute' ) {
$benches['Sanitizer::encodeAttribute (simple)'] = static function () {
Sanitizer::encodeAttribute( 'simple' );
};
$benches['Sanitizer::encodeAttribute (special)'] = static function () {
Sanitizer::encodeAttribute( ":'\"\n https://example" );
};
}
if ( !$method || $method === 'safeEncodeAttribute' ) {
$benches['Sanitizer::safeEncodeAttribute (simple)'] = static function () {
Sanitizer::safeEncodeAttribute( 'simple' );
};
$benches['Sanitizer::safeEncodeAttribute (special)'] = static function () {
Sanitizer::safeEncodeAttribute( ":'\"\n https://example" );
};
}
if ( !$method || $method === 'internalRemoveHtmlTags' ) {
$tiny = strlen( $textWithNoHtml );
$sm = strlen( $textWithHtmlSm );
$lg = round( strlen( $textWithHtmlLg ) / 1000 ) . 'K';
$benches["Sanitizer::internalRemoveHtmlTags (input: $tiny)"] = static function () use ( $textWithNoHtml ) {
Sanitizer::internalRemoveHtmlTags( $textWithNoHtml );
};
$benches["Sanitizer::internalRemoveHtmlTags (input: $sm)"] = static function () use ( $textWithHtmlSm ) {
Sanitizer::internalRemoveHtmlTags( $textWithHtmlSm );
};
$benches["Sanitizer::internalRemoveHtmlTags (input: $lg)"] = static function () use ( $textWithHtmlLg ) {
Sanitizer::internalRemoveHtmlTags( $textWithHtmlLg );
};
}
if ( !$method || $method === 'tidy' ) {
# This matches what DISPLAYTITLE was previously doing to sanitize
# title strings
$tiny = strlen( $textWithNoHtml );
$sm = strlen( $textWithHtmlSm );
$lg = round( strlen( $textWithHtmlLg ) / 1000 ) . 'K';
$doit = static function ( $text ) {
return static function () use ( $text ) {
$tidy = new \MediaWiki\Tidy\RemexDriver(
new \MediaWiki\Config\ServiceOptions( [ MainConfigNames::TidyConfig ], [
MainConfigNames::TidyConfig => [ 'pwrap' => false ],
] ) );
$textWithTags = $tidy->tidy( $text, [ Sanitizer::class, 'armorFrenchSpaces' ] );
$textWithTags = Sanitizer::normalizeCharReferences(
Sanitizer::internalRemoveHtmlTags( $textWithTags )
);
};
};
$benches["DISPLAYTITLE tidy (input: $tiny)"] = $doit( $textWithNoHtml );
$benches["DISPLAYTITLE tidy (input: $sm)"] = $doit( $textWithHtmlSm );
$benches["DISPLAYTITLE tidy (input: $lg)"] = $doit( $textWithHtmlLg );
}
if ( !$method || $method === 'removeSomeTags' ) {
$tiny = strlen( $textWithNoHtml );
$sm = strlen( $textWithHtmlSm );
$lg = round( strlen( $textWithHtmlLg ) / 1000 ) . 'K';
$benches["Sanitizer::removeSomeTags (input: $tiny)"] = static function () use ( $textWithNoHtml ) {
Sanitizer::removeSomeTags( $textWithNoHtml );
};
$benches["Sanitizer::removeSomeTags (input: $sm)"] = static function () use ( $textWithHtmlSm ) {
Sanitizer::removeSomeTags( $textWithHtmlSm );
};
$benches["Sanitizer::removeSomeTags (input: $lg)"] = static function () use ( $textWithHtmlLg ) {
Sanitizer::removeSomeTags( $textWithHtmlLg );
};
}
if ( !$method || $method === 'stripAllTags' ) {
$sm = strlen( $textWithHtmlSm );
$lg = round( strlen( $textWithHtmlLg ) / 1000 ) . 'K';
$benches["Sanitizer::stripAllTags (input: $sm)"] = static function () use ( $textWithHtmlSm ) {
Sanitizer::stripAllTags( $textWithHtmlSm );
};
$benches["Sanitizer::stripAllTags (input: $lg)"] = static function () use ( $textWithHtmlLg ) {
Sanitizer::stripAllTags( $textWithHtmlLg );
};
}
$this->bench( $benches );
}
}
// @codeCoverageIgnoreStart
$maintClass = BenchmarkSanitizer::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd
|
