i18n.ts 35.0 KB
Newer Older
D
Dirk Baeumer 已提交
1 2 3 4 5 6 7 8
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import * as path from 'path';
import * as fs from 'fs';

9
import { through, readable } from 'event-stream';
D
Dirk Baeumer 已提交
10 11 12
import { ThroughStream } from 'through';
import File = require('vinyl');
import * as Is from 'is';
13
import * as xml2js from 'xml2js';
14
import * as glob from 'glob';
15
import * as http from 'http';
D
Dirk Baeumer 已提交
16 17

var util = require('gulp-util');
18
var iconv  = require('iconv-lite');
J
Joao Moreno 已提交
19

D
Dirk Baeumer 已提交
20
function log(message: any, ...rest: any[]): void {
J
Joao Moreno 已提交
21
	util.log(util.colors.green('[i18n]'), message, ...rest);
D
Dirk Baeumer 已提交
22 23 24 25 26 27
}

interface Map<V> {
	[key: string]: V;
}

28 29 30 31 32 33
interface Item {
	id: string;
	message: string;
	comment: string;
}

34
interface Resource {
35 36 37 38
	name: string;
	project: string;
}

D
Dirk Baeumer 已提交
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
interface LocalizeInfo {
	key: string;
	comment: string[];
}

module LocalizeInfo {
	export function is(value: any): value is LocalizeInfo {
		let candidate = value as LocalizeInfo;
		return Is.defined(candidate) && Is.string(candidate.key) && (Is.undef(candidate.comment) || (Is.array(candidate.comment) && candidate.comment.every(element => Is.string(element))));
	}
}

interface BundledFormat {
	keys: Map<(string | LocalizeInfo)[]>;
	messages: Map<string[]>;
	bundles: Map<string[]>;
}

module BundledFormat {
	export function is(value: any): value is BundledFormat {
		if (Is.undef(value)) {
			return false;
		}

		let candidate = value as BundledFormat;
		let length = Object.keys(value).length;

		return length === 3 && Is.defined(candidate.keys) && Is.defined(candidate.messages) && Is.defined(candidate.bundles);
	}
}

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
interface ValueFormat {
	message: string;
	comment: string[];
}

interface PackageJsonFormat {
	[key: string]: string | ValueFormat;
}

module PackageJsonFormat {
	export function is(value: any): value is PackageJsonFormat {
		if (Is.undef(value) || !Is.object(value)) {
			return false;
		}
		return Object.keys(value).every(key => {
			let element = value[key];
			return Is.string(element) || (Is.object(element) && Is.defined(element.message) && Is.defined(element.comment));
		});
	}
}

interface ModuleJsonFormat {
	messages: string[];
	keys: (string | LocalizeInfo)[];
}

module ModuleJsonFormat {
	export function is(value: any): value is ModuleJsonFormat {
		let candidate = value as ModuleJsonFormat;
		return Is.defined(candidate)
			&& Is.array(candidate.messages) && candidate.messages.every(message => Is.string(message))
			&& Is.array(candidate.keys) && candidate.keys.every(key => Is.string(key) || LocalizeInfo.is(key));
	}
}

export class Line {
	private buffer: string[] = [];

	constructor(private indent: number = 0) {
		if (indent > 0) {
			this.buffer.push(new Array(indent + 1).join(' '));
		}
	}

	public append(value: string): Line {
		this.buffer.push(value);
		return this;
	}

	public toString(): string {
		return this.buffer.join('');
	}
}

class TextModel {
	private _lines: string[];

	constructor(contents: string) {
		this._lines = contents.split(/\r\n|\r|\n/);
	}

	public get lines(): string[] {
		return this._lines;
	}
}

export class XLF {
    private buffer: string[];
	private files: Map<Item[]>;

    constructor(public project: string) {
        this.buffer = [];
		this.files = Object.create(null);
	}

    public toString(): string {
        this.appendHeader();

		for (let file in this.files) {
			this.appendNewLine(`<file original="${file}" source-language="en" datatype="plaintext"><body>`, 2);
			for (let item of this.files[file]) {
				this.addStringItem(item);
			}
       		this.appendNewLine('</body></file>', 2);
		}

		this.appendFooter();
		return this.buffer.join('\r\n');
	}

	public addFile(original: string, keys: any[], messages: string[]) {
		this.files[original] = [];
		let existingKeys = [];

		for (let key of keys) {
			// Ignore duplicate keys because Transifex does not populate those with translated values.
			if (existingKeys.indexOf(key) !== -1) {
				continue;
			}
			existingKeys.push(key);

			let message: string = encodeEntities(messages[keys.indexOf(key)]);
			let comment: string = undefined;

			// Check if the message contains description (if so, it becomes an object type in JSON)
			if (Is.string(key)) {
				this.files[original].push({ id: key, message: message, comment: comment });
			} else {
				if (key['comment'] && key['comment'].length > 0) {
					comment = key['comment'].map(comment => encodeEntities(comment)).join('\r\n');
				}

				this.files[original].push({ id: key['key'], message: message, comment: comment });
			}
		}
	}

