summaryrefslogtreecommitdiff
path: root/tests/phpunit/includes/HtmlTest.php
blob: 1c62d0324af4a8a7a4004eae9724d7811e51fb11 (plain)
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
<?php
/** tests for includes/Html.php */

class HtmlTest extends MediaWikiTestCase {

	protected function setUp() {
		parent::setUp();

		$langCode = 'en';
		$langObj = Language::factory( $langCode );

		// Hardcode namespaces during test runs,
		// so that html output based on existing namespaces
		// can be properly evaluated.
		$langObj->setNamespaces( array(
			-2 => 'Media',
			-1 => 'Special',
			0 => '',
			1 => 'Talk',
			2 => 'User',
			3 => 'User_talk',
			4 => 'MyWiki',
			5 => 'MyWiki_Talk',
			6 => 'File',
			7 => 'File_talk',
			8 => 'MediaWiki',
			9 => 'MediaWiki_talk',
			10 => 'Template',
			11 => 'Template_talk',
			14 => 'Category',
			15 => 'Category_talk',
			100 => 'Custom',
			101 => 'Custom_talk',
		) );

		$this->setMwGlobals( array(
			'wgLanguageCode' => $langCode,
			'wgContLang' => $langObj,
			'wgLang' => $langObj,
			'wgWellFormedXml' => false,
		) );
	}

	public function testElementBasics() {
		$this->assertEquals(
			'<img>',
			Html::element( 'img', null, '' ),
			'No close tag for short-tag elements'
		);

		$this->assertEquals(
			'<element></element>',
			Html::element( 'element', null, null ),
			'Close tag for empty element (null, null)'
		);

		$this->assertEquals(
			'<element></element>',
			Html::element( 'element', array(), '' ),
			'Close tag for empty element (array, string)'
		);

		$this->setMwGlobals( 'wgWellFormedXml', true );

		$this->assertEquals(
			'<img />',
			Html::element( 'img', null, '' ),
			'Self-closing tag for short-tag elements (wgWellFormedXml = true)'
		);
	}

	public function dataXmlMimeType() {
		return array(
			// ( $mimetype, $isXmlMimeType )
			# HTML is not an XML MimeType
			array( 'text/html', false ),
			# XML is an XML MimeType
			array( 'text/xml', true ),
			array( 'application/xml', true ),
			# XHTML is an XML MimeType
			array( 'application/xhtml+xml', true ),
			# Make sure other +xml MimeTypes are supported
			# SVG is another random MimeType even though we don't use it
			array( 'image/svg+xml', true ),
			# Complete random other MimeTypes are not XML
			array( 'text/plain', false ),
		);
	}

	/**
	 * @dataProvider dataXmlMimeType
	 */
	public function testXmlMimeType( $mimetype, $isXmlMimeType ) {
		$this->assertEquals( $isXmlMimeType, Html::isXmlMimeType( $mimetype ) );
	}

	public function testExpandAttributesSkipsNullAndFalse() {

		### EMPTY ########
		$this->assertEmpty(
			Html::expandAttributes( array( 'foo' => null ) ),
			'skip keys with null value'
		);
		$this->assertEmpty(
			Html::expandAttributes( array( 'foo' => false ) ),
			'skip keys with false value'
		);
		$this->assertNotEmpty(
			Html::expandAttributes( array( 'foo' => '' ) ),
			'keep keys with an empty string'
		);
	}

	public function testExpandAttributesForBooleans() {
		$this->assertEquals(
			'',
			Html::expandAttributes( array( 'selected' => false ) ),
			'Boolean attributes do not generates output when value is false'
		);
		$this->assertEquals(
			'',
			Html::expandAttributes( array( 'selected' => null ) ),
			'Boolean attributes do not generates output when value is null'
		);

		$this->assertEquals(
			' selected',
			Html::expandAttributes( array( 'selected' => true ) ),
			'Boolean attributes have no value when value is true'
		);
		$this->assertEquals(
			' selected',
			Html::expandAttributes( array( 'selected' ) ),
			'Boolean attributes have no value when value is true (passed as numerical array)'
		);

		$this->setMwGlobals( 'wgWellFormedXml', true );

		$this->assertEquals(
			' selected=""',
			Html::expandAttributes( array( 'selected' => true ) ),
			'Boolean attributes have empty string value when value is true (wgWellFormedXml)'
		);
	}

