js/Engines.js

  1. /*
  2. 	HANDLER LIST
  3. 	------------
  4. 	onLoadTrans : when opening trans or creating new project
  5. 	onUnloadTrans : when closing trans
  6. 	
  7. 	injectHandler : when injecting translation
  8. 		return true to halt default process;
  9. 	exportHandler : when exporting translation
  10. 		return true to halt default process;
  11. 		
  12. 	onOpenInjectDialog
  13. */
  15. /**
  16.  * Game engine class
  17.  * @class
  18.  * @param {String} name - Name of the engine
  19.  * @param {Object} options - Additional option
  20.  */
  21. var Engine = function(name, options) {
  22. 	/* engine */
  23. 	options = options||{};
  24. 	this.name = name;
  25. 	for (let i in options) {
  26. 		this[i] = options[i];
  27. 	}
  28. 	
  29. 	common.addEventHandler(this);
  30. 	this.init();
  31. }
  33. Engine.prototype.addProperty = function(name, obj) {
  34. 	this[name] = obj;
  35. }
  37. Engine.prototype.getProperty = function(name) {
  38. 	return this[name];
  39. } 
  41. Engine.prototype.addHandler = function(name, handler) {
  42. 	if (typeof handler !== 'function') console.warn("handler must be a function");
  43. 	this[name] = handler;
  44. }
  45. Engine.prototype.hasHandler = function(handlerName) {
  46. 	if (typeof this[handlerName] == "function") return true;
  47. 	return false;
  48. }
  50. Engine.prototype.getHandler = function(handlerName) {
  51. 	if (!this.hasHandler(handlerName)) return function(){};
  52. 	return this[handlerName];
  53. }
  55. Engine.prototype.triggerHandler = async function(handlerName, thisScope, args) {
  56. 	if (!this.hasHandler(handlerName)) return;
  57. 	if (common.isArguments(args)) {
  58. 		args = common.argumentsToArray(args);
  59. 	}
  60. 	if (!Array.isArray(args)) return console.warn("Expected array for args "+typeof args+ " given!");
  61. 	this.trigger(handlerName, args);
  62. 	return await this.getHandler(handlerName).apply(thisScope, args);
  63. }
  65. Engine.prototype.appendList = function() {
  66. 	var $container = $('#gameEngines')
  67. 	$container.append($('<option value="'+common.htmlEntities(this.name)+'" />'))
  68. }
  70. Engine.prototype.init = function() {
  71. 	this.appendList();
  72. }
  75. /**
  76.  * Collection of engine
  77.  * @class
  78.  * @param  {} name
  79.  * @param  {} options
  80.  */
  81. var Engines = function(name, options) {
  82. 	/* collection of engine*/
  83. 	var that = this;
  84. 	
  85. 	this.add = function(name, options) {
  86. 		that[name] = new Engine(name, options);
  87. 		that.list = that.list || [];
  88. 		that.list.push(that[name]);
  89. 		that.length = that.list.length;
  90. 	}
  91. 	
  92. 	if (typeof name !== 'undefined') {
  93. 		this.add(name, options);
  94. 	}
  95. }
  96. Engines.group = {
  97. 	'unityTrans' : ["rmxp", "rmvx", "rmvxace"]
  98. }
  99. Engines.characteristics = [
  100. 	async function(gamepath) {
  101. 		//rmmv
  102. 		var dir = nwPath.dirname(gamepath);
  103. 		if (common.isDir(gamepath)) dir = gamepath;
  104. 		if (common.isFile(nwPath.join(dir, "js", "rpg_core.js"))) return "rmmv";
  105. 		if (common.isFile(nwPath.join(dir, "www", "js", "rpg_core.js"))) return "rmmv";
  106. 		return false;
  107. 	},
  108. 	async function(gamepath) {
  109. 		//rmmz
  110. 		var dir = nwPath.dirname(gamepath);
  111. 		if (common.isDir(gamepath)) dir = gamepath;
  112. 		if (common.isFile(nwPath.join(dir, "js", "rmmz_core.js"))) return "rmmz";
  113. 		return false;
  114. 	},
  115. 	async function(gamepath) {
  116. 		//rmmz
  117. 		//var dir = nwPath.dirname(gamepath);
  118. 		var isEnigma = await php.isEnigma(gamepath);
  119. 		if (isEnigma.result) return "enigma";
  120. 		return false;
  121. 	},
  122. 	async function(gamepath) {
  123. 		//vxAce
  124. 		//Library=System\RGSS3*
  125. 		var ini = ini || require('ini');
  126. 		var iniPath = nwPath.join(nwPath.dirname(gamepath), "Game.ini");
  127. 		if (!common.isFile(iniPath)) return false; 
  128. 		var iniFile = await window.afs.readFile(iniPath) 
  129. 		var iniContent = ini.parse(iniFile.toString());
  130. 		var libString = iniContent['Game']['Library'] || iniContent['Game']['library'];
  131. 		if (libString.includes('RGSS3')) return "rmvxace";
  132. 		if (libString.includes('RGSS2')) return "rmvx";
  133. 		if (libString.includes('RGSS1')) return "rmxp";
  134. 		
  135. 		return false
  136. 	}
  137. ]
  140. Engines.detect = async function(gamepath) {
  141. 	for (var i in Engines.characteristics) {
  142. 		var engines = await Engines.characteristics[i].call(this, gamepath);
  143. 		if (engines) return engines;
  144. 	}
  145. 	return "";
  146. }
  148. Engines.prototype.addHandler = function(engines, handlerName, handler) {
  149. 	// apply handler to one or more engine
  150. 	// create the engine if the engine is not exist;
  151. 	if (typeof handlerName !== 'string') console.warn("handler name must be a string")
  152. 	if (!handlerName) console.warn("handler name must be specified")
  153. 	if (typeof handler !== 'function') console.warn("handler must be function")
  154. 	if (Array.isArray(engines) == false) engines = [engines]
  155. 	for (var i in engines) {
  156. 		var thisEngine = engines[i]
  157. 		if (Boolean(thisEngine) == false) continue;
  158. 		if (typeof thisEngine !== 'string') continue;
  159. 		
  160. 		if (Boolean(this[thisEngine]) == false) this.add(thisEngine);
  161. 		this[thisEngine].addHandler(handlerName, handler);
  162. 	}
  163. }
  165. Engines.prototype.hasHandler = function(handler, engineName) {
  166. 	engineName = engineName || trans.project.gameEngine;
  167. 	if (typeof this[engineName] == 'undefined') return false;
  168. 	if (typeof this[engineName][handler] == 'function') return true;
  169. 	
  170. 	return false;
  171. }
  173. Engines.prototype.current = function() {
  174. 	var result = new Engine("");
  175. 	if (typeof trans.project == 'undefined') return result;
  176. 	if (typeof trans.project.gameEngine == 'undefined') return result;
  177. 	
  178. 	if (this[trans.project.gameEngine]) return this[trans.project.gameEngine];
  179. 	
  180. 	// looking from the group
  181. 	for (var engineName in Engines.group) {
  182. 		if (Engines.group[engineName].includes(trans.project.gameEngine)) return this[engineName];
  183. 	}
  184. 	
  185. 	return result
  186. }
  188. Engines.prototype.handler = function(handler, engineName) {
  189. 	engineName = engineName || trans.project.gameEngine;
  190. 	if (!this[engineName]) return function() {}
  191. 	if (typeof this[engineName][handler] !== 'function') return function() {};
  192. 	
  193. 	return this[engineName][handler];
  194. }
  196. Engines.prototype.hasEngine = function(engineName) {
  197. 	if (!this[engineName]) return false;
  198. 	if (this[engineName].constructor.name !== "Engine") return false;
  199. 	return true;
  200. }
  202. Engines.prototype.getEngine = function(engineName) {
  203. 	if (this.hasEngine(engineName)) return this[engineName];
  204. 	return new Engine("NullEngine");
  205. }
  208. var engines = new Engines();
  210. engines.add("rmmv", {});
  215. var ApplyTranslation = function() {
  216. 	this.__supportList = ["rmxp", "rmvx", "rmvxace", "rmmv", "wolf"]
  217. }
  218. ApplyTranslation.prototype.getSupported = function() {
  219. 	return this.__supportList;
  220. }	
  222. ApplyTranslation.prototype.isSupported = function(thisEngine) {
  223. 	thisEngine = thisEngine || trans.gameEngine;
  224. 	return this.__supportList.includes(thisEngine);
  225. }
  228. ApplyTranslation.prototype.start = async function(targetDir, sourceMaterial, options) {
  229. 	var fs = fs||require("fs");
  230. 	options = options||{};
  231. 	options.options = options.options||{};
  232. 	options.mode = options.mode||"dir";
  233. 	options.onDone = options.onDone||function() {};
  234. 	options.dataPath = options.dataPath || ""; // location of data path (data folder). Default is using cache
  235. 	options.transPath = options.transPath || ""; // location of .trans path to process. Default is using autosave on cache folder
  236. 	options.options.filterTag = options.options.filterTag||options.filterTag||{};
  237. 	options.options.filterTagMode = options.options.filterTagMode||options.filterTagMode||""; // whitelist or blacklist
  239. 	console.log("Applying translation!", arguments)
  241. 	//return console.log("HALTED", arguments);
  242. 	//check if target dir is writable
  243. 	var checkPath = php.checkPathSync(targetDir);
  244. 	var isHandled = false; // handle check;
  245. 	
  246. 	if (checkPath.accessible == false) return alert(targetDir+" is not accessible!");
  247. 	if (checkPath.writable == false) return alert(targetDir+" is not writable!");
  248. 	
  249. 	var that = this;
  250. 	var mainArgs = arguments;
  251. 	if (engines.hasHandler('injectHandler')) {
  252. 		console.log("This engine has inject handler")
  253. 		var blocking = await engines.handler('injectHandler').apply(this, arguments);
  254. 		if (blocking) return;
  255. 	}
  256. 	
  257. 	// legacy parser start
  260. 	var enginePattern = {};
  261. 	enginePattern['rpgMaker'] = ["rmxp", "rmvx", "rmvxace"];
  262. 	enginePattern['rmmv'] = ["rmmv", "rmmz"];
  263. 	enginePattern['wolf'] = ["wolf"];
  264. 	
  265. 	
  267. 	if (enginePattern['rpgMaker'].includes(trans.gameEngine)) {
  268. 		let transPath = targetDir+"\\translation.trans";
  269. 		let child_process = require('child_process');
  270. 		// remove existing data directory
  271. 		
  272. 		if (trans.gameEngine == 'rmmv') {
  273. 			child_process.spawnSync("RMDIR", [targetDir+"\\www\\Data", "/S", "/Q"]);
  274. 		} else {
  275. 			child_process.spawnSync("RMDIR", [targetDir+"\\Data", "/S", "/Q"]);
  276. 		}
  277. 		
  278. 		//ui.loadingClearButton();
  279. 		ui.showLoading();
  280. 		ui.loadingProgress("Loading", "Copying data...", {consoleOnly:true, mode:'consoleOutput'});
  281. 		
  282. 		//ncp(sourceMaterial, targetDir, function (err) {
  283. 		//	if (err) return alert(err);
  284. 		
  285. 		php.copyTree(sourceMaterial, targetDir, {
  286. 		onData: function(data) {
  287. 			ui.loadingProgress("Loading", data, {consoleOnly:true, mode:'consoleOutput'});
  288. 		},
  289. 		onDone: function() {
  290. 		
  291. 			
  292. 			var autofillFiles = [];
  293. 			var checkbox = $(".fileList .data-selector .fileCheckbox:checked");
  294. 			for (var i=0; i<checkbox.length; i++) {
  295. 				autofillFiles.push(checkbox.eq(i).attr("value"));
  296. 			}
  297. 			options.files = options.files||autofillFiles||[];
  298. 			var hasError = false;
  299. 			trans.save(transPath,
  300. 			{
  301. 				onSuccess:function() {
  302. 					//ui.showLoading();
  303. 					php.spawn("apply.php", {
  304. 						args:{
  305. 							gameFolder:trans.gameFolder,
  306. 							gameTitle:trans.gameTitle,
  307. 							projectId:trans.projectId,
  308. 							gameEngine:trans.gameEngine,
  309. 							files:options.files,
  310. 							exportMode:options.mode,
  311. 							options:options.options,
  312. 							rpgTransFormat:trans.config.rpgTransFormat,
  313. 							transPath:transPath,
  314. 							targetPath:targetDir
  315. 						},
  316. 						onData:function(buffer) {
  317. 							ui.loadingProgress("Loading", buffer, {consoleOnly:true, mode:'consoleOutput'});
  318. 							
  319. 						},
  320. 						onError:function(buffer) {
  321. 							ui.loadingProgress("Loading", buffer, {consoleOnly:true, mode:'consoleOutput', classStr:'stderr'});
  322. 							console.warn("stderr", buffer.toString());
  323. 							hasError = true;
  324. 						},
  325. 						onDone: async function(data) {
  326. 							//console.log(data); 
  327. 							console.log("done")
  328. 							//ui.hideLoading(true);
  329. 							ui.loadingEnd("Finished", "All process finished!", {consoleOnly:false, mode:'consoleOutput', error:hasError});
  330. 							
  331. 							ui.LoadingAddButton("Open folder", function() {
  332. 								nw.Shell.showItemInFolder(transPath);
  333. 							},{
  334. 								class: "icon-folder-open"
  335. 							});
  336. 							ui.LoadingAddButton("Play!", function() {
  337. 								console.log("Opening game");
  338. 								nw.Shell.openItem(targetDir+"\\Game.exe");
  339. 							},{
  340. 								class: "icon-play"
  341. 							});
  343. 							if (engines.hasHandler('afterInjectHandler')) {
  344. 								var blocking = await engines.handler('afterInjectHandler').apply(that, mainArgs);
  345. 								if (blocking) return;
  346. 							}
  348. 							ui.showCloseButton();
  349. 							
  350. 							if (hasError) {
  351. 								var conf = confirm("An error has occured when applying your translation\r\nYour game might can not be played properly.\r\nDo you want to read the online documentation?");
  352. 								if (conf) nw.Shell.openExternal(nw.App.manifest.localConfig.defaultDocsUrl+trans.gameEngine);
  353. 							}
  354. 							options.onDone.call(trans, data);
  355. 						}
  356. 					})
  357. 					
  358. 				}
  359. 			});
  360. 					
  361. 			
  362. 		}});		
  363. 		isHandled = true;
  364. 	} else if (enginePattern['rmmv'].includes(trans.gameEngine)) {
  365. 		let transPath = targetDir+"\\translation.trans";
  366. 		let child_process = require('child_process');
  367. 		// remove existing data directory
  368. 		
  369. 		child_process.spawnSync("RMDIR", [targetDir+"\\www\\Data", "/S", "/Q"]);
  370. 		
  371. 		//ui.loadingClearButton();
  372. 		ui.showLoading();
  373. 		ui.loadingProgress("Loading", "Copying data...", {consoleOnly:true, mode:'consoleOutput'});
  374. 		
  375. 		
  376. 		php.extractEnigma(sourceMaterial, targetDir, {
  377. 			onData: function(data) {
  378. 				ui.loadingProgress("Loading", data, {consoleOnly:true, mode:'consoleOutput'});
  379. 			},
  380. 			onDone: function() {
  381. 			
  382. 			var autofillFiles = [];
  383. 			var checkbox = $(".fileList .data-selector .fileCheckbox:checked");
  384. 			for (var i=0; i<checkbox.length; i++) {
  385. 				autofillFiles.push(checkbox.eq(i).attr("value"));
  386. 			}
  387. 			options.files = options.files||autofillFiles||[];
  388. 			var hasError = false;
  389. 			trans.save(transPath,
  390. 			{
  391. 				onSuccess:function() {
  392. 					//ui.showLoading();
  393. 					php.spawn("apply.php", {
  394. 						args:{
  395. 							gameFolder:trans.gameFolder,
  396. 							gameTitle:trans.gameTitle,
  397. 							projectId:trans.projectId,
  398. 							gameEngine:trans.gameEngine,
  399. 							files:options.files,
  400. 							exportMode:options.mode,
  401. 							options:options.options,
  402. 							rpgTransFormat:trans.config.rpgTransFormat,
  403. 							transPath:transPath,
  404. 							targetPath:targetDir
  405. 						},
  406. 						onData:function(buffer) {
  407. 							ui.loadingProgress("Loading", buffer, {consoleOnly:true, mode:'consoleOutput'});
  408. 							
  409. 						},
  410. 						onError:function(buffer) {
  411. 							ui.loadingProgress("Loading", buffer, {consoleOnly:true, mode:'consoleOutput', classStr:'stderr'});
  412. 							hasError = true;
  413. 						},
  414. 						onDone: async function(data) {
  415. 							//console.log(data); 
  416. 							console.log("done")
  417. 							//ui.hideLoading(true);
  418. 							ui.loadingEnd("Finished", "All process finished!", {consoleOnly:false, mode:'consoleOutput', error:hasError});
  419. 							ui.LoadingAddButton("Open folder", function() {
  420. 								nw.Shell.showItemInFolder(transPath);
  421. 							},{
  422. 								class: "icon-folder-open"
  423. 							});
  424. 							ui.LoadingAddButton("Play!", function() {
  425. 								console.log("Opening game");
  426. 								nw.Shell.openItem(targetDir+"\\Game.exe");
  427. 							},{
  428. 								class: "icon-play"
  429. 							});
  431. 							if (engines.hasHandler('afterInjectHandler')) {
  432. 								var blocking = await engines.handler('afterInjectHandler').apply(that, mainArgs);
  433. 								if (blocking) return;
  434. 							}
  436. 							ui.showCloseButton();
  437. 							if (hasError) {
  438. 								var conf = confirm("An error has occured when applying your translation\r\nYour game might can not be played properly.\r\nDo you want to read the online documentation?");
  439. 								if (conf) nw.Shell.openExternal(nw.App.manifest.localConfig.defaultDocsUrl+trans.gameEngine);
  440. 							}
  441. 							
  442. 							options.onDone.call(trans, data);
  443. 						}
  444. 					})
  445. 					
  446. 				}
  447. 			});
  448. 					
  449. 			
  450. 		}});		
  451. 		
  452. 		isHandled = true;
  453. 	} else if (enginePattern['wolf'].includes(trans.gameEngine)) {
  454. 		let transPath = targetDir+"\\translation.trans";
  455. 		let child_process = require('child_process');
  456. 		// remove existing data directory
  457. 		
  458. 		child_process.spawnSync("RMDIR", [targetDir+"\\Data", "/S", "/Q"]);
  459. 		
  460. 		//ui.loadingClearButton();
  461. 		ui.showLoading();
  462. 		ui.loadingProgress("Loading", "Copying data...", {consoleOnly:true, mode:'consoleOutput'});
  463. 		
  464. 		
  465. 		php.copyTree(sourceMaterial, targetDir, {
  466. 			onData: function(data) {
  467. 				ui.loadingProgress("Loading", data, {consoleOnly:true, mode:'consoleOutput'});
  468. 			},
  469. 			onDone: function() {
  470. 			
  471. 			var autofillFiles = [];
  472. 			var checkbox = $(".fileList .data-selector .fileCheckbox:checked");
  473. 			for (var i=0; i<checkbox.length; i++) {
  474. 				autofillFiles.push(checkbox.eq(i).attr("value"));
  475. 			}
  476. 			options.files = options.files||autofillFiles||[];
  479. 			var hasError = false;
  480. 			trans.save(transPath,
  481. 			{
  482. 				onSuccess:function() {
  483. 					//ui.showLoading();
  484. 					php.spawn("apply.php", {
  485. 						args:{
  486. 							gameFolder:trans.gameFolder,
  487. 							gameTitle:trans.gameTitle,
  488. 							projectId:trans.projectId,
  489. 							gameEngine:trans.gameEngine,
  490. 							files:options.files,
  491. 							exportMode:options.mode,
  492. 							options:options.options,
  493. 							rpgTransFormat:trans.config.rpgTransFormat,
  494. 							transPath:transPath,
  495. 							targetPath:targetDir
  496. 						},
  497. 						onData:function(buffer) {
  498. 							ui.loadingProgress("Loading", buffer, {consoleOnly:true, mode:'consoleOutput'});
  499. 							
  500. 						},
  501. 						onError:function(buffer) {
  502. 							ui.loadingProgress("Loading", buffer, {consoleOnly:true, mode:'consoleOutput', classStr:'stderr'});
  503. 							hasError = true;
  504. 						},
  505. 						onDone: async function(data) {
  506. 							//console.log(data); 
  507. 							console.log("done")
  508. 							//ui.hideLoading(true);
  509. 							//console.log("has Error?", hasError);
  510. 							ui.loadingEnd("Finished", "All process finished!", {consoleOnly:false, mode:'consoleOutput', error:hasError});
  511. 							engines.wolf.onApplySuccess(targetDir);
  513. 							ui.LoadingAddButton("Open folder", function() {
  514. 								nw.Shell.showItemInFolder(transPath);
  515. 							},{
  516. 								class: "icon-folder-open"
  517. 							});
  518. 							ui.LoadingAddButton("Play!", function() {
  519. 								console.log("Opening game");
  520. 								nw.Shell.openItem(targetDir+"\\Game.exe");
  521. 							},{
  522. 								class: "icon-play"
  523. 							});
  525. 							if (engines.hasHandler('afterInjectHandler')) {
  526. 								var blocking = await engines.handler('afterInjectHandler').apply(that, mainArgs);
  527. 								if (blocking) return;
  528. 							}
  530. 							ui.showCloseButton();
  531. 							if (hasError) {
  532. 								var conf = confirm("An error has occured when applying your translation\r\nYour game might can not be played properly.\r\nDo you want to read the online documentation?");
  533. 								if (conf) nw.Shell.openExternal(nw.App.manifest.localConfig.defaultDocsUrl+trans.gameEngine);
  534. 							}
  535. 							options.onDone.call(trans, data);
  536. 						}
  537. 					})
  538. 					
  539. 				}
  540. 			});
  541. 					
  542. 			
  543. 		}});		
  544. 		
  545. 		
  546. 		isHandled = true;
  547. 		
  548. 	}		
  549. 	
  550. 	if (trans.gameEngine == "spreadsheet") {
  551. 		alert("Sorry, but currently the injector handler for this engine not yet implemented. Please try to export instead. The result will be same.");
  552. 	} else {
  553. 		if (!isHandled) alert("No handler for engine : "+trans.gameEngine+"\nPlease get the latest version of Translator++");
  554. 	}
  555. }
  558. $(document).ready(function() {
  559. 	trans.applyTranslation = new ApplyTranslation();
  561. });