    private addStringItem(item: Item): void {
        if (!item.id || !item.message) {
189
            throw new Error('No item ID or value specified.');
190 191 192
        }

        this.appendNewLine(`<trans-unit id="${item.id}">`, 4);
M
Michel Kaporin 已提交
193
        this.appendNewLine(`<source xml:lang="en">${item.message}</source>`, 6);
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268

        if (item.comment) {
            this.appendNewLine(`<note>${item.comment}</note>`, 6);
        }

        this.appendNewLine('</trans-unit>', 4);
	}

    private appendHeader(): void {
        this.appendNewLine('<?xml version="1.0" encoding="utf-8"?>', 0);
        this.appendNewLine('<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">', 0);
	}

    private appendFooter(): void {
        this.appendNewLine('</xliff>', 0);
    }

    private appendNewLine(content: string, indent?: number): void {
        let line = new Line(indent);
        line.append(content);
        this.buffer.push(line.toString());
    }

	static parse = function(xlfString: string) : Promise<{ messages: Map<string>,  originalFilePath: string, language: string }[]> {
		return new Promise((resolve, reject) => {
			let parser = new xml2js.Parser();

			let files: { messages: Map<string>, originalFilePath: string, language: string }[] = [];

			parser.parseString(xlfString, function(err, result) {
				if (err) {
					reject(`Failed to parse XLIFF string. ${err}`);
				}

				const fileNodes: any[] = result['xliff']['file'];
				if (!fileNodes) {
					reject('XLIFF file does not contain "xliff" or "file" node(s) required for parsing.');
				}

				fileNodes.forEach((file) => {
					const originalFilePath = file.$.original;
					if (!originalFilePath) {
						reject('XLIFF file node does not contain original attribute to determine the original location of the resource file.');
					}
					const language = file.$['target-language'].toLowerCase();
					if (!language) {
						reject('XLIFF file node does not contain target-language attribute to determine translated language.');
					}

					let messages: Map<string> = {};
					const transUnits = file.body[0]['trans-unit'];

					transUnits.forEach(unit => {
						const key = unit.$.id;
						if (!unit.target) {
							return; // No translation available
						}

						const val = unit.target.toString();
						if (key && val) {
							messages[key] = decodeEntities(val);
						} else {
							reject('XLIFF file does not contain full localization data. ID or target translation for one of the trans-unit nodes is not present.');
						}
					});

					files.push({ messages: messages, originalFilePath: originalFilePath, language: language });
				});

				resolve(files);
			});
		});
	};
}

D
Dirk Baeumer 已提交
269 270 271 272 273 274 275 276 277 278 279 280 281
const vscodeLanguages: string[] = [
	'chs',
	'cht',
	'jpn',
	'kor',
	'deu',
	'fra',
	'esn',
	'rus',
	'ita'
];

const iso639_3_to_2: Map<string> = {
282
	'chs': 'zh-cn',
283 284
	'cht': 'zh-tw',
	'csy': 'cs-cz',
D
Dirk Baeumer 已提交
285 286 287 288 289 290 291 292 293 294
	'deu': 'de',
	'enu': 'en',
	'esn': 'es',
	'fra': 'fr',
	'hun': 'hu',
	'ita': 'it',
	'jpn': 'ja',
	'kor': 'ko',
	'nld': 'nl',
	'plk': 'pl',
295
	'ptb': 'pt-br',
D
Dirk Baeumer 已提交
296 297
	'ptg': 'pt',
	'rus': 'ru',
298
	'sve': 'sv-se',
D
Dirk Baeumer 已提交
299 300 301
	'trk': 'tr'
};

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
const iso639_2_to_3: Map<string> = {
	'zh-cn': 'chs',
	'zh-tw': 'cht',
	'cs-cz': 'csy',
	'de': 'deu',
	'en': 'enu',
	'es': 'esn',
	'fr': 'fra',
	'hu': 'hun',
	'it': 'ita',
	'ja': 'jpn',
	'ko': 'kor',
	'nl': 'nld',
	'pl': 'plk',
	'pt-br': 'ptb',
	'pt': 'ptg',
	'ru': 'rus',
	'sv-se': 'sve',
	'tr': 'trk'
};
D
Dirk Baeumer 已提交
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
interface IDirectoryInfo {
	name: string;
	iso639_2: string;
}

function sortLanguages(directoryNames: string[]): IDirectoryInfo[] {
	return directoryNames.map((dirName) => {
		var lower = dirName.toLowerCase();
		return {
			name: lower,
			iso639_2: iso639_3_to_2[lower]
		};
	}).sort((a: IDirectoryInfo, b: IDirectoryInfo): number => {
		if (!a.iso639_2 && !b.iso639_2) {
			return 0;
		}
		if (!a.iso639_2) {
			return -1;
		}
		if (!b.iso639_2) {
			return 1;
		}
		return a.iso639_2 < b.iso639_2 ? -1 : (a.iso639_2 > b.iso639_2 ? 1 : 0);
	});
}