	/**
	 * Test for Html::expandAttributes()
	 * Please note it output a string prefixed with a space!
	 */
	public function testExpandAttributesVariousExpansions() {
		### NOT EMPTY ####
		$this->assertEquals(
			' empty_string=""',
			Html::expandAttributes( array( 'empty_string' => '' ) ),
			'Empty string is always quoted'
		);
		$this->assertEquals(
			' key=value',
			Html::expandAttributes( array( 'key' => 'value' ) ),
			'Simple string value needs no quotes'
		);
		$this->assertEquals(
			' one=1',
			Html::expandAttributes( array( 'one' => 1 ) ),
			'Number 1 value needs no quotes'
		);
		$this->assertEquals(
			' zero=0',
			Html::expandAttributes( array( 'zero' => 0 ) ),
			'Number 0 value needs no quotes'
		);

		$this->setMwGlobals( 'wgWellFormedXml', true );

		$this->assertEquals(
			' empty_string=""',
			Html::expandAttributes( array( 'empty_string' => '' ) ),
			'Attribute values are always quoted (wgWellFormedXml): Empty string'
		);
		$this->assertEquals(
			' key="value"',
			Html::expandAttributes( array( 'key' => 'value' ) ),
			'Attribute values are always quoted (wgWellFormedXml): Simple string'
		);
		$this->assertEquals(
			' one="1"',
			Html::expandAttributes( array( 'one' => 1 ) ),
			'Attribute values are always quoted (wgWellFormedXml): Number 1'
		);
		$this->assertEquals(
			' zero="0"',
			Html::expandAttributes( array( 'zero' => 0 ) ),
			'Attribute values are always quoted (wgWellFormedXml): Number 0'
		);
	}

	/**
	 * Html::expandAttributes has special features for HTML
	 * attributes that use space separated lists and also
	 * allows arrays to be used as values.
	 */
	public function testExpandAttributesListValueAttributes() {
		### STRING VALUES
		$this->assertEquals(
			' class="redundant spaces here"',
			Html::expandAttributes( array( 'class' => ' redundant  spaces  here  ' ) ),
			'Normalization should strip redundant spaces'
		);
		$this->assertEquals(
			' class="foo bar"',
			Html::expandAttributes( array( 'class' => 'foo bar foo bar bar' ) ),
			'Normalization should remove duplicates in string-lists'
		);
		### "EMPTY" ARRAY VALUES
		$this->assertEquals(
			' class=""',
			Html::expandAttributes( array( 'class' => array() ) ),
			'Value with an empty array'
		);
		$this->assertEquals(
			' class=""',
			Html::expandAttributes( array( 'class' => array( null, '', ' ', '  ' ) ) ),
			'Array with null, empty string and spaces'
		);
		### NON-EMPTY ARRAY VALUES
		$this->assertEquals(
			' class="foo bar"',
			Html::expandAttributes( array( 'class' => array(
				'foo',
				'bar',
				'foo',
				'bar',
				'bar',
			) ) ),
			'Normalization should remove duplicates in the array'
		);
		$this->assertEquals(
			' class="foo bar"',
			Html::expandAttributes( array( 'class' => array(
				'foo bar',
				'bar foo',
				'foo',
				'bar bar',
			) ) ),
			'Normalization should remove duplicates in string-lists in the array'
		);
	}

	/**
	 * Test feature added by r96188, let pass attributes values as
	 * a PHP array. Restricted to class,rel, accesskey.
	 */
	public function testExpandAttributesSpaceSeparatedAttributesWithBoolean() {
		$this->assertEquals(
			' class="booltrue one"',
			Html::expandAttributes( array( 'class' => array(
				'booltrue' => true,
				'one' => 1,

				# Method use isset() internally, make sure we do discard
				# attributes values which have been assigned well known values
				'emptystring' => '',
				'boolfalse' => false,
				'zero' => 0,
				'null' => null,
			) ) )
		);
	}

	/**
	 * How do we handle duplicate keys in HTML attributes expansion?
	 * We could pass a "class" the values: 'GREEN' and array( 'GREEN' => false )
	 * The later will take precedence.
	 *
	 * Feature added by r96188
	 */
	public function testValueIsAuthoritativeInSpaceSeparatedAttributesArrays() {
		$this->assertEquals(
			' class=""',
			Html::expandAttributes( array( 'class' => array(
				'GREEN',
				'GREEN' => false,
				'GREEN',
			) ) )
		);
	}

