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

   1 ( function ( mw, $ ) {
   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                 $.map( [
  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                 ], 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.equal( util.rawurlencode( 'Test:A & B/Here' ), 'Test%3AA%20%26%20B%2FHere' );
  93         } );
  94
  95         QUnit.test( 'escapeId', function ( assert ) {
  96                 mw.config.set( 'wgExperimentalHtmlIds', false );
  97                 $.each( {
  98                         '+': '.2B',
  99                         '&': '.26',
 100                         '=': '.3D',
 101                         ':': ':',
 102                         ';': '.3B',
 103                         '@': '.40',
 104                         $: '.24',
 105                         '-_.': '-_.',
 106                         '!': '.21',
 107                         '*': '.2A',
 108                         '/': '.2F',
 109                         '[]': '.5B.5D',
 110                         '<>': '.3C.3E',
 111                         '\'': '.27',
 112                         '§': '.C2.A7',
 113                         'Test:A & B/Here': 'Test:A_.26_B.2FHere',
 114                         'A&B&amp;C&amp;amp;D&amp;amp;amp;E': 'A.26B.26amp.3BC.26amp.3Bamp.3BD.26amp.3Bamp.3Bamp.3BE'
 115                 }, function ( input, output ) {
 116                         assert.equal( util.escapeId( input ), output );
 117                 } );
 118         } );
 119
 120         QUnit.test( 'wikiUrlencode', function ( assert ) {
 121                 assert.equal( util.wikiUrlencode( 'Test:A & B/Here' ), 'Test:A_%26_B/Here' );
 122                 // See also wfUrlencodeTest.php#provideURLS
 123                 $.each( {
 124                         '+': '%2B',
 125                         '&': '%26',
 126                         '=': '%3D',
 127                         ':': ':',
 128                         ';@$-_.!*': ';@$-_.!*',
 129                         '/': '/',
 130                         '~': '~',
 131                         '[]': '%5B%5D',
 132                         '<>': '%3C%3E',
 133                         '\'': '%27'
 134                 }, function ( input, output ) {
 135                         assert.equal( util.wikiUrlencode( input ), output );
 136                 } );
 137         } );
 138
 139         QUnit.test( 'getUrl', function ( assert ) {
 140                 var href;
 141                 mw.config.set( {
 142                         wgScript: '/w/index.php',
 143                         wgArticlePath: '/wiki/$1',
 144                         wgPageName: 'Foobar'
 145                 } );
 146
 147                 href = util.getUrl( 'Sandbox' );
 148                 assert.equal( href, '/wiki/Sandbox', 'simple title' );
 149
 150                 href = util.getUrl( 'Foo:Sandbox? 5+5=10! (test)/sub ' );
 151                 assert.equal( href, '/wiki/Foo:Sandbox%3F_5%2B5%3D10!_(test)/sub_', 'complex title' );
 152
 153                 // T149767
 154                 href = util.getUrl( 'My$$test$$$$$title' );
 155                 assert.equal( href, '/wiki/My$$test$$$$$title', 'title with multiple consecutive dollar signs' );
 156
 157                 href = util.getUrl();
 158                 assert.equal( href, '/wiki/Foobar', 'default title' );
 159
 160                 href = util.getUrl( null, { action: 'edit' } );
 161                 assert.equal( href, '/w/index.php?title=Foobar&action=edit', 'default title with query string' );
 162
 163                 href = util.getUrl( 'Sandbox', { action: 'edit' } );
 164                 assert.equal( href, '/w/index.php?title=Sandbox&action=edit', 'simple title with query string' );
 165
 166                 // Test fragments
 167                 href = util.getUrl( 'Foo:Sandbox#Fragment', { action: 'edit' } );
 168                 assert.equal( href, '/w/index.php?title=Foo:Sandbox&action=edit#Fragment', 'namespaced title with query string and fragment' );
 169
 170                 href = util.getUrl( 'Sandbox#', { action: 'edit' } );
 171                 assert.equal( href, '/w/index.php?title=Sandbox&action=edit', 'title with query string and empty fragment' );
 172
 173                 href = util.getUrl( 'Sandbox', {} );
 174                 assert.equal( href, '/wiki/Sandbox', 'title with empty query string' );
 175
 176                 href = util.getUrl( '#Fragment' );
 177                 assert.equal( href, '/wiki/#Fragment', 'empty title with fragment' );
 178
 179                 href = util.getUrl( '#Fragment', { action: 'edit' } );
 180                 assert.equal( href, '/w/index.php?action=edit#Fragment', 'epmty title with query string and fragment' );
 181
 182                 href = util.getUrl( 'Foo:Sandbox \xC4#Fragment \xC4', { action: 'edit' } );
 183                 assert.equal( href, '/w/index.php?title=Foo:Sandbox_%C3%84&action=edit#Fragment_.C3.84', 'title with query string, fragment, and special characters' );
 184
 185                 href = util.getUrl( 'Foo:%23#Fragment', { action: 'edit' } );
 186                 assert.equal( href, '/w/index.php?title=Foo:%2523&action=edit#Fragment', 'title containing %23 (#), fragment, and a query string' );
 187
 188                 href = util.getUrl( '#+&=:;@$-_.!*/[]<>\'§', { action: 'edit' } );
 189                 assert.equal( 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' );
 190         } );
 191
 192         QUnit.test( 'wikiScript', function ( assert ) {
 193                 mw.config.set( {
 194                         // customized wgScript for T41103
 195                         wgScript: '/w/i.php',
 196                         // customized wgLoadScript for T41103
 197                         wgLoadScript: '/w/l.php',
 198                         wgScriptPath: '/w'
 199                 } );
 200
 201                 assert.equal( util.wikiScript(), mw.config.get( 'wgScript' ),
 202                         'wikiScript() returns wgScript'
 203                 );
 204                 assert.equal( util.wikiScript( 'index' ), mw.config.get( 'wgScript' ),
 205                         'wikiScript( index ) returns wgScript'
 206                 );
 207                 assert.equal( util.wikiScript( 'load' ), mw.config.get( 'wgLoadScript' ),
 208                         'wikiScript( load ) returns wgLoadScript'
 209                 );
 210                 assert.equal( util.wikiScript( 'api' ), '/w/api.php', 'API path' );
 211         } );
 212
 213         QUnit.test( 'addCSS', function ( assert ) {
 214                 var $el, style;
 215                 $el = $( '<div>' ).attr( 'id', 'mw-addcsstest' ).appendTo( '#qunit-fixture' );
 216
 217                 style = util.addCSS( '#mw-addcsstest { visibility: hidden; }' );
 218                 assert.equal( typeof style, 'object', 'addCSS returned an object' );
 219                 assert.strictEqual( style.disabled, false, 'property "disabled" is available and set to false' );
 220
 221                 assert.equal( $el.css( 'visibility' ), 'hidden', 'Added style properties are in effect' );
 222
 223                 // Clean up
 224                 $( style.ownerNode ).remove();
 225         } );
 226
 227         QUnit.test( 'getParamValue', function ( assert ) {
 228                 var url;
 229
 230                 url = 'http://example.org/?foo=wrong&foo=right#&foo=bad';
 231                 assert.equal( util.getParamValue( 'foo', url ), 'right', 'Use latest one, ignore hash' );
 232                 assert.strictEqual( util.getParamValue( 'bar', url ), null, 'Return null when not found' );
 233
 234                 url = 'http://example.org/#&foo=bad';
 235                 assert.strictEqual( util.getParamValue( 'foo', url ), null, 'Ignore hash if param is not in querystring but in hash (T29427)' );
 236
 237                 url = 'example.org?' + $.param( { TEST: 'a b+c' } );
 238                 assert.strictEqual( util.getParamValue( 'TEST', url ), 'a b+c', 'T32441: getParamValue must understand "+" encoding of space' );
 239
 240                 url = 'example.org?' + $.param( { TEST: 'a b+c d' } ); // check for sloppy code from r95332 :)
 241                 assert.strictEqual( util.getParamValue( 'TEST', url ), 'a b+c d', 'T32441: getParamValue must understand "+" encoding of space (multiple spaces)' );
 242         } );
 243
 244         QUnit.test( '$content', function ( assert ) {
 245                 assert.ok( util.$content instanceof jQuery, 'mw.util.$content instance of jQuery' );
 246                 assert.strictEqual( util.$content.length, 1, 'mw.util.$content must have length of 1' );
 247         } );
 248
 249         /**
 250          * Portlet names are prefixed with 'p-test' to avoid conflict with core
 251          * when running the test suite under a wiki page.
 252          * Previously, test elements where invisible to the selector since only
 253          * one element can have a given id.
 254          */
 255         QUnit.test( 'addPortletLink', function ( assert ) {
 256                 var pTestTb, pCustom, vectorTabs, tbRL, cuQuux, $cuQuux, tbMW, $tbMW, tbRLDM, caFoo,
 257                         addedAfter, tbRLDMnonexistentid, tbRLDMemptyjquery;
 258
 259                 pTestTb =
 260                         '<div class="portlet" id="p-test-tb">' +
 261                                 '<h3>Toolbox</h3>' +
 262                                 '<ul class="body"></ul>' +
 263                         '</div>';
 264                 pCustom =
 265                         '<div class="portlet" id="p-test-custom">' +
 266                                 '<h3>Views</h3>' +
 267                                 '<ul class="body">' +
 268                                         '<li id="c-foo"><a href="#">Foo</a></li>' +
 269                                         '<li id="c-barmenu">' +
 270                                                 '<ul>' +
 271                                                         '<li id="c-bar-baz"><a href="#">Baz</a></a>' +
 272                                                 '</ul>' +
 273                                         '</li>' +
 274                                 '</ul>' +
 275                         '</div>';
 276                 vectorTabs =
 277                         '<div id="p-test-views" class="vectorTabs">' +
 278                                 '<h3>Views</h3>' +
 279                                 '<ul></ul>' +
 280                         '</div>';
 281
 282                 $( '#qunit-fixture' ).append( pTestTb, pCustom, vectorTabs );
 283
 284                 tbRL = util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/ResourceLoader',
 285                         'ResourceLoader', 't-rl', 'More info about ResourceLoader on MediaWiki.org ', 'l'
 286                 );
 287
 288                 assert.ok( tbRL && tbRL.nodeType, 'addPortletLink returns a DOM Node' );
 289
 290                 tbMW = util.addPortletLink( 'p-test-tb', '//mediawiki.org/',
 291                         'MediaWiki.org', 't-mworg', 'Go to MediaWiki.org', 'm', tbRL );
 292                 $tbMW = $( tbMW );
 293
 294                 assert.propEqual(
 295                         $tbMW.getAttrs(),
 296                         {
 297                                 id: 't-mworg'
 298                         },
 299                         'Validate attributes of created element'
 300                 );
 301
 302                 assert.propEqual(
 303                         $tbMW.find( 'a' ).getAttrs(),
 304                         {
 305                                 href: '//mediawiki.org/',
 306                                 title: 'Go to MediaWiki.org [test-m]',
 307                                 accesskey: 'm'
 308                         },
 309                         'Validate attributes of anchor tag in created element'
 310                 );
 311
 312                 assert.equal( $tbMW.closest( '.portlet' ).attr( 'id' ), 'p-test-tb', 'Link was inserted within correct portlet' );
 313                 assert.strictEqual( $tbMW.next()[ 0 ], tbRL, 'Link is in the correct position (nextnode as Node object)' );
 314
 315                 cuQuux = util.addPortletLink( 'p-test-custom', '#', 'Quux', null, 'Example [shift-x]', 'q' );
 316                 $cuQuux = $( cuQuux );
 317
 318                 assert.equal( $cuQuux.find( 'a' ).attr( 'title' ), 'Example [test-q]', 'Existing accesskey is stripped and updated' );
 319
 320                 assert.equal(
 321                         $( '#p-test-custom #c-barmenu ul li' ).length,
 322                         1,
 323                         'addPortletLink did not add the item to all <ul> elements in the portlet (T37082)'
 324                 );
 325
 326                 tbRLDM = util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/RL/DM',
 327                         'Default modules', 't-rldm', 'List of all default modules ', 'd', '#t-rl' );
 328
 329                 assert.strictEqual( $( tbRLDM ).next()[ 0 ], tbRL, 'Link is in the correct position (CSS selector as nextnode)' );
 330
 331                 caFoo = util.addPortletLink( 'p-test-views', '#', 'Foo' );
 332
 333                 assert.strictEqual( $tbMW.find( 'span' ).length, 0, 'No <span> element should be added for porlets without vectorTabs class.' );
 334                 assert.strictEqual( $( caFoo ).find( 'span' ).length, 1, 'A <span> element should be added for porlets with vectorTabs class.' );
 335
 336                 addedAfter = util.addPortletLink( 'p-test-tb', '#', 'After foo', 'post-foo', 'After foo', null, $( tbRL ) );
 337                 assert.strictEqual( $( addedAfter ).next()[ 0 ], tbRL, 'Link is in the correct position (jQuery object as nextnode)' );
 338
 339                 // test case - nonexistent id as next node
 340                 tbRLDMnonexistentid = util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/RL/DM',
 341                         'Default modules', 't-rldm-nonexistent', 'List of all default modules ', 'd', '#t-rl-nonexistent' );
 342
 343                 assert.equal( tbRLDMnonexistentid, $( '#p-test-tb li:last' )[ 0 ], 'Fallback to adding at the end (nextnode non-matching CSS selector)' );
 344
 345                 // test case - empty jquery object as next node
 346                 tbRLDMemptyjquery = util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/RL/DM',
 347                         'Default modules', 't-rldm-empty-jquery', 'List of all default modules ', 'd', $( '#t-rl-nonexistent' ) );
 348
 349                 assert.equal( tbRLDMemptyjquery, $( '#p-test-tb li:last' )[ 0 ], 'Fallback to adding at the end (nextnode as empty jQuery object)' );
 350         } );
 351
 352         QUnit.test( 'validateEmail', function ( assert ) {
 353                 assert.strictEqual( util.validateEmail( '' ), null, 'Should return null for empty string ' );
 354                 assert.strictEqual( util.validateEmail( 'user@localhost' ), true, 'Return true for a valid e-mail address' );
 355
 356                 // testEmailWithCommasAreInvalids
 357                 assert.strictEqual( util.validateEmail( 'user,foo@example.org' ), false, 'Emails with commas are invalid' );
 358                 assert.strictEqual( util.validateEmail( 'userfoo@ex,ample.org' ), false, 'Emails with commas are invalid' );
 359
 360                 // testEmailWithHyphens
 361                 assert.strictEqual( util.validateEmail( 'user-foo@example.org' ), true, 'Emails may contain a hyphen' );
 362                 assert.strictEqual( util.validateEmail( 'userfoo@ex-ample.org' ), true, 'Emails may contain a hyphen' );
 363         } );
 364
 365         QUnit.test( 'isIPv6Address', function ( assert ) {
 366                 $.each( IPV6_CASES, function ( i, ipCase ) {
 367                         assert.strictEqual( util.isIPv6Address( ipCase[ 1 ] ), ipCase[ 0 ], ipCase[ 2 ] );
 368                 } );
 369         } );
 370
 371         QUnit.test( 'isIPv4Address', function ( assert ) {
 372                 $.each( IPV4_CASES, function ( i, ipCase ) {
 373                         assert.strictEqual( util.isIPv4Address( ipCase[ 1 ] ), ipCase[ 0 ], ipCase[ 2 ] );
 374                 } );
 375         } );
 376
 377         QUnit.test( 'isIPAddress', function ( assert ) {
 378                 $.each( IPV4_CASES, function ( i, ipCase ) {
 379                         assert.strictEqual( util.isIPv4Address( ipCase[ 1 ] ), ipCase[ 0 ], ipCase[ 2 ] );
 380                 } );
 381
 382                 $.each( IPV6_CASES, function ( i, ipCase ) {
 383                         assert.strictEqual( util.isIPv6Address( ipCase[ 1 ] ), ipCase[ 0 ], ipCase[ 2 ] );
 384                 } );
 385         } );
 386 }( mediaWiki, jQuery ) );