function stripComments(content: string): string {
	/**
	* First capturing group matches double quoted string
	* Second matches single quotes string
	* Third matches block comments
	* Fourth matches line comments
	*/
	var regexp: RegExp = /("(?:[^\\\"]*(?:\\.)?)*")|('(?:[^\\\']*(?:\\.)?)*')|(\/\*(?:\r?\n|.)*?\*\/)|(\/{2,}.*?(?:(?:\r?\n)|$))/g;
	let result = content.replace(regexp, (match, m1, m2, m3, m4) => {
		// Only one of m1, m2, m3, m4 matches
		if (m3) {
			// A block comment. Replace with nothing
			return '';
		} else if (m4) {
			// A line comment. If it ends in \r?\n then keep it.
			let length = m4.length;
			if (length > 2 && m4[length - 1] === '\n') {
				return m4[length - 2] === '\r' ? '\r\n': '\n';
			} else {
				return '';
			}
		} else {
			// We match a string
			return match;
		}
	});
	return result;
375
}
D
Dirk Baeumer 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412

function escapeCharacters(value:string):string {
	var result:string[] = [];
	for (var i = 0; i < value.length; i++) {
		var ch = value.charAt(i);
		switch(ch) {
			case '\'':
				result.push('\\\'');
				break;
			case '"':
				result.push('\\"');
				break;
			case '\\':
				result.push('\\\\');
				break;
			case '\n':
				result.push('\\n');
				break;
			case '\r':
				result.push('\\r');
				break;
			case '\t':
				result.push('\\t');
				break;
			case '\b':
				result.push('\\b');
				break;
			case '\f':
				result.push('\\f');
				break;
			default:
				result.push(ch);
		}
	}
	return result.join('');
}

A
Alex Dima 已提交
413
function processCoreBundleFormat(fileHeader:string, json: BundledFormat, emitter: any) {
D
Dirk Baeumer 已提交
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
	let keysSection = json.keys;
	let messageSection = json.messages;
	let bundleSection = json.bundles;

	let statistics: Map<number> = Object.create(null);

	let total: number = 0;
	let defaultMessages: Map<Map<string>> = Object.create(null);
	let modules = Object.keys(keysSection);
	modules.forEach((module) => {
		let keys = keysSection[module];
		let messages = messageSection[module];
		if (!messages || keys.length !== messages.length) {
			emitter.emit('error', `Message for module ${module} corrupted. Mismatch in number of keys and messages.`);
			return;
		}
		let messageMap: Map<string> = Object.create(null);
		defaultMessages[module] = messageMap;
		keys.map((key, i) => {
			total++;
			if (Is.string(key)) {
				messageMap[key] = messages[i];
			} else {
				messageMap[key.key] = messages[i];
			}
		});
	});

	let languageDirectory = path.join(__dirname, '..', '..', 'i18n');
	let languages = sortLanguages(fs.readdirSync(languageDirectory).filter((item) => fs.statSync(path.join(languageDirectory, item)).isDirectory()));
	languages.forEach((language) => {
		if (!language.iso639_2) {
			return;
		}

J
Joao Moreno 已提交
449 450 451 452
		if (process.env['VSCODE_BUILD_VERBOSE']) {
			log(`Generating nls bundles for: ${language.iso639_2}`);
		}

D
Dirk Baeumer 已提交
453 454 455 456 457 458 459 460 461 462 463
		statistics[language.iso639_2] = 0;
		let localizedModules: Map<string[]> = Object.create(null);
		let cwd = path.join(languageDirectory, language.name, 'src');
		modules.forEach((module) => {
			let order = keysSection[module];
			let i18nFile = path.join(cwd, module) + '.i18n.json';
			let messages: Map<string> = null;
			if (fs.existsSync(i18nFile)) {
				let content = stripComments(fs.readFileSync(i18nFile, 'utf8'));
				messages = JSON.parse(content);
			} else {
J
Joao Moreno 已提交
464 465 466
				if (process.env['VSCODE_BUILD_VERBOSE']) {
					log(`No localized messages found for module ${module}. Using default messages.`);
				}
D
Dirk Baeumer 已提交
467 468 469 470 471 472 473 474 475 476 477 478 479
				messages = defaultMessages[module];
				statistics[language.iso639_2] = statistics[language.iso639_2] + Object.keys(messages).length;
			}
			let localizedMessages: string[] = [];
			order.forEach((keyInfo) => {
				let key: string = null;
				if (Is.string(keyInfo)) {
					key = keyInfo;
				} else {
					key = keyInfo.key;
				}
				let message: string = messages[key];
				if (!message) {
J
Joao Moreno 已提交
480 481 482
					if (process.env['VSCODE_BUILD_VERBOSE']) {
						log(`No localized message found for key ${key} in module ${module}. Using default message.`);
					}
D
Dirk Baeumer 已提交
483 484 485 486 487 488 489 490 491 492
					message = defaultMessages[module][key];
					statistics[language.iso639_2] = statistics[language.iso639_2] + 1;
				}
				localizedMessages.push(message);
			});
			localizedModules[module] = localizedMessages;
		});
		Object.keys(bundleSection).forEach((bundle) => {
			let modules = bundleSection[bundle];
			let contents: string[] = [
A
Alex Dima 已提交
493
				fileHeader,
D
Dirk Baeumer 已提交
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
				`define("${bundle}.nls.${language.iso639_2}", {`
			];
			modules.forEach((module, index) => {
				contents.push(`\t"${module}": [`);
				let messages = localizedModules[module];
				if (!messages) {
					emitter.emit('error', `Didn't find messages for module ${module}.`);
					return;
				}
				messages.forEach((message, index) => {
					contents.push(`\t\t"${escapeCharacters(message)}${index < messages.length ? '",': '"'}`);
				});
				contents.push(index < modules.length - 1 ? '\t],' : '\t]');
			});
			contents.push('});');
509
			emitter.emit('data', new File( { path: bundle + '.nls.' + language.iso639_2 + '.js', contents: new Buffer(contents.join('\n'), 'utf-8') }));
D
Dirk Baeumer 已提交
510 511 512 513
		});
	});
	Object.keys(statistics).forEach(key => {
		let value = statistics[key];
J
Joao Moreno 已提交
514
		log(`${key} has ${value} untranslated strings.`);
D
Dirk Baeumer 已提交
515 516 517 518 519 520 521 522
	});
	vscodeLanguages.forEach(language => {
		let iso639_2 = iso639_3_to_2[language];
		if (!iso639_2) {
			log(`\tCouldn't find iso639 2 mapping for language ${language}. Using default language instead.`);
		} else {
			let stats = statistics[iso639_2];
			if (Is.undef(stats)) {
J
Joao Moreno 已提交
523
				log(`\tNo translations found for language ${language}. Using default language instead.`);
D
Dirk Baeumer 已提交
524 525 526 527 528
			}
		}
	});
}