	public function testNamespaceSelector() {
		$this->assertEquals(
			'<select id=namespace name=namespace>' . "\n" .
				'<option value=0>(Main)</option>' . "\n" .
				'<option value=1>Talk</option>' . "\n" .
				'<option value=2>User</option>' . "\n" .
				'<option value=3>User talk</option>' . "\n" .
				'<option value=4>MyWiki</option>' . "\n" .
				'<option value=5>MyWiki Talk</option>' . "\n" .
				'<option value=6>File</option>' . "\n" .
				'<option value=7>File talk</option>' . "\n" .
				'<option value=8>MediaWiki</option>' . "\n" .
				'<option value=9>MediaWiki talk</option>' . "\n" .
				'<option value=10>Template</option>' . "\n" .
				'<option value=11>Template talk</option>' . "\n" .
				'<option value=14>Category</option>' . "\n" .
				'<option value=15>Category talk</option>' . "\n" .
				'<option value=100>Custom</option>' . "\n" .
				'<option value=101>Custom talk</option>' . "\n" .
				'</select>',
			Html::namespaceSelector(),
			'Basic namespace selector without custom options'
		);

		$this->assertEquals(
			'<label for=mw-test-namespace>Select a namespace:</label>&#160;' .
				'<select id=mw-test-namespace name=wpNamespace>' . "\n" .
				'<option value=all>all</option>' . "\n" .
				'<option value=0>(Main)</option>' . "\n" .
				'<option value=1>Talk</option>' . "\n" .
				'<option value=2 selected>User</option>' . "\n" .
				'<option value=3>User talk</option>' . "\n" .
				'<option value=4>MyWiki</option>' . "\n" .
				'<option value=5>MyWiki Talk</option>' . "\n" .
				'<option value=6>File</option>' . "\n" .
				'<option value=7>File talk</option>' . "\n" .
				'<option value=8>MediaWiki</option>' . "\n" .
				'<option value=9>MediaWiki talk</option>' . "\n" .
				'<option value=10>Template</option>' . "\n" .
				'<option value=11>Template talk</option>' . "\n" .
				'<option value=14>Category</option>' . "\n" .
				'<option value=15>Category talk</option>' . "\n" .
				'<option value=100>Custom</option>' . "\n" .
				'<option value=101>Custom talk</option>' . "\n" .
				'</select>',
			Html::namespaceSelector(
				array( 'selected' => '2', 'all' => 'all', 'label' => 'Select a namespace:' ),
				array( 'name' => 'wpNamespace', 'id' => 'mw-test-namespace' )
			),
			'Basic namespace selector with custom values'
		);

		$this->assertEquals(
			'<label for=namespace>Select a namespace:</label>&#160;' .
				'<select id=namespace name=namespace>' . "\n" .
				'<option value=0>(Main)</option>' . "\n" .
				'<option value=1>Talk</option>' . "\n" .
				'<option value=2>User</option>' . "\n" .
				'<option value=3>User talk</option>' . "\n" .
				'<option value=4>MyWiki</option>' . "\n" .
				'<option value=5>MyWiki Talk</option>' . "\n" .
				'<option value=6>File</option>' . "\n" .
				'<option value=7>File talk</option>' . "\n" .
				'<option value=8>MediaWiki</option>' . "\n" .
				'<option value=9>MediaWiki talk</option>' . "\n" .
				'<option value=10>Template</option>' . "\n" .
				'<option value=11>Template talk</option>' . "\n" .
				'<option value=14>Category</option>' . "\n" .
				'<option value=15>Category talk</option>' . "\n" .
				'<option value=100>Custom</option>' . "\n" .
				'<option value=101>Custom talk</option>' . "\n" .
				'</select>',
			Html::namespaceSelector(
				array( 'label' => 'Select a namespace:' )
			),
			'Basic namespace selector with a custom label but no id attribtue for the <select>'
		);
	}

