( function ( mw, $ ) { var mwLanguageCache = {}, formatText, formatParse, formatnumTests, specialCharactersPageName, expectedListUsers, expectedEntrypoints; // When the expected result is the same in both modes function assertBothModes( assert, parserArguments, expectedResult, assertMessage ) { assert.equal( formatText.apply( null, parserArguments ), expectedResult, assertMessage + ' when format is \'text\'' ); assert.equal( formatParse.apply( null, parserArguments ), expectedResult, assertMessage + ' when format is \'parse\'' ); } QUnit.module( 'mediawiki.jqueryMsg', QUnit.newMwEnvironment( { setup: function () { this.orgMwLangauge = mw.language; mw.language = $.extend( true, {}, this.orgMwLangauge ); // Messages that are reused in multiple tests mw.messages.set( { // The values for gender are not significant, // what matters is which of the values is choosen by the parser 'gender-msg': '$1: {{GENDER:$2|blue|pink|green}}', 'plural-msg': 'Found $1 {{PLURAL:$1|item|items}}', // Assume the grammar form grammar_case_foo is not valid in any language 'grammar-msg': 'Przeszukaj {{GRAMMAR:grammar_case_foo|{{SITENAME}}}}', 'formatnum-msg': '{{formatnum:$1}}', 'portal-url': 'Project:Community portal', 'see-portal-url': '{{Int:portal-url}} is an important community page.', 'jquerymsg-test-statistics-users': '注册[[Special:ListUsers|用户]]', 'jquerymsg-test-version-entrypoints-index-php': '[https://www.mediawiki.org/wiki/Manual:index.php index.php]', 'external-link-replace': 'Foo [$1 bar]' } ); mw.config.set( { wgArticlePath: '/wiki/$1' } ); specialCharactersPageName = '"Who" wants to be a millionaire & live on \'Exotic Island\'?'; expectedListUsers = '注册用户'; expectedEntrypoints = 'index.php'; formatText = mw.jqueryMsg.getMessageFunction( { format: 'text' } ); formatParse = mw.jqueryMsg.getMessageFunction( { format: 'parse' } ); }, teardown: function () { mw.language = this.orgMwLangauge; } } ) ); function getMwLanguage( langCode, cb ) { if ( mwLanguageCache[langCode] !== undefined ) { mwLanguageCache[langCode].add( cb ); return; } mwLanguageCache[langCode] = $.Callbacks( 'once memory' ); mwLanguageCache[langCode].add( cb ); $.ajax( { url: mw.util.wikiScript( 'load' ), data: { skin: mw.config.get( 'skin' ), lang: langCode, debug: mw.config.get( 'debug' ), modules: [ 'mediawiki.language.data', 'mediawiki.language' ].join( '|' ), only: 'scripts' }, dataType: 'script' } ).done(function () { mwLanguageCache[langCode].fire( mw.language ); } ).fail( function () { mwLanguageCache[langCode].fire( false ); } ); } QUnit.test( 'Replace', 9, function ( assert ) { mw.messages.set( 'simple', 'Foo $1 baz $2' ); assert.equal( formatParse( 'simple' ), 'Foo $1 baz $2', 'Replacements with no substitutes' ); assert.equal( formatParse( 'simple', 'bar' ), 'Foo bar baz $2', 'Replacements with less substitutes' ); assert.equal( formatParse( 'simple', 'bar', 'quux' ), 'Foo bar baz quux', 'Replacements with all substitutes' ); mw.messages.set( 'plain-input', 'x$1y<z' ); assert.equal( formatParse( 'plain-input', 'bar' ), '<foo foo="foo">xbary&lt;</foo>z', 'Input is not considered html' ); mw.messages.set( 'plain-replace', 'Foo $1' ); assert.equal( formatParse( 'plain-replace', '>' ), 'Foo <bar bar="bar">&gt;</bar>', 'Replacement is not considered html' ); mw.messages.set( 'object-replace', 'Foo $1' ); assert.equal( formatParse( 'object-replace', $( '
>
' ) ), 'Foo
>
', 'jQuery objects are preserved as raw html' ); assert.equal( formatParse( 'object-replace', $( '
>
' ).get( 0 ) ), 'Foo
>
', 'HTMLElement objects are preserved as raw html' ); assert.equal( formatParse( 'object-replace', $( '
>
' ).toArray() ), 'Foo
>
', 'HTMLElement[] arrays are preserved as raw html' ); assert.equal( formatParse( 'external-link-replace', 'http://example.org/?x=y&z' ), 'Foo bar', 'Href is not double-escaped in wikilink function' ); } ); QUnit.test( 'Plural', 3, function ( assert ) { assert.equal( formatParse( 'plural-msg', 0 ), 'Found 0 items', 'Plural test for english with zero as count' ); assert.equal( formatParse( 'plural-msg', 1 ), 'Found 1 item', 'Singular test for english' ); assert.equal( formatParse( 'plural-msg', 2 ), 'Found 2 items', 'Plural test for english' ); } ); QUnit.test( 'Gender', 11, function ( assert ) { // TODO: These tests should be for mw.msg once mw.msg integrated with mw.jqueryMsg // TODO: English may not be the best language for these tests. Use a language like Arabic or Russian var user = mw.user; user.options.set( 'gender', 'male' ); assert.equal( formatParse( 'gender-msg', 'Bob', 'male' ), 'Bob: blue', 'Masculine from string "male"' ); assert.equal( formatParse( 'gender-msg', 'Bob', user ), 'Bob: blue', 'Masculine from mw.user object' ); user.options.set( 'gender', 'unknown' ); assert.equal( formatParse( 'gender-msg', 'Foo', user ), 'Foo: green', 'Neutral from mw.user object' ); assert.equal( formatParse( 'gender-msg', 'Alice', 'female' ), 'Alice: pink', 'Feminine from string "female"' ); assert.equal( formatParse( 'gender-msg', 'User' ), 'User: green', 'Neutral when no parameter given' ); assert.equal( formatParse( 'gender-msg', 'User', 'unknown' ), 'User: green', 'Neutral from string "unknown"' ); mw.messages.set( 'gender-msg-one-form', '{{GENDER:$1|User}}: $2 {{PLURAL:$2|edit|edits}}' ); assert.equal( formatParse( 'gender-msg-one-form', 'male', 10 ), 'User: 10 edits', 'Gender neutral and plural form' ); assert.equal( formatParse( 'gender-msg-one-form', 'female', 1 ), 'User: 1 edit', 'Gender neutral and singular form' ); mw.messages.set( 'gender-msg-lowercase', '{{gender:$1|he|she}} is awesome' ); assert.equal( formatParse( 'gender-msg-lowercase', 'male' ), 'he is awesome', 'Gender masculine' ); assert.equal( formatParse( 'gender-msg-lowercase', 'female' ), 'she is awesome', 'Gender feminine' ); mw.messages.set( 'gender-msg-wrong', '{{gender}} test' ); assert.equal( formatParse( 'gender-msg-wrong', 'female' ), ' test', 'Invalid syntax should result in {{gender}} simply being stripped away' ); } ); QUnit.test( 'Grammar', 2, function ( assert ) { assert.equal( formatParse( 'grammar-msg' ), 'Przeszukaj ' + mw.config.get( 'wgSiteName' ), 'Grammar Test with sitename' ); mw.messages.set( 'grammar-msg-wrong-syntax', 'Przeszukaj {{GRAMMAR:grammar_case_xyz}}' ); assert.equal( formatParse( 'grammar-msg-wrong-syntax' ), 'Przeszukaj ', 'Grammar Test with wrong grammar template syntax' ); } ); QUnit.test( 'Match PHP parser', mw.libs.phpParserData.tests.length, function ( assert ) { mw.messages.set( mw.libs.phpParserData.messages ); $.each( mw.libs.phpParserData.tests, function ( i, test ) { QUnit.stop(); getMwLanguage( test.lang, function ( langClass ) { QUnit.start(); if ( !langClass ) { assert.ok( false, 'Language "' + test.lang + '" failed to load' ); return; } mw.config.set( 'wgUserLanguage', test.lang ); var parser = new mw.jqueryMsg.parser( { language: langClass } ); assert.equal( parser.parse( test.key, test.args ).html(), test.result, test.name ); } ); } ); } ); QUnit.test( 'Links', 6, function ( assert ) { var expectedDisambiguationsText, expectedMultipleBars, expectedSpecialCharacters; /* The below three are all identical to or based on real messages. For disambiguations-text, the bold was removed because it is not yet implemented. */ assert.htmlEqual( formatParse( 'jquerymsg-test-statistics-users' ), expectedListUsers, 'Piped wikilink' ); expectedDisambiguationsText = 'The following pages contain at least one link to a disambiguation page.\nThey may have to link to a more appropriate page instead.\nA page is treated as a disambiguation page if it uses a template that is linked from ' + 'MediaWiki:Disambiguationspage.'; mw.messages.set( 'disambiguations-text', 'The following pages contain at least one link to a disambiguation page.\nThey may have to link to a more appropriate page instead.\nA page is treated as a disambiguation page if it uses a template that is linked from [[MediaWiki:Disambiguationspage]].' ); assert.htmlEqual( formatParse( 'disambiguations-text' ), expectedDisambiguationsText, 'Wikilink without pipe' ); assert.htmlEqual( formatParse( 'jquerymsg-test-version-entrypoints-index-php' ), expectedEntrypoints, 'External link' ); // Pipe trick is not supported currently, but should not parse as text either. mw.messages.set( 'pipe-trick', '[[Tampa, Florida|]]' ); assert.equal( formatParse( 'pipe-trick' ), 'pipe-trick: Parse error at position 0 in input: [[Tampa, Florida|]]', 'Pipe trick should return error string.' ); expectedMultipleBars = 'Main|Page'; mw.messages.set( 'multiple-bars', '[[Main Page|Main|Page]]' ); assert.htmlEqual( formatParse( 'multiple-bars' ), expectedMultipleBars, 'Bar in anchor' ); expectedSpecialCharacters = '"Who" wants to be a millionaire & live on 'Exotic Island'?'; mw.messages.set( 'special-characters', '[[' + specialCharactersPageName + ']]' ); assert.htmlEqual( formatParse( 'special-characters' ), expectedSpecialCharacters, 'Special characters' ); } ); // Tests that {{-transformation vs. general parsing are done as requested QUnit.test( 'Curly brace transformation', 14, function ( assert ) { var oldUserLang = mw.config.get( 'wgUserLanguage' ); assertBothModes( assert, ['gender-msg', 'Bob', 'male'], 'Bob: blue', 'gender is resolved' ); assertBothModes( assert, ['plural-msg', 5], 'Found 5 items', 'plural is resolved' ); assertBothModes( assert, ['grammar-msg'], 'Przeszukaj ' + mw.config.get( 'wgSiteName' ), 'grammar is resolved' ); mw.config.set( 'wgUserLanguage', 'en' ); assertBothModes( assert, ['formatnum-msg', '987654321.654321'], '987,654,321.654', 'formatnum is resolved' ); // Test non-{{ wikitext, where behavior differs // Wikilink assert.equal( formatText( 'jquerymsg-test-statistics-users' ), mw.messages.get( 'jquerymsg-test-statistics-users' ), 'Internal link message unchanged when format is \'text\'' ); assert.htmlEqual( formatParse( 'jquerymsg-test-statistics-users' ), expectedListUsers, 'Internal link message parsed when format is \'parse\'' ); // External link assert.equal( formatText( 'jquerymsg-test-version-entrypoints-index-php' ), mw.messages.get( 'jquerymsg-test-version-entrypoints-index-php' ), 'External link message unchanged when format is \'text\'' ); assert.htmlEqual( formatParse( 'jquerymsg-test-version-entrypoints-index-php' ), expectedEntrypoints, 'External link message processed when format is \'parse\'' ); // External link with parameter assert.equal( formatText( 'external-link-replace', 'http://example.com' ), 'Foo [http://example.com bar]', 'External link message only substitutes parameter when format is \'text\'' ); assert.htmlEqual( formatParse( 'external-link-replace', 'http://example.com' ), 'Foo bar', 'External link message processed when format is \'parse\'' ); mw.config.set( 'wgUserLanguage', oldUserLang ); } ); QUnit.test( 'Int', 4, function ( assert ) { var newarticletextSource = 'You have followed a link to a page that does not exist yet. To create the page, start typing in the box below (see the [[{{Int:Helppage}}|help page]] for more info). If you are here by mistake, click your browser\'s back button.', expectedNewarticletext, helpPageTitle = 'Help:Contents'; mw.messages.set( 'helppage', helpPageTitle ); expectedNewarticletext = 'You have followed a link to a page that does not exist yet. To create the page, start typing in the box below (see the ' + 'help page for more info). If you are here by mistake, click your browser\'s back button.'; mw.messages.set( 'newarticletext', newarticletextSource ); assert.htmlEqual( formatParse( 'newarticletext' ), expectedNewarticletext, 'Link with nested message' ); assert.equal( formatParse( 'see-portal-url' ), 'Project:Community portal is an important community page.', 'Nested message' ); mw.messages.set( 'newarticletext-lowercase', newarticletextSource.replace( 'Int:Helppage', 'int:helppage' ) ); assert.htmlEqual( formatParse( 'newarticletext-lowercase' ), expectedNewarticletext, 'Link with nested message, lowercase include' ); mw.messages.set( 'uses-missing-int', '{{int:doesnt-exist}}' ); assert.equal( formatParse( 'uses-missing-int' ), '[doesnt-exist]', 'int: where nested message does not exist' ); } ); // Tests that getMessageFunction is used for non-plain messages with curly braces or // square brackets, but not otherwise. QUnit.test( 'mw.Message.prototype.parser monkey-patch', 22, function ( assert ) { var oldGMF, outerCalled, innerCalled; mw.messages.set( { 'curly-brace': '{{int:message}}', 'single-square-bracket': '[https://www.mediawiki.org/ MediaWiki]', 'double-square-bracket': '[[Some page]]', 'regular': 'Other message' } ); oldGMF = mw.jqueryMsg.getMessageFunction; mw.jqueryMsg.getMessageFunction = function () { outerCalled = true; return function () { innerCalled = true; }; }; function verifyGetMessageFunction( key, format, shouldCall ) { var message; outerCalled = false; innerCalled = false; message = mw.message( key ); message[format](); assert.strictEqual( outerCalled, shouldCall, 'Outer function called for ' + key ); assert.strictEqual( innerCalled, shouldCall, 'Inner function called for ' + key ); } verifyGetMessageFunction( 'curly-brace', 'parse', true ); verifyGetMessageFunction( 'curly-brace', 'plain', false ); verifyGetMessageFunction( 'single-square-bracket', 'parse', true ); verifyGetMessageFunction( 'single-square-bracket', 'plain', false ); verifyGetMessageFunction( 'double-square-bracket', 'parse', true ); verifyGetMessageFunction( 'double-square-bracket', 'plain', false ); verifyGetMessageFunction( 'regular', 'parse', false ); verifyGetMessageFunction( 'regular', 'plain', false ); verifyGetMessageFunction( 'jquerymsg-test-pagetriage-del-talk-page-notify-summary', 'plain', false ); verifyGetMessageFunction( 'jquerymsg-test-categorytree-collapse-bullet', 'plain', false ); verifyGetMessageFunction( 'jquerymsg-test-wikieditor-toolbar-help-content-signature-result', 'plain', false ); mw.jqueryMsg.getMessageFunction = oldGMF; } ); formatnumTests = [ { lang: 'en', number: 987654321.654321, result: '987,654,321.654', description: 'formatnum test for English, decimal seperator' }, { lang: 'ar', number: 987654321.654321, result: '٩٨٧٬٦٥٤٬٣٢١٫٦٥٤', description: 'formatnum test for Arabic, with decimal seperator' }, { lang: 'ar', number: '٩٨٧٦٥٤٣٢١٫٦٥٤٣٢١', result: 987654321, integer: true, description: 'formatnum test for Arabic, with decimal seperator, reverse' }, { lang: 'ar', number: -12.89, result: '-١٢٫٨٩', description: 'formatnum test for Arabic, negative number' }, { lang: 'ar', number: '-١٢٫٨٩', result: -12, integer: true, description: 'formatnum test for Arabic, negative number, reverse' }, { lang: 'nl', number: 987654321.654321, result: '987.654.321,654', description: 'formatnum test for Nederlands, decimal seperator' }, { lang: 'nl', number: -12.89, result: '-12,89', description: 'formatnum test for Nederlands, negative number' }, { lang: 'nl', number: '.89', result: '0,89', description: 'formatnum test for Nederlands' }, { lang: 'nl', number: 'invalidnumber', result: 'invalidnumber', description: 'formatnum test for Nederlands, invalid number' }, { lang: 'ml', number: '1000000000', result: '1,00,00,00,000', description: 'formatnum test for Malayalam' }, { lang: 'ml', number: '-1000000000', result: '-1,00,00,00,000', description: 'formatnum test for Malayalam, negative number' }, /* * This will fail because of wrong pattern for ml in MW(different from CLDR) { lang: 'ml', number: '1000000000.000', result: '1,00,00,00,000.000', description: 'formatnum test for Malayalam with decimal place' }, */ { lang: 'hi', number: '123456789.123456789', result: '१२,३४,५६,७८९', description: 'formatnum test for Hindi' }, { lang: 'hi', number: '१२,३४,५६,७८९', result: '१२,३४,५६,७८९', description: 'formatnum test for Hindi, Devanagari digits passed' }, { lang: 'hi', number: '१२३४५६,७८९', result: '123456', integer: true, description: 'formatnum test for Hindi, Devanagari digits passed to get integer value' } ]; QUnit.test( 'formatnum', formatnumTests.length, function ( assert ) { mw.messages.set( 'formatnum-msg', '{{formatnum:$1}}' ); mw.messages.set( 'formatnum-msg-int', '{{formatnum:$1|R}}' ); $.each( formatnumTests, function ( i, test ) { QUnit.stop(); getMwLanguage( test.lang, function ( langClass ) { QUnit.start(); if ( !langClass ) { assert.ok( false, 'Language "' + test.lang + '" failed to load' ); return; } mw.messages.set(test.message ); mw.config.set( 'wgUserLanguage', test.lang ) ; var parser = new mw.jqueryMsg.parser( { language: langClass } ); assert.equal( parser.parse( test.integer ? 'formatnum-msg-int' : 'formatnum-msg', [ test.number ] ).html(), test.result, test.description ); } ); } ); } ); // HTML in wikitext QUnit.test( 'HTML', 26, function ( assert ) { mw.messages.set( 'jquerymsg-italics-msg', 'Very important' ); assertBothModes( assert, ['jquerymsg-italics-msg'], mw.messages.get( 'jquerymsg-italics-msg' ), 'Simple italics unchanged' ); mw.messages.set( 'jquerymsg-bold-msg', 'Strong speaker' ); assertBothModes( assert, ['jquerymsg-bold-msg'], mw.messages.get( 'jquerymsg-bold-msg' ), 'Simple bold unchanged' ); mw.messages.set( 'jquerymsg-bold-italics-msg', 'It is key' ); assertBothModes( assert, ['jquerymsg-bold-italics-msg'], mw.messages.get( 'jquerymsg-bold-italics-msg' ), 'Bold and italics nesting order preserved' ); mw.messages.set( 'jquerymsg-italics-bold-msg', 'It is vital' ); assertBothModes( assert, ['jquerymsg-italics-bold-msg'], mw.messages.get( 'jquerymsg-italics-bold-msg' ), 'Italics and bold nesting order preserved' ); mw.messages.set( 'jquerymsg-italics-with-link', 'An italicized [[link|wiki-link]]' ); assert.htmlEqual( formatParse( 'jquerymsg-italics-with-link' ), 'An italicized wiki-link', 'Italics with link inside in parse mode' ); assert.equal( formatText( 'jquerymsg-italics-with-link' ), mw.messages.get( 'jquerymsg-italics-with-link' ), 'Italics with link unchanged in text mode' ); mw.messages.set( 'jquerymsg-italics-id-class', 'Foo' ); assert.htmlEqual( formatParse( 'jquerymsg-italics-id-class' ), mw.messages.get( 'jquerymsg-italics-id-class' ), 'ID and class are allowed' ); mw.messages.set( 'jquerymsg-italics-onclick', 'Foo' ); assert.htmlEqual( formatParse( 'jquerymsg-italics-onclick' ), '<i onclick="alert(\'foo\')">Foo</i>', 'element with onclick is escaped because it is not allowed' ); mw.messages.set( 'jquerymsg-script-msg', '' ); assert.htmlEqual( formatParse( 'jquerymsg-script-msg' ), '<script >alert( "Who put this tag here?" );</script>', 'Tag outside whitelist escaped in parse mode' ); assert.equal( formatText( 'jquerymsg-script-msg' ), mw.messages.get( 'jquerymsg-script-msg' ), 'Tag outside whitelist unchanged in text mode' ); mw.messages.set( 'jquerymsg-script-link-msg', '' ); assert.htmlEqual( formatParse( 'jquerymsg-script-link-msg' ), '<script>bar</script>', 'Script tag text is escaped because that element is not allowed, but link inside is still HTML' ); mw.messages.set( 'jquerymsg-mismatched-html', 'test' ); assert.htmlEqual( formatParse( 'jquerymsg-mismatched-html' ), '<i class="important">test</b>', 'Mismatched HTML start and end tag treated as text' ); // TODO (mattflaschen, 2013-03-18): It's not a security issue, but there's no real // reason the htmlEmitter span needs to be here. It's an artifact of how emitting works. mw.messages.set( 'jquerymsg-script-and-external-link', ' [http://example.com Foo bar]' ); assert.htmlEqual( formatParse( 'jquerymsg-script-and-external-link' ), '<script>alert( "jquerymsg-script-and-external-link test" );</script> Foo bar', 'HTML tags in external links not interfering with escaping of other tags' ); mw.messages.set( 'jquerymsg-link-script', '[http://example.com ]' ); assert.htmlEqual( formatParse( 'jquerymsg-link-script' ), '<script>alert( "jquerymsg-link-script test" );</script>', 'Non-whitelisted HTML tag in external link anchor treated as text' ); // Intentionally not using htmlEqual for the quote tests mw.messages.set( 'jquerymsg-double-quotes-preserved', 'Double' ); assert.equal( formatParse( 'jquerymsg-double-quotes-preserved' ), mw.messages.get( 'jquerymsg-double-quotes-preserved' ), 'Attributes with double quotes are preserved as such' ); mw.messages.set( 'jquerymsg-single-quotes-normalized-to-double', 'Single' ); assert.equal( formatParse( 'jquerymsg-single-quotes-normalized-to-double' ), 'Single', 'Attributes with single quotes are normalized to double' ); mw.messages.set( 'jquerymsg-escaped-double-quotes-attribute', 'Styled' ); assert.htmlEqual( formatParse( 'jquerymsg-escaped-double-quotes-attribute' ), mw.messages.get( 'jquerymsg-escaped-double-quotes-attribute' ), 'Escaped attributes are parsed correctly' ); mw.messages.set( 'jquerymsg-escaped-single-quotes-attribute', 'Styled' ); assert.htmlEqual( formatParse( 'jquerymsg-escaped-single-quotes-attribute' ), mw.messages.get( 'jquerymsg-escaped-single-quotes-attribute' ), 'Escaped attributes are parsed correctly' ); mw.messages.set( 'jquerymsg-wikitext-contents-parsed', '[http://example.com Example]' ); assert.htmlEqual( formatParse( 'jquerymsg-wikitext-contents-parsed' ), 'Example', 'Contents of valid tag are treated as wikitext, so external link is parsed' ); mw.messages.set( 'jquerymsg-wikitext-contents-script', '' ); assert.htmlEqual( formatParse( 'jquerymsg-wikitext-contents-script' ), '<script>Script inside</script>', 'Contents of valid tag are treated as wikitext, so invalid HTML element is treated as text' ); mw.messages.set( 'jquerymsg-unclosed-tag', 'Foobar' ); assert.htmlEqual( formatParse( 'jquerymsg-unclosed-tag' ), 'Foo<tag>bar', 'Nonsupported unclosed tags are escaped' ); mw.messages.set( 'jquerymsg-self-closing-tag', 'Foobar' ); assert.htmlEqual( formatParse( 'jquerymsg-self-closing-tag' ), 'Foo<tag/>bar', 'Self-closing tags don\'t cause a parse error' ); } ); }( mediaWiki, jQuery ) );