A
Alex Dima 已提交
529
export function processNlsFiles(opts:{fileHeader:string;}): ThroughStream {
D
Dirk Baeumer 已提交
530 531 532 533 534
	return through(function(file: File) {
		let fileName = path.basename(file.path);
		if (fileName === 'nls.metadata.json') {
			let json = null;
			if (file.isBuffer()) {
535
				json = JSON.parse((<Buffer>file.contents).toString('utf8'));
D
Dirk Baeumer 已提交
536
			} else {
J
Joao Moreno 已提交
537
				this.emit('error', `Failed to read component file: ${file.relative}`);
D
Dirk Baeumer 已提交
538 539
			}
			if (BundledFormat.is(json)) {
A
Alex Dima 已提交
540
				processCoreBundleFormat(opts.fileHeader, json, this);
D
Dirk Baeumer 已提交
541 542 543 544
			}
		}
		this.emit('data', file);
	});
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
}

export function prepareXlfFiles(projectName?: string, extensionName?: string): ThroughStream {
	return through(
		function (file: File) {
			if (!file.isBuffer()) {
				log('Error', `Failed to read component file: ${file.relative}`);
			}

			const extension = path.extname(file.path);
			if (extension === '.json') {
				const json = JSON.parse((<Buffer>file.contents).toString('utf8'));

				if (BundledFormat.is(json)) {
					importBundleJson(file, json, this);
				} else if (PackageJsonFormat.is(json) || ModuleJsonFormat.is(json)) {
					importModuleOrPackageJson(file, json, projectName, this, extensionName);
				} else {
					log('Error', 'JSON format cannot be deduced.');
				}
			} else if (extension === '.isl') {
				importIsl(file, this);
			}
		}
	);
}

572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
const editorProject: string = 'vscode-editor',
	workbenchProject: string = 'vscode-workbench';

/**
 * Ensure to update this when new resources are pushed to Transifex.
 * Used because Transifex does not have API method to pull all project resources.
 */
