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