tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js

   1 ( function () {
   2         var util = require( 'mediawiki.util' ),
   3                 // Based on IPTest.php > testisIPv4
   4                 IPV4_CASES = [
   5                         [ false, false, 'Boolean false is not an IP' ],
   6                         [ false, true, 'Boolean true is not an IP' ],
   7                         [ false, '', 'Empty string is not an IP' ],
   8                         [ false, 'abc', '"abc" is not an IP' ],
   9                         [ false, ':', 'Colon is not an IP' ],
  10                         [ false, '124.24.52', 'IPv4 not enough quads' ],
  11                         [ false, '24.324.52.13', 'IPv4 out of range' ],
  12                         [ false, '.24.52.13', 'IPv4 starts with period' ],
  13
  14                         [ true, '124.24.52.13', '124.24.52.134 is a valid IP' ],
  15                         [ true, '1.24.52.13', '1.24.52.13 is a valid IP' ],
  16                         [ false, '74.24.52.13/20', 'IPv4 ranges are not recognized as valid IPs' ]
  17                 ],
  18
  19                 // Based on IPTest.php > testisIPv6
  20                 IPV6_CASES = [
  21                         [ false, ':fc:100::', 'IPv6 starting with lone ":"' ],
  22                         [ false, 'fc:100:::', 'IPv6 ending with a ":::"' ],
  23                         [ false, 'fc:300', 'IPv6 with only 2 words' ],
  24                         [ false, 'fc:100:300', 'IPv6 with only 3 words' ],
  25
  26                         [ false, 'fc:100:a:d:1:e:ac:0::', 'IPv6 with 8 words ending with "::"' ],
  27                         [ false, 'fc:100:a:d:1:e:ac:0:1::', 'IPv6 with 9 words ending with "::"' ],
  28
  29                         [ false, ':::' ],
  30                         [ false, '::0:', 'IPv6 ending in a lone ":"' ],
  31
  32                         [ true, '::', 'IPv6 zero address' ],
  33
  34                         [ false, '::fc:100:a:d:1:e:ac:0', 'IPv6 with "::" and 8 words' ],
  35                         [ false, '::fc:100:a:d:1:e:ac:0:1', 'IPv6 with 9 words' ],
  36
  37                         [ false, ':fc::100', 'IPv6 starting with lone ":"' ],
  38                         [ false, 'fc::100:', 'IPv6 ending with lone ":"' ],
  39                         [ false, 'fc:::100', 'IPv6 with ":::" in the middle' ],
  40
  41                         [ true, 'fc::100', 'IPv6 with "::" and 2 words' ],
  42                         [ true, 'fc::100:a', 'IPv6 with "::" and 3 words' ],
  43                         [ true, 'fc::100:a:d', 'IPv6 with "::" and 4 words' ],
  44                         [ true, 'fc::100:a:d:1', 'IPv6 with "::" and 5 words' ],
  45                         [ true, 'fc::100:a:d:1:e', 'IPv6 with "::" and 6 words' ],
  46                         [ true, 'fc::100:a:d:1:e:ac', 'IPv6 with "::" and 7 words' ],
  47                         [ true, '2001::df', 'IPv6 with "::" and 2 words' ],
  48                         [ true, '2001:5c0:1400:a::df', 'IPv6 with "::" and 5 words' ],
  49                         [ true, '2001:5c0:1400:a::df:2', 'IPv6 with "::" and 6 words' ],
  50
  51                         [ false, 'fc::100:a:d:1:e:ac:0', 'IPv6 with "::" and 8 words' ],
  52                         [ false, 'fc::100:a:d:1:e:ac:0:1', 'IPv6 with 9 words' ]
  53                 ];
  54
  55         Array.prototype.push.apply( IPV6_CASES,
  56                 [
  57                         'fc:100::',
  58                         'fc:100:a::',
  59                         'fc:100:a:d::',
  60                         'fc:100:a:d:1::',
  61                         'fc:100:a:d:1:e::',
  62                         'fc:100:a:d:1:e:ac::',
  63                         '::0',
  64                         '::fc',
  65                         '::fc:100',
  66                         '::fc:100:a',
  67                         '::fc:100:a:d',
  68                         '::fc:100:a:d:1',
  69                         '::fc:100:a:d:1:e',
  70                         '::fc:100:a:d:1:e:ac',
  71                         'fc:100:a:d:1:e:ac:0'
  72                 ].map( function ( el ) {
  73                         return [ true, el, el + ' is a valid IP' ];
  74                 } )
  75         );
  76
  77         QUnit.module( 'mediawiki.util', QUnit.newMwEnvironment( {
  78                 setup: function () {
  79                         $.fn.updateTooltipAccessKeys.setTestMode( true );
  80                 },
  81                 teardown: function () {
  82                         $.fn.updateTooltipAccessKeys.setTestMode( false );
  83                         mw.util.resetOptionsForTest();
  84                 },
  85                 messages: {
  86                         // Used by accessKeyLabel in test for addPortletLink
  87                         brackets: '[$1]',
  88                         'word-separator': ' '
  89                 }
  90         } ) );
  91
  92         QUnit.test( 'rawurlencode', function ( assert ) {
  93                 assert.strictEqual( util.rawurlencode( 'Test:A & B/Here' ), 'Test%3AA%20%26%20B%2FHere' );
  94         } );
  95
  96         QUnit.test( 'escapeIdForAttribute', function ( assert ) {
  97                 // Test cases are kept in sync with SanitizerTest.php
  98                 var text = 'foo тест_#%!\'()[]:<>',
  99                         legacyEncoded = 'foo_.D1.82.D0.B5.D1.81.D1.82_.23.25.21.27.28.29.5B.5D:.3C.3E',
 100                         html5Encoded = 'foo_тест_#%!\'()[]:<>',
 101                         // Settings: this is $wgFragmentMode
 102                         legacy = [ 'legacy' ],
 103                         legacyNew = [ 'legacy', 'html5' ],
 104                         newLegacy = [ 'html5', 'legacy' ],
 105                         allNew = [ 'html5' ];
 106
 107                 // Test cases are kept in sync with SanitizerTest.php
 108                 [
 109                         // Pure legacy: how MW worked before 2017
 110                         [ legacy, text, legacyEncoded ],
 111                         // Transition to a new world: legacy links with HTML5 fallback
 112                         [ legacyNew, text, legacyEncoded ],
 113                         // New world: HTML5 links, legacy fallbacks
 114                         [ newLegacy, text, html5Encoded ],
 115                         // Distant future: no legacy fallbacks
 116                         [ allNew, text, html5Encoded ]
 117                 ].forEach( function ( testCase ) {
 118                         mw.util.setOptionsForTest( { FragmentMode: testCase[ 0 ] } );
 119
 120                         assert.strictEqual( util.escapeIdForAttribute( testCase[ 1 ] ), testCase[ 2 ] );
 121                 } );
 122         } );
 123
 124         QUnit.test( 'escapeIdForLink', function ( assert ) {
 125                 // Test cases are kept in sync with SanitizerTest.php
 126                 var text = 'foo тест_#%!\'()[]:<>',
 127                         legacyEncoded = 'foo_.D1.82.D0.B5.D1.81.D1.82_.23.25.21.27.28.29.5B.5D:.3C.3E',
 128                         html5Encoded = 'foo_тест_#%!\'()[]:<>',
 129                         // Settings: this is wgFragmentMode
 130                         legacy = [ 'legacy' ],
 131                         legacyNew = [ 'legacy', 'html5' ],
 132                         newLegacy = [ 'html5', 'legacy' ],
 133                         allNew = [ 'html5' ];
 134
 135                 [
 136                         // Pure legacy: how MW worked before 2017
 137                         [ legacy, text, legacyEncoded ],
 138                         // Transition to a new world: legacy links with HTML5 fallback
 139                         [ legacyNew, text, legacyEncoded ],
 140                         // New world: HTML5 links, legacy fallbacks
 141                         [ newLegacy, text, html5Encoded ],
 142                         // Distant future: no legacy fallbacks
 143                         [ allNew, text, html5Encoded ]
 144                 ].forEach( function ( testCase ) {
 145                         mw.util.setOptionsForTest( { FragmentMode: testCase[ 0 ] } );
 146
 147                         assert.strictEqual( util.escapeIdForLink( testCase[ 1 ] ), testCase[ 2 ] );
 148                 } );
 149         } );
 150
 151         QUnit.test( 'wikiUrlencode', function ( assert ) {
 152                 assert.strictEqual( util.wikiUrlencode( 'Test:A & B/Here' ), 'Test:A_%26_B/Here' );
 153                 // See also wfUrlencodeTest.php#provideURLS
 154                 // eslint-disable-next-line no-jquery/no-each-util
 155                 $.each( {
 156                         '+': '%2B',
 157                         '&': '%26',
 158                         '=': '%3D',
 159                         ':': ':',
 160                         ';@$-_.!*': ';@$-_.!*',
 161                         '/': '/',
 162                         '~': '~',
 163                         '[]': '%5B%5D',
 164                         '<>': '%3C%3E',
 165                         '\'': '%27'
 166                 }, function ( input, output ) {
 167                         assert.strictEqual( util.wikiUrlencode( input ), output );
 168                 } );
 169         } );
 170
 171         QUnit.test( 'getUrl', function ( assert ) {
 172                 var href;
 173                 mw.config.set( {
 174                         wgScript: '/w/index.php',
 175                         wgArticlePath: '/wiki/$1',
 176                         wgPageName: 'Foobar'
 177                 } );
 178
 179                 href = util.getUrl( 'Sandbox' );
 180                 assert.strictEqual( href, '/wiki/Sandbox', 'simple title' );
 181
 182                 href = util.getUrl( 'Foo:Sandbox? 5+5=10! (test)/sub ' );
 183                 assert.strictEqual( href, '/wiki/Foo:Sandbox%3F_5%2B5%3D10!_(test)/sub_', 'complex title' );
 184
 185                 // T149767
 186                 href = util.getUrl( 'My$$test$$$$$title' );
 187                 assert.strictEqual( href, '/wiki/My$$test$$$$$title', 'title with multiple consecutive dollar signs' );
 188
 189                 href = util.getUrl();
 190                 assert.strictEqual( href, '/wiki/Foobar', 'default title' );
 191
 192                 href = util.getUrl( null, { action: 'edit' } );
 193                 assert.strictEqual( href, '/w/index.php?title=Foobar&action=edit', 'default title with query string' );
 194
 195                 href = util.getUrl( 'Sandbox', { action: 'edit' } );
 196                 assert.strictEqual( href, '/w/index.php?title=Sandbox&action=edit', 'simple title with query string' );
 197
 198                 // Test fragments
 199                 href = util.getUrl( 'Foo:Sandbox#Fragment', { action: 'edit' } );
 200                 assert.strictEqual( href, '/w/index.php?title=Foo:Sandbox&action=edit#Fragment', 'namespaced title with query string and fragment' );
 201
 202                 href = util.getUrl( 'Sandbox#', { action: 'edit' } );
 203                 assert.strictEqual( href, '/w/index.php?title=Sandbox&action=edit', 'title with query string and empty fragment' );
 204
 205                 href = util.getUrl( 'Sandbox', {} );
 206                 assert.strictEqual( href, '/wiki/Sandbox', 'title with empty query string' );
 207
 208                 href = util.getUrl( '#Fragment' );
 209                 assert.strictEqual( href, '/wiki/#Fragment', 'empty title with fragment' );
 210
 211                 href = util.getUrl( '#Fragment', { action: 'edit' } );
 212                 assert.strictEqual( href, '/w/index.php?action=edit#Fragment', 'empty title with query string and fragment' );
 213
 214                 mw.util.setOptionsForTest( { FragmentMode: [ 'legacy' ] } );
 215                 href = util.getUrl( 'Foo:Sandbox \xC4#Fragment \xC4', { action: 'edit' } );
 216                 assert.strictEqual( href, '/w/index.php?title=Foo:Sandbox_%C3%84&action=edit#Fragment_.C3.84', 'title with query string, fragment, and special characters' );
 217
 218                 mw.util.setOptionsForTest( { FragmentMode: [ 'html5' ] } );
 219                 href = util.getUrl( 'Foo:Sandbox \xC4#Fragment \xC4', { action: 'edit' } );
 220                 assert.strictEqual( href, '/w/index.php?title=Foo:Sandbox_%C3%84&action=edit#Fragment_Ä', 'title with query string, fragment, and special characters' );
 221
 222                 href = util.getUrl( 'Foo:%23#Fragment', { action: 'edit' } );
 223                 assert.strictEqual( href, '/w/index.php?title=Foo:%2523&action=edit#Fragment', 'title containing %23 (#), fragment, and a query string' );
 224
 225                 mw.util.setOptionsForTest( { FragmentMode: [ 'legacy' ] } );
 226                 href = util.getUrl( '#+&=:;@$-_.!*/[]<>\'§', { action: 'edit' } );
 227                 assert.strictEqual( href, '/w/index.php?action=edit#.2B.26.3D:.3B.40.24-_..21.2A.2F.5B.5D.3C.3E.27.C2.A7', 'fragment with various characters' );
 228
 229                 mw.util.setOptionsForTest( { FragmentMode: [ 'html5' ] } );
 230                 href = util.getUrl( '#+&=:;@$-_.!*/[]<>\'§', { action: 'edit' } );
 231                 assert.strictEqual( href, '/w/index.php?action=edit#+&=:;@$-_.!*/[]<>\'§', 'fragment with various characters' );
 232         } );
 233
 234         QUnit.test( 'wikiScript', function ( assert ) {
 235                 mw.config.set( {
 236                         // customized wgScript for T41103
 237                         wgScript: '/w/i.php',
 238                         // customized wgLoadScript for T41103
 239                         wgLoadScript: '/w/l.php',
 240                         wgScriptPath: '/w'
 241                 } );
 242
 243                 assert.strictEqual( util.wikiScript(), mw.config.get( 'wgScript' ),
 244                         'wikiScript() returns wgScript'
 245                 );
 246                 assert.strictEqual( util.wikiScript( 'index' ), mw.config.get( 'wgScript' ),
 247                         'wikiScript( index ) returns wgScript'
 248                 );
 249                 assert.strictEqual( util.wikiScript( 'load' ), mw.config.get( 'wgLoadScript' ),
 250                         'wikiScript( load ) returns wgLoadScript'
 251                 );
 252                 assert.strictEqual( util.wikiScript( 'api' ), '/w/api.php', 'API path' );
 253         } );
 254
 255         QUnit.test( 'addCSS', function ( assert ) {
 256                 var $el, style;
 257                 $el = $( '<div>' ).attr( 'id', 'mw-addcsstest' ).appendTo( '#qunit-fixture' );
 258
 259                 style = util.addCSS( '#mw-addcsstest { visibility: hidden; }' );
 260                 assert.strictEqual( typeof style, 'object', 'addCSS returned an object' );
 261                 assert.strictEqual( style.disabled, false, 'property "disabled" is available and set to false' );
 262
 263                 assert.strictEqual( $el.css( 'visibility' ), 'hidden', 'Added style properties are in effect' );
 264
 265                 // Clean up
 266                 $( style.ownerNode ).remove();
 267         } );
 268
 269         QUnit.test( 'getParamValue', function ( assert ) {
 270                 var url;
 271
 272                 url = 'http://example.org/?foo=wrong&foo=right#&foo=bad';
 273                 assert.strictEqual( util.getParamValue( 'foo', url ), 'right', 'Use latest one, ignore hash' );
 274                 assert.strictEqual( util.getParamValue( 'bar', url ), null, 'Return null when not found' );
 275
 276                 url = 'http://example.org/#&foo=bad';
 277                 assert.strictEqual( util.getParamValue( 'foo', url ), null, 'Ignore hash if param is not in querystring but in hash (T29427)' );
 278
 279                 url = 'example.org?' + $.param( { TEST: 'a b+c' } );
 280                 assert.strictEqual( util.getParamValue( 'TEST', url ), 'a b+c', 'T32441: getParamValue must understand "+" encoding of space' );
 281
 282                 url = 'example.org?' + $.param( { TEST: 'a b+c d' } ); // check for sloppy code from r95332 :)
 283                 assert.strictEqual( util.getParamValue( 'TEST', url ), 'a b+c d', 'T32441: getParamValue must understand "+" encoding of space (multiple spaces)' );
 284         } );
 285
 286         QUnit.test( '$content', function ( assert ) {
 287                 assert.ok( util.$content instanceof $, 'mw.util.$content instance of jQuery' );
 288                 assert.strictEqual( util.$content.length, 1, 'mw.util.$content must have length of 1' );
 289         } );
 290
 291         /**
 292          * Portlet names are prefixed with 'p-test' to avoid conflict with core
 293          * when running the test suite under a wiki page.
 294          * Previously, test elements where invisible to the selector since only
 295          * one element can have a given id.
 296          */
 297         QUnit.test( 'addPortletLink', function ( assert ) {
 298                 var tbRL, cuQuux, $cuQuux, tbMW, $tbMW, tbRLDM, caFoo,
 299                         addedAfter, tbRLDMnonexistentid, tbRLDMemptyjquery;
 300
 301                 $( '#qunit-fixture' ).append(
 302                         '<div class="portlet" id="p-test-tb">' +
 303                                 '<h3>Toolbox</h3>' +
 304                                 '<ul class="body"></ul>' +
 305                         '</div>' +
 306                         '<div class="portlet" id="p-test-custom">' +
 307                                 '<h3>Views</h3>' +
 308                                 '<ul class="body">' +
 309                                         '<li id="c-foo"><a href="#">Foo</a></li>' +
 310                                         '<li id="c-barmenu">' +
 311                                                 '<ul>' +
 312                                                         '<li id="c-bar-baz"><a href="#">Baz</a></a>' +
 313                                                 '</ul>' +
 314                                         '</li>' +
 315                                 '</ul>' +
 316                         '</div>' +
 317                         '<div id="p-test-views" class="vectorTabs">' +
 318                                 '<h3>Views</h3>' +
 319                                 '<ul></ul>' +
 320                         '</div>'
 321                 );
 322
 323                 tbRL = util.addPortletLink( 'p-test-tb', 'https://example.org/next',
 324                         'Next', 't-rl', 'More info about Example Next ', 'l'
 325                 );
 326                 assert.strictEqual( tbRL.nodeType, 1, 'returns a DOM Node' );
 327                 assert.strictEqual( tbRL.nodeName, 'LI', 'returns a list item element' );
 328
 329                 tbMW = util.addPortletLink( 'p-test-tb', '//example.org/',
 330                         'Example.org', 't-xmp', 'Go to Example', 'x', tbRL );
 331                 $tbMW = $( tbMW );
 332                 assert.propEqual(
 333                         $tbMW.getAttrs(),
 334                         {
 335                                 id: 't-xmp'
 336                         },
 337                         'List item attributes'
 338                 );
 339                 assert.propEqual(
 340                         $tbMW.find( 'a' ).getAttrs(),
 341                         {
 342                                 href: '//example.org/',
 343                                 title: 'Go to Example [test-x]',
 344                                 accesskey: 'x'
 345                         },
 346                         'Anchor link attributes'
 347                 );
 348                 assert.strictEqual(
 349                         $tbMW.closest( '.portlet' ).attr( 'id' ),
 350                         'p-test-tb',
 351                         'Parent portlet ID'
 352                 );
 353                 assert.strictEqual(
 354                         $tbMW.next()[ 0 ],
 355                         tbRL,
 356                         'Next node (set as Node object)'
 357                 );
 358                 assert.strictEqual(
 359                         $tbMW.find( 'span' ).length,
 360                         0,
 361                         'No <span> wrap for porlets without vectorTabs class'
 362                 );
 363
 364                 cuQuux = util.addPortletLink( 'p-test-custom', '#', 'Quux', null, 'Example [shift-x]', 'q' );
 365                 $cuQuux = $( cuQuux );
 366                 assert.strictEqual(
 367                         $cuQuux.find( 'a' ).attr( 'title' ),
 368                         'Example [test-q]',
 369                         'Title has new accesskey and label'
 370                 );
 371                 assert.strictEqual(
 372                         $( '#p-test-custom #c-barmenu ul li' ).length,
 373                         1,
 374                         'No items added to unrelated <ul> elsewhere in the portlet (T37082)'
 375                 );
 376
 377                 tbRLDM = util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/RL/DM',
 378                         'Default modules', 't-rldm', 'List of all default modules ', 'd', '#t-rl' );
 379                 assert.strictEqual( $( tbRLDM ).next()[ 0 ], tbRL, 'Next node (set as CSS selector)' );
 380
 381                 caFoo = util.addPortletLink( 'p-test-views', '#', 'Foo' );
 382                 assert.strictEqual( $( caFoo ).find( 'span' ).length, 1, 'Added <span> element for porlet with vectorTabs class' );
 383
 384                 addedAfter = util.addPortletLink( 'p-test-tb', '#', 'After foo', 'post-foo', 'After foo', null, $( tbRL ) );
 385                 assert.strictEqual( $( addedAfter ).next()[ 0 ], tbRL, 'Next node (set as jQuery object)' );
 386
 387                 tbRLDMnonexistentid = util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/RL/DM',
 388                         'Default modules', 't-rldm-nonexistent', 'List of all default modules ', 'd', '#t-rl-nonexistent' );
 389                 assert.strictEqual(
 390                         tbRLDMnonexistentid,
 391                         $( '#p-test-tb li:last' )[ 0 ],
 392                         'Next node as non-matching CSS selector falls back to appending'
 393                 );
 394
 395                 tbRLDMemptyjquery = util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/RL/DM',
 396                         'Default modules', 't-rldm-empty-jquery', 'List of all default modules ', 'd', $( '#t-rl-nonexistent' ) );
 397                 assert.strictEqual(
 398                         tbRLDMemptyjquery,
 399                         $( '#p-test-tb li:last' )[ 0 ],
 400                         'Next node as empty jQuery object falls back to appending'
 401                 );
 402         } );
 403
 404         QUnit.test( 'validateEmail', function ( assert ) {
 405                 assert.strictEqual( util.validateEmail( '' ), null, 'Should return null for empty string ' );
 406                 assert.strictEqual( util.validateEmail( 'user@localhost' ), true, 'Return true for a valid e-mail address' );
 407
 408                 // testEmailWithCommasAreInvalids
 409                 assert.strictEqual( util.validateEmail( 'user,foo@example.org' ), false, 'Emails with commas are invalid' );
 410                 assert.strictEqual( util.validateEmail( 'userfoo@ex,ample.org' ), false, 'Emails with commas are invalid' );
 411
 412                 // testEmailWithHyphens
 413                 assert.strictEqual( util.validateEmail( 'user-foo@example.org' ), true, 'Emails may contain a hyphen' );
 414                 assert.strictEqual( util.validateEmail( 'userfoo@ex-ample.org' ), true, 'Emails may contain a hyphen' );
 415         } );
 416
 417         QUnit.test( 'isIPv6Address', function ( assert ) {
 418                 IPV6_CASES.forEach( function ( ipCase ) {
 419                         assert.strictEqual( util.isIPv6Address( ipCase[ 1 ] ), ipCase[ 0 ], ipCase[ 2 ] );
 420                 } );
 421         } );
 422
 423         QUnit.test( 'isIPv4Address', function ( assert ) {
 424                 IPV4_CASES.forEach( function ( ipCase ) {
 425                         assert.strictEqual( util.isIPv4Address( ipCase[ 1 ] ), ipCase[ 0 ], ipCase[ 2 ] );
 426                 } );
 427         } );
 428
 429         QUnit.test( 'isIPAddress', function ( assert ) {
 430                 IPV4_CASES.forEach( function ( ipCase ) {
 431                         assert.strictEqual( util.isIPv4Address( ipCase[ 1 ] ), ipCase[ 0 ], ipCase[ 2 ] );
 432                 } );
 433
 434                 IPV6_CASES.forEach( function ( ipCase ) {
 435                         assert.strictEqual( util.isIPv6Address( ipCase[ 1 ] ), ipCase[ 0 ], ipCase[ 2 ] );
 436                 } );
 437         } );
 438 }() );