const editorWorkbenchResources: Resource[] = [
	{ name: 'vs/platform', project: editorProject },
	{ name: 'vs/editor/contrib', project: editorProject },
	{ name: 'vs/editor', project: editorProject },
	{ name: 'vs/base', project: editorProject },
	{ name: 'vs/code', project: workbenchProject },
	{ name: 'vs/workbench', project: workbenchProject },
	{ name: 'vs/workbench/parts/cli', project: workbenchProject },
	{ name: 'vs/workbench/parts/codeEditor', project: workbenchProject },
	{ name: 'vs/workbench/parts/debug', project: workbenchProject },
	{ name: 'vs/workbench/parts/emmet', project: workbenchProject },
	{ name: 'vs/workbench/parts/execution', project: workbenchProject },
	{ name: 'vs/workbench/parts/explorers', project: workbenchProject },
	{ name: 'vs/workbench/parts/extensions', project: workbenchProject },
	{ name: 'vs/workbench/parts/feedback', project: workbenchProject },
	{ name: 'vs/workbench/parts/files', project: workbenchProject },
	{ name: 'vs/workbench/parts/git', project: workbenchProject },
	{ name: 'vs/workbench/parts/html', project: workbenchProject },
	{ name: 'vs/workbench/parts/markers', project: workbenchProject },
	{ name: 'vs/workbench/parts/nps', project: workbenchProject },
	{ name: 'vs/workbench/parts/output', project: workbenchProject },
	{ name: 'vs/workbench/parts/performance', project: workbenchProject },
	{ name: 'vs/workbench/parts/preferences', project: workbenchProject },
	{ name: 'vs/workbench/parts/quickopen', project: workbenchProject },
	{ name: 'vs/workbench/parts/scm', project: workbenchProject },
	{ name: 'vs/workbench/parts/search', project: workbenchProject },
	{ name: 'vs/workbench/parts/snippets', project: workbenchProject },
	{ name: 'vs/workbench/parts/tasks', project: workbenchProject },
	{ name: 'vs/workbench/parts/terminal', project: workbenchProject },
	{ name: 'vs/workbench/parts/themes', project: workbenchProject },
	{ name: 'vs/workbench/parts/trust', project: workbenchProject },
	{ name: 'vs/workbench/parts/update', project: workbenchProject },
	{ name: 'vs/workbench/parts/watermark', project: workbenchProject },
	{ name: 'vs/workbench/parts/welcome', project: workbenchProject },
	{ name: 'vs/workbench/services/configuration', project: workbenchProject },
	{ name: 'vs/workbench/services/editor', project: workbenchProject },
	{ name: 'vs/workbench/services/files', project: workbenchProject },
	{ name: 'vs/workbench/services/keybinding', project: workbenchProject },
	{ name: 'vs/workbench/services/message', project: workbenchProject },
	{ name: 'vs/workbench/services/mode', project: workbenchProject },
	{ name: 'vs/workbench/services/textfile', project: workbenchProject },
	{ name: 'vs/workbench/services/themes', project: workbenchProject },
	{ name: 'setup', project: workbenchProject }
];

function getResource(sourceFile: string): Resource {
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
	let resource: string;

	if (sourceFile.startsWith('vs/platform')) {
		return { name: 'vs/platform', project: editorProject };
	} else if (sourceFile.startsWith('vs/editor/contrib')) {
		return { name: 'vs/editor/contrib', project: editorProject };
	} else if (sourceFile.startsWith('vs/editor')) {
		return { name: 'vs/editor', project: editorProject };
	} else if (sourceFile.startsWith('vs/base')) {
		return { name: 'vs/base', project: editorProject };
 	} else if (sourceFile.startsWith('vs/code')) {
		return { name: 'vs/code', project: workbenchProject };
	} else if (sourceFile.startsWith('vs/workbench/parts')) {
		resource = sourceFile.split('/', 4).join('/');
		return { name: resource, project: workbenchProject };
	} else if (sourceFile.startsWith('vs/workbench/services')) {
		resource = sourceFile.split('/', 4).join('/');
		return { name: resource, project: workbenchProject };
	} else if (sourceFile.startsWith('vs/workbench')) {
		return { name: 'vs/workbench', project: workbenchProject };
	}

	throw new Error (`Could not identify the XLF bundle for ${sourceFile}`);
}


function importBundleJson(file: File, json: BundledFormat, stream: ThroughStream): void {
652
	let bundleXlfs: Map<XLF> = Object.create(null);
653 654 655 656 657 658 659 660 661

	for (let source in json.keys) {
		const projectResource = getResource(source);
		const resource = projectResource.name;
		const project = projectResource.project;

		const keys = json.keys[source];
		const messages = json.messages[source];
		if (keys.length !== messages.length) {
662
			throw new Error(`There is a mismatch between keys and messages in ${file.relative}`);
663 664
		}

665
		let xlf = bundleXlfs[resource] ? bundleXlfs[resource] : bundleXlfs[resource] = new XLF(project);
666
		xlf.addFile('src/' + source, keys, messages);
667 668
	}

669 670 671
	for (let resource in bundleXlfs) {
		const newFilePath = `${bundleXlfs[resource].project}/${resource.replace(/\//g, '_')}.xlf`;
		const xlfFile = new File({ path: newFilePath, contents: new Buffer(bundleXlfs[resource].toString(), 'utf-8')});
672 673 674 675 676 677 678 679
		stream.emit('data', xlfFile);
	}
}

// Keeps existing XLF instances and a state of how many files were already processed for faster file emission
var extensions: Map<{ xlf: XLF, processed: number }> = Object.create(null);
function importModuleOrPackageJson(file: File, json: ModuleJsonFormat | PackageJsonFormat, projectName: string, stream: ThroughStream, extensionName?: string): void {
	if (ModuleJsonFormat.is(json) && json['keys'].length !== json['messages'].length) {
680
		throw new Error(`There is a mismatch between keys and messages in ${file.relative}`);
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
	}

	// Prepare the source path for <original/> attribute in XLF & extract messages from JSON
	const formattedSourcePath = file.relative.replace(/\\/g, '/');
	const messages = Object.keys(json).map((key) => json[key].toString());

	// Stores the amount of localization files to be transformed to XLF before the emission
	let localizationFilesCount,
		originalFilePath;
	// If preparing XLF for external extension, then use different glob pattern and source path
	if (extensionName) {
		localizationFilesCount = glob.sync('**/*.nls.json').length;
		originalFilePath = `${formattedSourcePath.substr(0, formattedSourcePath.length - '.nls.json'.length)}`;
	} else {
		// Used for vscode/extensions folder
		extensionName = formattedSourcePath.split('/')[0];
		localizationFilesCount = glob.sync(`./extensions/${extensionName}/**/*.nls.json`).length;
		originalFilePath = `extensions/${formattedSourcePath.substr(0, formattedSourcePath.length - '.nls.json'.length)}`;
	}

	let extension = extensions[extensionName] ?
		extensions[extensionName] : extensions[extensionName] = { xlf: new XLF(projectName), processed: 0 };

	if (ModuleJsonFormat.is(json)) {
		extension.xlf.addFile(originalFilePath, json['keys'], json['messages']);
	} else {
		extension.xlf.addFile(originalFilePath, Object.keys(json), messages);
	}

	// Check if XLF is populated with file nodes to emit it
	if (++extensions[extensionName].processed === localizationFilesCount) {
		const newFilePath = path.join(projectName, extensionName + '.xlf');
		const xlfFile = new File({ path: newFilePath, contents: new Buffer(extension.xlf.toString(), 'utf-8')});
		stream.emit('data', xlfFile);
	}
}

