path: root/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js

( function ( mw, $ ) {
	var mwLanguageCache = {}, oldGetOuterHtml, formatnumTests, specialCharactersPageName,
		expectedListUsers, expectedEntrypoints;

	QUnit.module( 'mediawiki.jqueryMsg', QUnit.newMwEnvironment( {
		setup: function () {
			this.orgMwLangauge = mw.language;
			mw.language = $.extend( true, {}, this.orgMwLangauge );
			oldGetOuterHtml = $.fn.getOuterHtml;
			$.fn.getOuterHtml = function () {
				var $div = $( '<div>' ), html;
				$div.append( $( this ).eq( 0 ).clone() );
				html = $div.html();
				$div.empty();
				$div = undefined;
				return html;
			};

			// 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]'
			} );

			specialCharactersPageName = '"Who" wants to be a millionaire & live on \'Exotic Island\'?';

			expectedListUsers = '注册' + $( '<a>' ).attr( {
				title: 'Special:ListUsers',
				href: mw.util.wikiGetlink( 'Special:ListUsers' )
			} ).text( '用户' ).getOuterHtml();

			expectedEntrypoints = '<a href="https://www.mediawiki.org/wiki/Manual:index.php">index.php</a>';
		},
		teardown: function () {
			mw.language = this.orgMwLangauge;
			$.fn.getOuterHtml = oldGetOuterHtml;
		}
	} ) );

	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 ) {
		var parser = mw.jqueryMsg.getMessageFunction();

		mw.messages.set( 'simple', 'Foo $1 baz $2' );

		assert.equal( parser( 'simple' ), 'Foo $1 baz $2', 'Replacements with no substitutes' );
		assert.equal( parser( 'simple', 'bar' ), 'Foo bar baz $2', 'Replacements with less substitutes' );
		assert.equal( parser( 'simple', 'bar', 'quux' ), 'Foo bar baz quux', 'Replacements with all substitutes' );

		mw.messages.set( 'plain-input', '<foo foo="foo">x$1y&lt;</foo>z' );

		assert.equal(
			parser( 'plain-input', 'bar' ),
			'&lt;foo foo="foo"&gt;xbary&amp;lt;&lt;/foo&gt;z',
			'Input is not considered html'
		);

		mw.messages.set( 'plain-replace', 'Foo $1' );

		assert.equal(
			parser( 'plain-replace', '<bar bar="bar">&gt;</bar>' ),
			'Foo &lt;bar bar="bar"&gt;&amp;gt;&lt;/bar&gt;',
			'Replacement is not considered html'
		);

		mw.messages.set( 'object-replace', 'Foo $1' );

		assert.equal(
			parser( 'object-replace', $( '<div class="bar">&gt;</div>' ) ),
			'Foo <div class="bar">&gt;</div>',
			'jQuery objects are preserved as raw html'
		);

		assert.equal(
			parser( 'object-replace', $( '<div class="bar">&gt;</div>' ).get( 0 ) ),
			'Foo <div class="bar">&gt;</div>',
			'HTMLElement objects are preserved as raw html'
		);

		assert.equal(
			parser( 'object-replace', $( '<div class="bar">&gt;</div>' ).toArray() ),
			'Foo <div class="bar">&gt;</div>',
			'HTMLElement[] arrays are preserved as raw html'
		);

		assert.equal(
			parser( 'external-link-replace', 'http://example.org/?x=y&z' ),
			'Foo <a href="http://example.org/?x=y&amp;z">bar</a>',
			'Href is not double-escaped in wikilink function'
		);
	} );

	QUnit.test( 'Plural', 3, function ( assert ) {
		var parser = mw.jqueryMsg.getMessageFunction();

		assert.equal( parser( 'plural-msg', 0 ), 'Found 0 items', 'Plural test for english with zero as count' );
		assert.equal( parser( 'plural-msg', 1 ), 'Found 1 item', 'Singular test for english' );
		assert.equal( parser( '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,
			parser = mw.jqueryMsg.getMessageFunction();

		user.options.set( 'gender', 'male' );
		assert.equal(
			parser( 'gender-msg', 'Bob', 'male' ),
			'Bob: blue',
			'Masculine from string "male"'
		);
		assert.equal(
			parser( 'gender-msg', 'Bob', user ),
			'Bob: blue',
			'Masculine from mw.user object'
		);

		user.options.set( 'gender', 'unknown' );
		assert.equal(
			parser( 'gender-msg', 'Foo', user ),
			'Foo: green',
			'Neutral from mw.user object' );
		assert.equal(
			parser( 'gender-msg', 'Alice', 'female' ),
			'Alice: pink',
			'Feminine from string "female"' );
		assert.equal(
			parser( 'gender-msg', 'User' ),
			'User: green',
			'Neutral when no parameter given' );
		assert.equal(
			parser( '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(
			parser( 'gender-msg-one-form', 'male', 10 ),
			'User: 10 edits',
			'Gender neutral and plural form'
		);
		assert.equal(
			parser( '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(
			parser( 'gender-msg-lowercase', 'male' ),
			'he is awesome',
			'Gender masculine'
		);
		assert.equal(
			parser( 'gender-msg-lowercase', 'female' ),
			'she is awesome',
			'Gender feminine'
		);

		mw.messages.set( 'gender-msg-wrong', '{{gender}} test' );
		assert.equal(
			parser( 'gender-msg-wrong', 'female' ),
			' test',
			'Invalid syntax should result in {{gender}} simply being stripped away'
		);
	} );

	QUnit.test( 'Grammar', 2, function ( assert ) {
		var parser = mw.jqueryMsg.getMessageFunction();

		assert.equal( parser( '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( parser( '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 parser = mw.jqueryMsg.getMessageFunction(),
			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.equal(
			parser( '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 ' +
			$( '<a>' ).attr( {
				title: 'MediaWiki:Disambiguationspage',
				href: mw.util.wikiGetlink( 'MediaWiki:Disambiguationspage' )
			} ).text( 'MediaWiki:Disambiguationspage' ).getOuterHtml() + '.';
		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.equal(
			parser( 'disambiguations-text' ),
			expectedDisambiguationsText,
			'Wikilink without pipe'
		);

		assert.equal(
			parser( '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(
			parser( 'pipe-trick' ),
			'pipe-trick: Parse error at position 0 in input: [[Tampa, Florida|]]',
			'Pipe trick should return error string.'
		);

		expectedMultipleBars = $( '<a>' ).attr( {
			title: 'Main Page',
			href: mw.util.wikiGetlink( 'Main Page' )
		} ).text( 'Main|Page' ).getOuterHtml();
		mw.messages.set( 'multiple-bars', '[[Main Page|Main|Page]]' );
		assert.equal(
			parser( 'multiple-bars' ),
			expectedMultipleBars,
			'Bar in anchor'
		);

		expectedSpecialCharacters = $( '<a>' ).attr( {
			title: specialCharactersPageName,
			href: mw.util.wikiGetlink( specialCharactersPageName )
		} ).text( specialCharactersPageName ).getOuterHtml();

		mw.messages.set( 'special-characters', '[[' + specialCharactersPageName + ']]' );
		assert.equal(
			parser( 'special-characters' ),
			expectedSpecialCharacters,
			'Special characters'
		);
	} );

// Tests that {{-transformation vs. general parsing are done as requested
	QUnit.test( 'Curly brace transformation', 14, function ( assert ) {
		var formatText, formatParse, oldUserLang;

		oldUserLang = mw.config.get( 'wgUserLanguage' );

		formatText = mw.jqueryMsg.getMessageFunction( {
			format: 'text'
		} );

		formatParse = mw.jqueryMsg.getMessageFunction( {
			format: 'parse'
		} );

		// When the expected result is the same in both modes
		function assertBothModes( 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\'' );
		}

		assertBothModes( ['gender-msg', 'Bob', 'male'], 'Bob: blue', 'gender is resolved' );

		assertBothModes( ['plural-msg', 5], 'Found 5 items', 'plural is resolved' );

		assertBothModes( ['grammar-msg'], 'Przeszukaj ' + mw.config.get( 'wgSiteName' ), 'grammar is resolved' );

		mw.config.set( 'wgUserLanguage', 'en' );
		assertBothModes( ['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.equal(
			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.equal(
			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.equal(
			formatParse( 'external-link-replace', 'http://example.com' ),
			'Foo <a href="http://example.com">bar</a>',
			'External link message processed when format is \'parse\''
		);

		mw.config.set( 'wgUserLanguage', oldUserLang );
	} );

	QUnit.test( 'Int', 4, function ( assert ) {
		var parser = mw.jqueryMsg.getMessageFunction(),
			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;

		mw.messages.set( 'helppage', 'Help:Contents' );

		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 ' +
			$( '<a>' ).attr( {
				title: mw.msg( 'helppage' ),
				href: mw.util.wikiGetlink( mw.msg( 'helppage' ) )
			} ).text( 'help page' ).getOuterHtml() + ' for more info). If you are here by mistake, click your browser\'s back button.';

		mw.messages.set( 'newarticletext', newarticletextSource );

		assert.equal(
			parser( 'newarticletext' ),
			expectedNewarticletext,
			'Link with nested message'
		);

		assert.equal(
			parser( '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.equal(
			parser( 'newarticletext-lowercase' ),
			expectedNewarticletext,
			'Link with nested message, lowercase include'
		);

		mw.messages.set( 'uses-missing-int', '{{int:doesnt-exist}}' );

		assert.equal(
			parser( '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
			);
		} );
	} );
} );

}( mediaWiki, jQuery ) );