	public function testCanFilterOutNamespaces() {
		$this->assertEquals(
			'<select id=namespace name=namespace>' . "\n" .
				'<option value=2>User</option>' . "\n" .
				'<option value=4>MyWiki</option>' . "\n" .
				'<option value=5>MyWiki Talk</option>' . "\n" .
				'<option value=6>File</option>' . "\n" .
				'<option value=7>File talk</option>' . "\n" .
				'<option value=8>MediaWiki</option>' . "\n" .
				'<option value=9>MediaWiki talk</option>' . "\n" .
				'<option value=10>Template</option>' . "\n" .
				'<option value=11>Template talk</option>' . "\n" .
				'<option value=14>Category</option>' . "\n" .
				'<option value=15>Category talk</option>' . "\n" .
				'</select>',
			Html::namespaceSelector(
				array( 'exclude' => array( 0, 1, 3, 100, 101 ) )
			),
			'Namespace selector namespace filtering.'
		);
	}

	public function testCanDisableANamespaces() {
		$this->assertEquals(
			'<select id=namespace name=namespace>' . "\n" .
				'<option disabled value=0>(Main)</option>' . "\n" .
				'<option disabled value=1>Talk</option>' . "\n" .
				'<option disabled value=2>User</option>' . "\n" .
				'<option disabled value=3>User talk</option>' . "\n" .
				'<option disabled value=4>MyWiki</option>' . "\n" .
				'<option value=5>MyWiki Talk</option>' . "\n" .
				'<option value=6>File</option>' . "\n" .
				'<option value=7>File talk</option>' . "\n" .
				'<option value=8>MediaWiki</option>' . "\n" .
				'<option value=9>MediaWiki talk</option>' . "\n" .
				'<option value=10>Template</option>' . "\n" .
				'<option value=11>Template talk</option>' . "\n" .
				'<option value=14>Category</option>' . "\n" .
				'<option value=15>Category talk</option>' . "\n" .
				'<option value=100>Custom</option>' . "\n" .
				'<option value=101>Custom talk</option>' . "\n" .
				'</select>',
			Html::namespaceSelector( array(
				'disable' => array( 0, 1, 2, 3, 4 )
			) ),
			'Namespace selector namespace disabling'
		);
	}

	/**
	 * @dataProvider provideHtml5InputTypes
	 */
	public function testHtmlElementAcceptsNewHtml5TypesInHtml5Mode( $HTML5InputType ) {
		$this->assertEquals(
			'<input type=' . $HTML5InputType . '>',
			Html::element( 'input', array( 'type' => $HTML5InputType ) ),
			'In HTML5, HTML::element() should accept type="' . $HTML5InputType . '"'
		);
	}

	/**
	 * List of input element types values introduced by HTML5
	 * Full list at http://www.w3.org/TR/html-markup/input.html
	 */
	public static function provideHtml5InputTypes() {
		$types = array(
			'datetime',
			'datetime-local',
			'date',
			'month',
			'time',
			'week',
			'number',
			'range',
			'email',
			'url',
			'search',
			'tel',
			'color',
		);
		$cases = array();
		foreach ( $types as $type ) {
			$cases[] = array( $type );
		}

		return $cases;
	}

	/**
	 * Test out Html::element drops or enforces default value
	 * @covers Html::dropDefaults
	 * @dataProvider provideElementsWithAttributesHavingDefaultValues
	 */
	public function testDropDefaults( $expected, $element, $attribs, $message = '' ) {
		$this->assertEquals( $expected, Html::element( $element, $attribs ), $message );
	}