var islXlf: XLF,
	islProcessed: number = 0;

function importIsl(file: File, stream: ThroughStream) {
	const islFiles = ['Default.isl', 'messages.en.isl'];
723
	const projectName = workbenchProject;
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748

	let xlf = islXlf ? islXlf : islXlf = new XLF(projectName),
		keys: string[] = [],
		messages: string[] = [];

	let model = new TextModel(file.contents.toString());
	let inMessageSection = false;
	model.lines.forEach(line => {
		if (line.length === 0) {
			return;
		}
		let firstChar = line.charAt(0);
		switch (firstChar) {
			case ';':
				// Comment line;
				return;
			case '[':
				inMessageSection = '[Messages]' === line || '[CustomMessages]' === line;
				return;
		}
		if (!inMessageSection) {
			return;
		}
		let sections: string[] = line.split('=');
		if (sections.length !== 2) {
749
			throw new Error(`Badly formatted message found: ${line}`);
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
		} else {
			let key = sections[0];
			let value = sections[1];
			if (key.length > 0 && value.length > 0) {
				keys.push(key);
				messages.push(value);
			}
		}
	});

	const originalPath = file.path.substring(file.cwd.length+1, file.path.split('.')[0].length).replace(/\\/g, '/');
	xlf.addFile(originalPath, keys, messages);

	// Emit only upon all ISL files combined into single XLF instance
	if (++islProcessed === islFiles.length) {
		const newFilePath = path.join(projectName, 'setup.xlf');
		const xlfFile = new File({ path: newFilePath, contents: new Buffer(xlf.toString(), 'utf-8')});
		stream.emit('data', xlfFile);
	}
}

771
export function pushXlfFiles(apiHostname: string, username: string, password: string): ThroughStream {
772 773 774
	let tryGetPromises = [];
	let updateCreatePromises = [];

775 776 777 778
	return through(function(file: File) {
		const project = path.dirname(file.relative);
		const fileName = path.basename(file.path);
		const slug = fileName.substr(0, fileName.length - '.xlf'.length);
779
		const credentials = `${username}:${password}`;
780 781

		// Check if resource already exists, if not, then create it.
782
		let promise = tryGetResource(project, slug, apiHostname, credentials);
783 784
		tryGetPromises.push(promise);
		promise.then(exists => {
785
			if (exists) {
786
				promise = updateResource(project, slug, file, apiHostname, credentials);
787
			} else {
788
				promise = createResource(project, slug, file, apiHostname, credentials);
789
			}
790 791 792 793 794 795 796 797
			updateCreatePromises.push(promise);
		});

	}, function() {
		// End the pipe only after all the communication with Transifex API happened
		Promise.all(tryGetPromises).then(() => {
			Promise.all(updateCreatePromises).then(() => {
				this.emit('end');
798 799
			}).catch((reason) => { throw new Error(reason); });
		}).catch((reason) => { throw new Error(reason); });
800 801 802
	});
}

803
function tryGetResource(project: string, slug: string, apiHostname: string, credentials: string): Promise<boolean> {
804
	return new Promise((resolve, reject) => {
805 806 807 808 809 810 811 812
		const options = {
			hostname: apiHostname,
			path: `/api/2/project/${project}/resource/${slug}/?details`,
			auth: credentials,
			method: 'GET'
		};

		const request = http.request(options, (response) => {
813 814 815 816 817
			if (response.statusCode === 404) {
				resolve(false);
			} else if (response.statusCode === 200) {
				resolve(true);
			} else {
818
				reject(`Failed to query resource ${project}/${slug}. Response: ${response.statusCode} ${response.statusMessage}`);
819
			}
820 821
		});
		request.on('error', (err) => {
822
			reject(`Failed to get ${project}/${slug} on Transifex: ${err}`);
823
		});
824 825

		request.end();
826 827 828
	});
}

829 830 831 832 833 834 835 836
function createResource(project: string, slug: string, xlfFile: File, apiHostname: string, credentials: any): Promise<any> {
	return new Promise((resolve, reject) => {
		const data = JSON.stringify({
			'content': xlfFile.contents.toString(),
			'name': slug,
			'slug': slug,
			'i18n_type': 'XLIFF'
		});
837
		const options = {
838 839 840 841 842
			hostname: apiHostname,
			path: `/api/2/project/${project}/resources`,
			headers: {
				'Content-Type': 'application/json',
				'Content-Length': Buffer.byteLength(data)
843
			},
844 845
			auth: credentials,
			method: 'POST'
846
		};
847

848
		let request = http.request(options, (res) => {
849 850 851
			if (res.statusCode === 201) {
				log(`Resource ${project}/${slug} successfully created on Transifex.`);
			} else {
852
				reject(`Something went wrong in the request creating ${slug} in ${project}. ${res.statusCode}`);
853
			}
854 855
		});
		request.on('error', (err) => {
856
			reject(`Failed to create ${project}/${slug} on Transifex: ${err}`);
857
		});
858 859 860

		request.write(data);
		request.end();
861 862 863 864 865 866 867
	});
}

/**
 * The following link provides information about how Transifex handles updates of a resource file:
 * https://dev.befoolish.co/tx-docs/public/projects/updating-content#what-happens-when-you-update-files
 */
868 869 870
function updateResource(project: string, slug: string, xlfFile: File, apiHostname: string, credentials: string) : Promise<any> {
	return new Promise((resolve, reject) => {
		const data = JSON.stringify({ content: xlfFile.contents.toString() });
871
		const options = {
872 873 874 875 876 877 878 879
			hostname: apiHostname,
			path: `/api/2/project/${project}/resource/${slug}/content`,
			headers: {
				'Content-Type': 'application/json',
				'Content-Length': Buffer.byteLength(data)
			},
			auth: credentials,
			method: 'PUT'
880
		};
881

882
		let request = http.request(options, (res) => {
883
			if (res.statusCode === 200) {
884 885 886 887 888 889 890 891 892 893 894
				res.setEncoding('utf8');

				let responseBuffer: string = '';
				res.on('data', function (chunk) {
					responseBuffer += chunk;
				});
				res.on('end', () => {
					const response = JSON.parse(responseBuffer);
					log(`Resource ${project}/${slug} successfully updated on Transifex. Strings added: ${response.strings_added}, updated: ${response.strings_added}, deleted: ${response.strings_added}`);
					resolve();
				});
895
			} else {
896
				reject(`Something went wrong in the request updating ${slug} in ${project}. ${res.statusCode}`);
897
			}
898 899
		});
		request.on('error', (err) => {
900
			reject(`Failed to update ${project}/${slug} on Transifex: ${err}`);
901
		});
902 903 904

		request.write(data);
		request.end();
905 906 907 908 909 910 911
	});
}

function obtainProjectResources(projectName: string): Resource[] {
	let resources: Resource[];

	if (projectName === 'vscode-editor-workbench') {
912
		resources = editorWorkbenchResources;
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
	} else if (projectName === 'vscode-extensions') {
		let extensionsToLocalize: string[] = glob.sync('./extensions/**/*.nls.json').map(extension => extension.split('/')[2]);
		let resourcesToPull: string[] = [];
		resources = [];

		extensionsToLocalize.forEach(extension => {
			if (resourcesToPull.indexOf(extension) === -1) { // remove duplicate elements returned by glob
				resourcesToPull.push(extension);
				resources.push({ name: extension, project: projectName });
			}
		});
	}

	return resources;
}