	public static function provideElementsWithAttributesHavingDefaultValues() {
		# Use cases in a concise format:
		# <expected>, <element name>, <array of attributes> [, <message>]
		# Will be mapped to Html::element()
		$cases = array();

		### Generic cases, match $attribDefault static array
		$cases[] = array( '<area>',
			'area', array( 'shape' => 'rect' )
		);

		$cases[] = array( '<button type=submit></button>',
			'button', array( 'formaction' => 'GET' )
		);
		$cases[] = array( '<button type=submit></button>',
			'button', array( 'formenctype' => 'application/x-www-form-urlencoded' )
		);

		$cases[] = array( '<canvas></canvas>',
			'canvas', array( 'height' => '150' )
		);
		$cases[] = array( '<canvas></canvas>',
			'canvas', array( 'width' => '300' )
		);
		# Also check with numeric values
		$cases[] = array( '<canvas></canvas>',
			'canvas', array( 'height' => 150 )
		);
		$cases[] = array( '<canvas></canvas>',
			'canvas', array( 'width' => 300 )
		);

		$cases[] = array( '<command>',
			'command', array( 'type' => 'command' )
		);

		$cases[] = array( '<form></form>',
			'form', array( 'action' => 'GET' )
		);
		$cases[] = array( '<form></form>',
			'form', array( 'autocomplete' => 'on' )
		);
		$cases[] = array( '<form></form>',
			'form', array( 'enctype' => 'application/x-www-form-urlencoded' )
		);

		$cases[] = array( '<input>',
			'input', array( 'formaction' => 'GET' )
		);
		$cases[] = array( '<input>',
			'input', array( 'type' => 'text' )
		);

		$cases[] = array( '<keygen>',
			'keygen', array( 'keytype' => 'rsa' )
		);

		$cases[] = array( '<link>',
			'link', array( 'media' => 'all' )
		);

		$cases[] = array( '<menu></menu>',
			'menu', array( 'type' => 'list' )
		);

		$cases[] = array( '<script></script>',
			'script', array( 'type' => 'text/javascript' )
		);

		$cases[] = array( '<style></style>',
			'style', array( 'media' => 'all' )
		);
		$cases[] = array( '<style></style>',
			'style', array( 'type' => 'text/css' )
		);

		$cases[] = array( '<textarea></textarea>',
			'textarea', array( 'wrap' => 'soft' )
		);

		### SPECIFIC CASES

		# <link type="text/css">
		$cases[] = array( '<link>',
			'link', array( 'type' => 'text/css' )
		);

		# <input> specific handling
		$cases[] = array( '<input type=checkbox>',
			'input', array( 'type' => 'checkbox', 'value' => 'on' ),
			'Default value "on" is stripped of checkboxes',
		);
		$cases[] = array( '<input type=radio>',
			'input', array( 'type' => 'radio', 'value' => 'on' ),
			'Default value "on" is stripped of radio buttons',
		);
		$cases[] = array( '<input type=submit value=Submit>',
			'input', array( 'type' => 'submit', 'value' => 'Submit' ),
			'Default value "Submit" is kept on submit buttons (for possible l10n issues)',
		);
		$cases[] = array( '<input type=color>',
			'input', array( 'type' => 'color', 'value' => '' ),
		);
		$cases[] = array( '<input type=range>',
			'input', array( 'type' => 'range', 'value' => '' ),
		);

		# <button> specific handling
		# see remarks on http://msdn.microsoft.com/en-us/library/ie/ms535211%28v=vs.85%29.aspx
		$cases[] = array( '<button type=submit></button>',
			'button', array( 'type' => 'submit' ),
			'According to standard the default type is "submit". Depending on compatibility mode IE might use "button", instead.',
		);

		# <select> specifc handling
		$cases[] = array( '<select multiple></select>',
			'select', array( 'size' => '4', 'multiple' => true ),
		);
		# .. with numeric value
		$cases[] = array( '<select multiple></select>',
			'select', array( 'size' => 4, 'multiple' => true ),
		);
		$cases[] = array( '<select></select>',
			'select', array( 'size' => '1', 'multiple' => false ),
		);
		# .. with numeric value
		$cases[] = array( '<select></select>',
			'select', array( 'size' => 1, 'multiple' => false ),
		);

		# Passing an array as value
		$cases[] = array( '<a class="css-class-one css-class-two"></a>',
			'a', array( 'class' => array( 'css-class-one', 'css-class-two' ) ),
			"dropDefaults accepts values given as an array"
		);

		# FIXME: doDropDefault should remove defaults given in an array
		# Expected should be '<a></a>'
		$cases[] = array( '<a class=""></a>',
			'a', array( 'class' => array( '', '' ) ),
			"dropDefaults accepts values given as an array"
		);

		# Craft the Html elements
		$ret = array();
		foreach ( $cases as $case ) {
			$ret[] = array(
				$case[0],
				$case[1], $case[2],
				isset( $case[3] ) ? $case[3] : ''
			);
		}

		return $ret;
	}

	public function testFormValidationBlacklist() {
		$this->assertEmpty(
			Html::expandAttributes( array( 'min' => 1, 'max' => 100, 'pattern' => 'abc', 'required' => true, 'step' => 2 ) ),
			'Blacklist form validation attributes.'
		);
		$this->assertEquals(
			' step=any',
			Html::expandAttributes( array( 'min' => 1, 'max' => 100, 'pattern' => 'abc', 'required' => true, 'step' => 'any' ) ),
			'Allow special case "step=any".'
		);
	}
}