929
export function pullXlfFiles(projectName: string, apiHostname: string, username: string, password: string, resources?: Resource[]): NodeJS.ReadableStream {
930 931 932 933 934 935 936
	if (!resources) {
		resources = obtainProjectResources(projectName);
	}
	if (!resources) {
		throw new Error('Transifex projects and resources must be defined to be able to pull translations from Transifex.');
	}

937
	const credentials = `${username}:${password}`;
938 939 940
	let expectedTranslationsCount = vscodeLanguages.length * resources.length;
	let translationsRetrieved = 0, called = false;

941
	return readable(function(count, callback) {
942 943 944 945 946 947 948 949 950 951
		// Mark end of stream when all resources were retrieved
		if (translationsRetrieved === expectedTranslationsCount) {
			return this.emit('end');
		}

		if (!called) {
			called = true;
			const stream = this;

			vscodeLanguages.map(function(language) {
952
				resources.map(function(resource) {
953 954 955
					const slug = resource.name.replace(/\//g, '_');
					const project = resource.project;
					const iso639 = iso639_3_to_2[language];
956 957 958 959 960 961 962 963 964 965 966 967
					const options = {
						hostname: apiHostname,
						path: `/api/2/project/${project}/resource/${slug}/translation/${iso639}?file&mode=onlyreviewed`,
						auth: credentials,
						method: 'GET'
					};

					let request = http.request(options, (res) => {
							let xlfBuffer: string = '';
							res.on('data', (data) => xlfBuffer += data);
							res.on('end', () => {
								if (res.statusCode === 200) {
968
									stream.emit('data', new File({ contents: new Buffer(xlfBuffer), path: `${project}/${language}/${slug}.xlf` }));
969
								} else {
970
									throw new Error(`${slug} in ${project} returned no data. Response code: ${res.statusCode}.`);
971 972 973
								}
								translationsRetrieved++;
							});
974 975 976
					});
					request.on('error', (err) => {
						throw new Error(`Failed to query resource ${slug} with the following error: ${err}`);
977 978
					});
					request.end();
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
				});
			});
		}

		callback();
	});
}

export function prepareJsonFiles(): ThroughStream {
	return through(function(xlf: File) {
		let stream = this;

		XLF.parse(xlf.contents.toString()).then(
			function(resolvedFiles) {
				resolvedFiles.forEach(file => {
					let messages = file.messages, translatedFile;

					// ISL file path always starts with 'build/'
					if (file.originalFilePath.startsWith('build/')) {
						const defaultLanguages = { 'zh-cn': true, 'zh-tw': true, 'ko': true };
						if (path.basename(file.originalFilePath) === 'Default' && !defaultLanguages[file.language]) {
							return;
						}

						translatedFile = createIslFile('..', file.originalFilePath, messages, iso639_2_to_3[file.language]);
					} else {
						translatedFile = createI18nFile(iso639_2_to_3[file.language], file.originalFilePath, messages);
					}

					stream.emit('data', translatedFile);
				});
			},
			function(rejectReason) {
1012
				throw new Error(`XLF parsing error: ${rejectReason}`);
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
			}
		);
	});
}

export function createI18nFile(base: string, originalFilePath: string, messages: Map<string>): File {
	let content = [
		'/*---------------------------------------------------------------------------------------------',
		' *  Copyright (c) Microsoft Corporation. All rights reserved.',
		' *  Licensed under the MIT License. See License.txt in the project root for license information.',
		' *--------------------------------------------------------------------------------------------*/',
		'// Do not edit this file. It is machine generated.'
	].join('\n') + '\n' + JSON.stringify(messages, null, '\t').replace(/\r\n/g, '\n');

	return new File({
		path: path.join(base, originalFilePath + '.i18n.json'),
		contents: new Buffer(content, 'utf8')
	});
}


const languageNames: Map<string> = {
	'chs': 'Simplified Chinese',
	'cht': 'Traditional Chinese',
	'kor': 'Korean'
};

const languageIds: Map<string> = {
	'chs': '$0804',
	'cht': '$0404',
	'kor': '$0412'
};

const encodings: Map<string> = {
	'chs': 'CP936',
	'cht': 'CP950',
	'jpn': 'CP932',
	'kor': 'CP949',
	'deu': 'CP1252',
	'fra': 'CP1252',
	'esn': 'CP1252',
	'rus': 'CP1251',
	'ita': 'CP1252'
};

export function createIslFile(base: string, originalFilePath: string, messages: Map<string>, language: string): File {
	let content: string[] = [];
	let originalContent: TextModel;
	if (path.basename(originalFilePath) === 'Default') {
		originalContent = new TextModel(fs.readFileSync(originalFilePath + '.isl', 'utf8'));
	} else {
		originalContent = new TextModel(fs.readFileSync(originalFilePath + '.en.isl', 'utf8'));
	}

	originalContent.lines.forEach(line => {
		if (line.length > 0) {
			let firstChar = line.charAt(0);
			if (firstChar === '[' || firstChar === ';') {
				if (line === '; *** Inno Setup version 5.5.3+ English messages ***') {
					content.push(`; *** Inno Setup version 5.5.3+ ${languageNames[language]} messages ***`);
				} else {
					content.push(line);
				}
			} else {
				let sections: string[] = line.split('=');
				let key = sections[0];
				let translated = line;
				if (key) {
					if (key === 'LanguageName') {
						translated = `${key}=${languageNames[language]}`;
					} else if (key === 'LanguageID') {
						translated = `${key}=${languageIds[language]}`;
					} else if (key === 'LanguageCodePage') {
						translated = `${key}=${encodings[language].substr(2)}`;
					} else {
						let translatedMessage = messages[key];
						if (translatedMessage) {
							translated = `${key}=${translatedMessage}`;
						}
					}
				}

				content.push(translated);
			}
		}
	});

	let tag = iso639_3_to_2[language];
	let basename = path.basename(originalFilePath);
	let filePath = `${path.join(base, path.dirname(originalFilePath), basename)}.${tag}.isl`;

	return new File({
		path: filePath,
		contents: iconv.encode(new Buffer(content.join('\r\n'), 'utf8'), encodings[language])
	});
}

function encodeEntities(value: string): string {
	var result: string[] = [];
	for (var i = 0; i < value.length; i++) {
		var ch = value[i];
		switch (ch) {
			case '<':
				result.push('&lt;');
				break;
			case '>':
				result.push('&gt;');
				break;
			case '&':
				result.push('&amp;');
				break;
			default:
				result.push(ch);
		}
	}
	return result.join('');
}

export function decodeEntities(value:string): string {
	return value.replace(/&lt;/g, '<').replace(/&gt;/g, '>').replace(/&amp;/g, '&');
D
Dirk Baeumer 已提交
1133
}