assetguard.js 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751
  1. /**
  2. * AssetGuard
  3. *
  4. * This module aims to provide a comprehensive and stable method for processing
  5. * and downloading game assets for the WesterosCraft server. A central object
  6. * stores download meta for several identifiers (categories). This meta data
  7. * is initially empty until one of the module's processing functions are called.
  8. * That function will process the corresponding asset index and validate any exisitng
  9. * local files. If a file is missing or fails validation, it will be placed into an
  10. * array which acts as a queue. This queue is wrapped in a download tracker object
  11. * so that essential information can be cached. The download tracker object is then
  12. * assigned as the value of the identifier in the central object. These download
  13. * trackers will remain idle until an async process is started to process them.
  14. *
  15. * Once the async process is started, any enqueued assets will be downloaded. The central
  16. * object will emit events throughout the download whose name correspond to the identifier
  17. * being processed. For example, if the 'assets' identifier was being processed, whenever
  18. * the download stream recieves data, the event 'assetsdlprogress' will be emitted off of
  19. * the central object instance. This can be listened to by external modules allowing for
  20. * categorical tracking of the downloading process.
  21. *
  22. * @module assetguard
  23. */
  24. // Requirements
  25. const fs = require('fs')
  26. const request = require('request')
  27. const path = require('path')
  28. const mkpath = require('mkdirp');
  29. const async = require('async')
  30. const crypto = require('crypto')
  31. const AdmZip = require('adm-zip')
  32. const child_process = require('child_process')
  33. const EventEmitter = require('events')
  34. const {remote} = require('electron')
  35. // Classes
  36. /** Class representing a base asset. */
  37. class Asset{
  38. /**
  39. * Create an asset.
  40. *
  41. * @param {any} id - id of the asset.
  42. * @param {String} hash - hash value of the asset.
  43. * @param {Number} size - size in bytes of the asset.
  44. * @param {String} from - url where the asset can be found.
  45. * @param {String} to - absolute local file path of the asset.
  46. */
  47. constructor(id, hash, size, from, to){
  48. this.id = id
  49. this.hash = hash
  50. this.size = size
  51. this.from = from
  52. this.to = to
  53. }
  54. }
  55. /** Class representing a mojang library. */
  56. class Library extends Asset{
  57. /**
  58. * Converts the process.platform OS names to match mojang's OS names.
  59. */
  60. static mojangFriendlyOS(){
  61. const opSys = process.platform
  62. if (opSys === 'darwin') {
  63. return 'osx';
  64. } else if (opSys === 'win32'){
  65. return 'windows';
  66. } else if (opSys === 'linux'){
  67. return 'linux';
  68. } else {
  69. return 'unknown_os';
  70. }
  71. }
  72. /**
  73. * Checks whether or not a library is valid for download on a particular OS, following
  74. * the rule format specified in the mojang version data index. If the allow property has
  75. * an OS specified, then the library can ONLY be downloaded on that OS. If the disallow
  76. * property has instead specified an OS, the library can be downloaded on any OS EXCLUDING
  77. * the one specified.
  78. *
  79. * @param {Object} rules - the Library's download rules.
  80. * @returns {Boolean} - true if the Library follows the specified rules, otherwise false.
  81. */
  82. static validateRules(rules){
  83. if(rules == null) return true
  84. let result = true
  85. rules.forEach(function(rule){
  86. const action = rule['action']
  87. const osProp = rule['os']
  88. if(action != null){
  89. if(osProp != null){
  90. const osName = osProp['name']
  91. const osMoj = Library.mojangFriendlyOS()
  92. if(action === 'allow'){
  93. result = osName === osMoj
  94. return
  95. } else if(action === 'disallow'){
  96. result = osName !== osMoj
  97. return
  98. }
  99. }
  100. }
  101. })
  102. return result
  103. }
  104. }
  105. /**
  106. * Class representing a download tracker. This is used to store meta data
  107. * about a download queue, including the queue itself.
  108. */
  109. class DLTracker {
  110. /**
  111. * Create a DLTracker
  112. *
  113. * @param {Array.<Asset>} dlqueue - an array containing assets queued for download.
  114. * @param {Number} dlsize - the combined size of each asset in the download queue array.
  115. * @param {function(Asset)} callback - optional callback which is called when an asset finishes downloading.
  116. */
  117. constructor(dlqueue, dlsize, callback = null){
  118. this.dlqueue = dlqueue
  119. this.dlsize = dlsize
  120. this.callback = callback
  121. }
  122. }
  123. /**
  124. * Central object class used for control flow. This object stores data about
  125. * categories of downloads. Each category is assigned an identifier with a
  126. * DLTracker object as its value. Combined information is also stored, such as
  127. * the total size of all the queued files in each category. This event is used
  128. * to emit events so that external modules can listen into processing done in
  129. * this module.
  130. */
  131. class AssetGuard extends EventEmitter{
  132. /**
  133. * AssetGuard class should only ever have one instance which is defined in
  134. * this module. On creation the object's properties are never-null default
  135. * values. Each identifier is resolved to an empty DLTracker.
  136. */
  137. constructor(){
  138. super()
  139. this.totaldlsize = 0;
  140. this.progress = 0;
  141. this.assets = new DLTracker([], 0)
  142. this.libraries = new DLTracker([], 0)
  143. this.files = new DLTracker([], 0)
  144. this.forge = new DLTracker([], 0)
  145. }
  146. }
  147. /**
  148. * Global static final instance of AssetGuard
  149. */
  150. const instance = new AssetGuard()
  151. // Utility Functions
  152. /**
  153. * Resolve an artifact id into a path. For example, on windows
  154. * 'net.minecraftforge:forge:1.11.2-13.20.0.2282', '.jar' becomes
  155. * net\minecraftforge\forge\1.11.2-13.20.0.2282\forge-1.11.2-13.20.0.2282.jar
  156. *
  157. * @param {String} artifact - the artifact id string.
  158. * @param {String} extension - the extension of the file at the resolved path.
  159. * @returns {String} - the resolved relative path from the artifact id.
  160. */
  161. function _resolvePath(artifactid, extension){
  162. let ps = artifactid.split(':')
  163. let cs = ps[0].split('.')
  164. cs.push(ps[1])
  165. cs.push(ps[2])
  166. cs.push(ps[1].concat('-').concat(ps[2]).concat(extension))
  167. return path.join.apply(path, cs)
  168. }
  169. /**
  170. * Calculates the hash for a file using the specified algorithm.
  171. *
  172. * @param {Buffer} buf - the buffer containing file data.
  173. * @param {String} algo - the hash algorithm.
  174. * @returns {String} - the calculated hash in hex.
  175. */
  176. function _calculateHash(buf, algo){
  177. return crypto.createHash(algo).update(buf).digest('hex')
  178. }
  179. /**
  180. * Used to parse a checksums file. This is specifically designed for
  181. * the checksums.sha1 files found inside the forge scala dependencies.
  182. *
  183. * @param {String} content - the string content of the checksums file.
  184. * @returns {Object} - an object with keys being the file names, and values being the hashes.
  185. */
  186. function _parseChecksumsFile(content){
  187. let finalContent = {}
  188. let lines = content.split('\n')
  189. for(let i=0; i<lines.length; i++){
  190. let bits = lines[i].split(' ')
  191. if(bits[1] == null) {
  192. continue
  193. }
  194. finalContent[bits[1]] = bits[0]
  195. }
  196. return finalContent
  197. }
  198. /**
  199. * Validate that a file exists and matches a given hash value.
  200. *
  201. * @param {String} filePath - the path of the file to validate.
  202. * @param {String} algo - the hash algorithm to check against.
  203. * @param {String} hash - the existing hash to check against.
  204. * @returns {Boolean} - true if the file exists and calculated hash matches the given hash, otherwise false.
  205. */
  206. function _validateLocal(filePath, algo, hash){
  207. //No hash provided, have to assume it's good.
  208. if(hash == null){
  209. return true
  210. }
  211. if(fs.existsSync(filePath)){
  212. let fileName = path.basename(filePath)
  213. let buf = fs.readFileSync(filePath)
  214. let calcdhash = _calculateHash(buf, algo)
  215. return calcdhash === hash
  216. }
  217. return false;
  218. }
  219. /**
  220. * Validates a file in the style used by forge's version index.
  221. *
  222. * @param {String} filePath - the path of the file to validate.
  223. * @param {Array.<String>} checksums - the checksums listed in the forge version index.
  224. * @returns {Boolean} - true if the file exists and the hashes match, otherwise false.
  225. */
  226. function _validateForgeChecksum(filePath, checksums){
  227. if(fs.existsSync(filePath)){
  228. if(checksums == null || checksums.length === 0){
  229. return true
  230. }
  231. let buf = fs.readFileSync(filePath)
  232. let calcdhash = _calculateHash(buf, 'sha1')
  233. let valid = checksums.includes(calcdhash)
  234. if(!valid && filePath.endsWith('.jar')){
  235. valid = _validateForgeJar(filePath, checksums)
  236. }
  237. return valid
  238. }
  239. return false
  240. }
  241. /**
  242. * Validates a forge jar file dependency who declares a checksums.sha1 file.
  243. * This can be an expensive task as it usually requires that we calculate thousands
  244. * of hashes.
  245. *
  246. * @param {Buffer} buf - the buffer of the jar file.
  247. * @param {Array.<String>} checksums - the checksums listed in the forge version index.
  248. * @returns {Boolean} - true if all hashes declared in the checksums.sha1 file match the actual hashes.
  249. */
  250. function _validateForgeJar(buf, checksums){
  251. const hashes = {}
  252. let expected = {}
  253. const zip = new AdmZip(buf)
  254. const zipEntries = zip.getEntries()
  255. //First pass
  256. for(let i=0; i<zipEntries.length; i++){
  257. let entry = zipEntries[i]
  258. if(entry.entryName === 'checksums.sha1'){
  259. expected = _parseChecksumsFile(zip.readAsText(entry))
  260. }
  261. hashes[entry.entryName] = _calculateHash(entry.getData(), 'sha1')
  262. }
  263. if(!checksums.includes(hashes['checksums.sha1'])){
  264. return false
  265. }
  266. //Check against expected
  267. const expectedEntries = Object.keys(expected)
  268. for(let i=0; i<expectedEntries.length; i++){
  269. if(expected[expectedEntries[i]] !== hashes[expectedEntries[i]]){
  270. return false
  271. }
  272. }
  273. return true
  274. }
  275. /**
  276. * Extracts and unpacks a file from .pack.xz format.
  277. *
  278. * @param {Array.<String>} filePaths - The paths of the files to be extracted and unpacked.
  279. * @returns {Promise.<Void>} - An empty promise to indicate the extraction has completed.
  280. */
  281. function _extractPackXZ(filePaths){
  282. return new Promise(function(fulfill, reject){
  283. const libPath = path.join(__dirname, '..', 'libraries', 'java', 'PackXZExtract.jar')
  284. const filePath = filePaths.join(',')
  285. const child = child_process.spawn('C:\\Program Files\\Java\\jre1.8.0_131\\bin\\javaw.exe', ['-jar', libPath, '-packxz', filePath])
  286. child.stdout.on('data', (data) => {
  287. //console.log('PackXZExtract:', data.toString('utf8'))
  288. })
  289. child.stderr.on('data', (data) => {
  290. //console.log('PackXZExtract:', data.toString('utf8'))
  291. })
  292. child.on('close', (code, signal) => {
  293. //console.log('PackXZExtract: Exited with code', code)
  294. fulfill()
  295. })
  296. })
  297. }
  298. /**
  299. * Initiate an async download process for an AssetGuard DLTracker.
  300. *
  301. * @param {String} identifier - the identifier of the AssetGuard DLTracker.
  302. * @param {Number} limit - optional. The number of async processes to run in parallel.
  303. * @returns {Boolean} - true if the process began, otherwise false.
  304. */
  305. function startAsyncProcess(identifier, limit = 5){
  306. let win = remote.getCurrentWindow()
  307. let acc = 0
  308. const concurrentDlTracker = instance[identifier]
  309. const concurrentDlQueue = concurrentDlTracker.dlqueue.slice(0)
  310. if(concurrentDlQueue.length === 0){
  311. return false
  312. } else {
  313. console.log(instance.progress)
  314. async.eachLimit(concurrentDlQueue, limit, function(asset, cb){
  315. let count = 0;
  316. mkpath.sync(path.join(asset.to, ".."))
  317. let req = request(asset.from)
  318. req.pause()
  319. req.on('response', (resp) => {
  320. if(resp.statusCode === 200){
  321. let writeStream = fs.createWriteStream(asset.to)
  322. writeStream.on('close', () => {
  323. //console.log('DLResults ' + asset.size + ' ' + count + ' ', asset.size === count)
  324. if(concurrentDlTracker.callback != null){
  325. concurrentDlTracker.callback.apply(concurrentDlTracker, [asset])
  326. }
  327. cb()
  328. })
  329. req.pipe(writeStream)
  330. req.resume()
  331. } else {
  332. req.abort()
  333. console.log('Failed to download ' + asset.from + '. Response code', resp.statusCode)
  334. instance.progress += asset.size*1
  335. win.setProgressBar(instance.progress/instance.totaldlsize)
  336. cb()
  337. }
  338. })
  339. req.on('data', function(chunk){
  340. count += chunk.length
  341. instance.progress += chunk.length
  342. acc += chunk.length
  343. instance.emit(identifier + 'dlprogress', acc)
  344. //console.log(identifier + ' Progress', acc/instance[identifier].dlsize)
  345. win.setProgressBar(instance.progress/instance.totaldlsize)
  346. })
  347. }, function(err){
  348. if(err){
  349. instance.emit(identifier + 'dlerror')
  350. console.log('An item in ' + identifier + ' failed to process');
  351. } else {
  352. instance.emit(identifier + 'dlcomplete')
  353. console.log('All ' + identifier + ' have been processed successfully')
  354. }
  355. instance.totaldlsize -= instance[identifier].dlsize
  356. instance.progress -= instance[identifier].dlsize
  357. instance[identifier] = new DLTracker([], 0)
  358. if(instance.totaldlsize === 0) {
  359. win.setProgressBar(-1)
  360. instance.emit('dlcomplete')
  361. }
  362. })
  363. return true
  364. }
  365. }
  366. // Validation Functions
  367. /**
  368. * Loads the version data for a given minecraft version.
  369. *
  370. * @param {String} version - the game version for which to load the index data.
  371. * @param {String} basePath - the absolute file path which will be prepended to the given relative paths.
  372. * @param {Boolean} force - optional. If true, the version index will be downloaded even if it exists locally. Defaults to false.
  373. * @returns {Promise.<Object>} - Promise which resolves to the version data object.
  374. */
  375. function loadVersionData(version, basePath, force = false){
  376. return new Promise(function(fulfill, reject){
  377. const name = version + '.json'
  378. const url = 'https://s3.amazonaws.com/Minecraft.Download/versions/' + version + '/' + name
  379. const versionPath = path.join(basePath, 'versions', version)
  380. const versionFile = path.join(versionPath, name)
  381. if(!fs.existsSync(versionFile) || force){
  382. //This download will never be tracked as it's essential and trivial.
  383. request.head(url, function(err, res, body){
  384. console.log('Preparing download of ' + version + ' assets.')
  385. mkpath.sync(versionPath)
  386. const stream = request(url).pipe(fs.createWriteStream(versionFile))
  387. stream.on('finish', function(){
  388. fulfill(JSON.parse(fs.readFileSync(versionFile)))
  389. })
  390. })
  391. } else {
  392. fulfill(JSON.parse(fs.readFileSync(versionFile)))
  393. }
  394. })
  395. }
  396. /**
  397. * Public asset validation function. This function will handle the validation of assets.
  398. * It will parse the asset index specified in the version data, analyzing each
  399. * asset entry. In this analysis it will check to see if the local file exists and is valid.
  400. * If not, it will be added to the download queue for the 'assets' identifier.
  401. *
  402. * @param {Object} versionData - the version data for the assets.
  403. * @param {String} basePath - the absolute file path which will be prepended to the given relative paths.
  404. * @param {Boolean} force - optional. If true, the asset index will be downloaded even if it exists locally. Defaults to false.
  405. * @returns {Promise.<Void>} - An empty promise to indicate the async processing has completed.
  406. */
  407. function validateAssets(versionData, basePath, force = false){
  408. return new Promise(function(fulfill, reject){
  409. _assetChainIndexData(versionData, basePath, force).then(() => {
  410. fulfill()
  411. })
  412. })
  413. }
  414. //Chain the asset tasks to provide full async. The below functions are private.
  415. /**
  416. * Private function used to chain the asset validation process. This function retrieves
  417. * the index data.
  418. * @param {Object} versionData
  419. * @param {String} basePath
  420. * @param {Boolean} force
  421. * @returns {Promise.<Void>} - An empty promise to indicate the async processing has completed.
  422. */
  423. function _assetChainIndexData(versionData, basePath, force = false){
  424. return new Promise(function(fulfill, reject){
  425. //Asset index constants.
  426. const assetIndex = versionData.assetIndex
  427. const name = assetIndex.id + '.json'
  428. const indexPath = path.join(basePath, 'assets', 'indexes')
  429. const assetIndexLoc = path.join(indexPath, name)
  430. let data = null
  431. if(!fs.existsSync(assetIndexLoc) || force){
  432. console.log('Downloading ' + versionData.id + ' asset index.')
  433. mkpath.sync(indexPath)
  434. const stream = request(assetIndex.url).pipe(fs.createWriteStream(assetIndexLoc))
  435. stream.on('finish', function() {
  436. data = JSON.parse(fs.readFileSync(assetIndexLoc, 'utf-8'))
  437. _assetChainValidateAssets(versionData, basePath, data).then(() => {
  438. fulfill()
  439. })
  440. })
  441. } else {
  442. data = JSON.parse(fs.readFileSync(assetIndexLoc, 'utf-8'))
  443. _assetChainValidateAssets(versionData, basePath, data).then(() => {
  444. fulfill()
  445. })
  446. }
  447. })
  448. }
  449. /**
  450. * Private function used to chain the asset validation process. This function processes
  451. * the assets and enqueues missing or invalid files.
  452. * @param {Object} versionData
  453. * @param {String} basePath
  454. * @param {Boolean} force
  455. * @returns {Promise.<Void>} - An empty promise to indicate the async processing has completed.
  456. */
  457. function _assetChainValidateAssets(versionData, basePath, indexData){
  458. return new Promise(function(fulfill, reject){
  459. //Asset constants
  460. const resourceURL = 'http://resources.download.minecraft.net/'
  461. const localPath = path.join(basePath, 'assets')
  462. const indexPath = path.join(localPath, 'indexes')
  463. const objectPath = path.join(localPath, 'objects')
  464. const assetDlQueue = []
  465. let dlSize = 0;
  466. //const objKeys = Object.keys(data.objects)
  467. async.forEachOfLimit(indexData.objects, 10, function(value, key, cb){
  468. const hash = value.hash
  469. const assetName = path.join(hash.substring(0, 2), hash)
  470. const urlName = hash.substring(0, 2) + "/" + hash
  471. const ast = new Asset(key, hash, String(value.size), resourceURL + urlName, path.join(objectPath, assetName))
  472. if(!_validateLocal(ast.to, 'sha1', ast.hash)){
  473. dlSize += (ast.size*1)
  474. assetDlQueue.push(ast)
  475. }
  476. cb()
  477. }, function(err){
  478. instance.assets = new DLTracker(assetDlQueue, dlSize)
  479. instance.totaldlsize += dlSize*1
  480. fulfill()
  481. })
  482. })
  483. }
  484. /**
  485. * Public library validation function. This function will handle the validation of libraries.
  486. * It will parse the version data, analyzing each library entry. In this analysis, it will
  487. * check to see if the local file exists and is valid. If not, it will be added to the download
  488. * queue for the 'libraries' identifier.
  489. *
  490. * @param {Object} versionData - the version data for the assets.
  491. * @param {String} basePath - the absolute file path which will be prepended to the given relative paths.
  492. * @returns {Promise.<Void>} - An empty promise to indicate the async processing has completed.
  493. */
  494. function validateLibraries(versionData, basePath){
  495. return new Promise(function(fulfill, reject){
  496. const libArr = versionData.libraries
  497. const libPath = path.join(basePath, 'libraries')
  498. const libDlQueue = []
  499. let dlSize = 0
  500. //Check validity of each library. If the hashs don't match, download the library.
  501. async.eachLimit(libArr, 5, function(lib, cb){
  502. if(Library.validateRules(lib.rules)){
  503. let artifact = (lib.natives == null) ? lib.downloads.artifact : lib.downloads.classifiers[lib.natives[Library.mojangFriendlyOS()]]
  504. const libItm = new Library(lib.name, artifact.sha1, artifact.size, artifact.url, path.join(libPath, artifact.path))
  505. if(!_validateLocal(libItm.to, 'sha1', libItm.hash)){
  506. dlSize += (libItm.size*1)
  507. libDlQueue.push(libItm)
  508. }
  509. }
  510. cb()
  511. }, function(err){
  512. instance.libraries = new DLTracker(libDlQueue, dlSize)
  513. instance.totaldlsize += dlSize*1
  514. fulfill()
  515. })
  516. })
  517. }
  518. /**
  519. * Public miscellaneous mojang file validation function. These files will be enqueued under
  520. * the 'files' identifier.
  521. *
  522. * @param {Object} versionData - the version data for the assets.
  523. * @param {String} basePath - the absolute file path which will be prepended to the given relative paths.
  524. * @returns {Promise.<Void>} - An empty promise to indicate the async processing has completed.
  525. */
  526. function validateMiscellaneous(versionData, basePath){
  527. return new Promise(async function(fulfill, reject){
  528. await validateClient(versionData, basePath)
  529. await validateLogConfig(versionData, basePath)
  530. fulfill()
  531. })
  532. }
  533. /**
  534. * Validate client file - artifact renamed from client.jar to '{version}'.jar.
  535. *
  536. * @param {Object} versionData - the version data for the assets.
  537. * @param {String} basePath - the absolute file path which will be prepended to the given relative paths.
  538. * @param {Boolean} force - optional. If true, the asset index will be downloaded even if it exists locally. Defaults to false.
  539. * @returns {Promise.<Void>} - An empty promise to indicate the async processing has completed.
  540. */
  541. function validateClient(versionData, basePath, force = false){
  542. return new Promise(function(fulfill, reject){
  543. const clientData = versionData.downloads.client
  544. const version = versionData.id
  545. const targetPath = path.join(basePath, 'versions', version)
  546. const targetFile = version + '.jar'
  547. let client = new Asset(version + ' client', clientData.sha1, clientData.size, clientData.url, path.join(targetPath, targetFile))
  548. if(!_validateLocal(client.to, 'sha1', client.hash) || force){
  549. instance.files.dlqueue.push(client)
  550. instance.files.dlsize += client.size*1
  551. fulfill()
  552. } else {
  553. fulfill()
  554. }
  555. })
  556. }
  557. /**
  558. * Validate log config.
  559. *
  560. * @param {Object} versionData - the version data for the assets.
  561. * @param {String} basePath - the absolute file path which will be prepended to the given relative paths.
  562. * @param {Boolean} force - optional. If true, the asset index will be downloaded even if it exists locally. Defaults to false.
  563. * @returns {Promise.<Void>} - An empty promise to indicate the async processing has completed.
  564. */
  565. function validateLogConfig(versionData, basePath){
  566. return new Promise(function(fulfill, reject){
  567. const client = versionData.logging.client
  568. const file = client.file
  569. const targetPath = path.join(basePath, 'assets', 'log_configs')
  570. let logConfig = new Asset(file.id, file.sha1, file.size, file.url, path.join(targetPath, file.id))
  571. if(!_validateLocal(logConfig.to, 'sha1', logConfig.hash)){
  572. instance.files.dlqueue.push(logConfig)
  573. instance.files.dlsize += client.size*1
  574. fulfill()
  575. } else {
  576. fulfill()
  577. }
  578. })
  579. }
  580. function validateDistribution(serverpackid, basePath){
  581. return new Promise(function(fulfill, reject){
  582. let distroindex = _chainValidateDistributionIndex(basePath).then((value) => {
  583. let servers = value.servers
  584. let serv = null
  585. for(let i=0; i<servers.length; i++){
  586. if(servers[i].id === serverpackid){
  587. serv = servers[i]
  588. break
  589. }
  590. }
  591. instance.forge = _parseDistroModules(serv.modules, basePath, serv.mc_version)
  592. //Correct our workaround here.
  593. let decompressqueue = instance.forge.callback
  594. instance.forge.callback = function(asset){
  595. if(asset.to.toLowerCase().endsWith('.pack.xz')){
  596. _extractPackXZ([asset.to])
  597. }
  598. }
  599. console.log(instance.forge)
  600. instance.totaldlsize += instance.forge.dlsize*1
  601. fulfill()
  602. })
  603. })
  604. }
  605. //TODO The distro index should be downloaded in the 'pre-loader'. This is because
  606. //we will eventually NEED the index to generate the server list on the ui.
  607. function _chainValidateDistributionIndex(basePath){
  608. return new Promise(function(fulfill, reject){
  609. //const distroURL = 'http://mc.westeroscraft.com/WesterosCraftLauncher/westeroscraft.json'
  610. const targetFile = path.join(basePath, 'westeroscraft.json')
  611. //TEMP WORKAROUND TO TEST WHILE THIS IS NOT HOSTED
  612. fs.readFile(path.join(basePath, '..', 'app', 'assets', 'westeroscraft.json'), 'utf-8', (err, data) => {
  613. fulfill(JSON.parse(data))
  614. })
  615. })
  616. }
  617. function _parseDistroModules(modules, basePath, version){
  618. let alist = []
  619. let asize = 0;
  620. //This may be removed soon, considering the most efficient way to extract.
  621. let decompressqueue = []
  622. for(let i=0; i<modules.length; i++){
  623. let ob = modules[i]
  624. let obType = ob.type
  625. let obArtifact = ob.artifact
  626. let obPath = obArtifact.path == null ? _resolvePath(ob.id, obArtifact.extension) : obArtifact.path
  627. switch(obType){
  628. case 'forge-hosted':
  629. obPath = path.join(basePath, 'libraries', obPath)
  630. break;
  631. case 'library':
  632. obPath = path.join(basePath, 'libraries', obPath)
  633. break;
  634. case 'forgemod':
  635. obPath = path.join(basePath, 'mods', obPath)
  636. break;
  637. case 'litemod':
  638. obPath = path.join(basePath, 'mods', version, obPath)
  639. break;
  640. default:
  641. obPath = path.join(basePath, obPath)
  642. }
  643. let artifact = new Asset(ob.id, obArtifact.MD5, obArtifact.size, obArtifact.url, obPath)
  644. if(obPath.toLowerCase().endsWith('.pack.xz')){
  645. if(!_validateLocal(obPath.substring(0, obPath.toLowerCase().lastIndexOf('.pack.xz')), 'MD5', artifact.hash)){
  646. asize += artifact.size*1
  647. alist.push(artifact)
  648. decompressqueue.push(obPath)
  649. }
  650. } else if(!_validateLocal(obPath, 'MD5', artifact.hash)){
  651. asize += artifact.size*1
  652. alist.push(artifact)
  653. }
  654. if(ob.sub_modules != null){
  655. let dltrack = _parseDistroModules(ob.sub_modules, basePath, version)
  656. asize += dltrack.dlsize*1
  657. alist = alist.concat(dltrack.dlqueue)
  658. decompressqueue = decompressqueue.concat(dltrack.callback)
  659. }
  660. }
  661. return new DLTracker(alist, asize, decompressqueue)
  662. }
  663. /**
  664. * This function will initiate the download processed for the specified identifiers. If no argument is
  665. * given, all identifiers will be initiated. Note that in order for files to be processed you need to run
  666. * the processing function corresponding to that identifier. If you run this function without processing
  667. * the files, it is likely nothing will be enqueued in the global object and processing will complete
  668. * immediately. Once all downloads are complete, this function will fire the 'dlcomplete' event on the
  669. * global object instance.
  670. *
  671. * @param {Array.<{id: string, limit: number}>} identifiers - optional. The identifiers to process and corresponding parallel async task limit.
  672. */
  673. function processDlQueues(identifiers = [{id:'assets', limit:20}, {id:'libraries', limit:5}, {id:'files', limit:5}, {id:'forge', limit:5}]){
  674. this.progress = 0;
  675. let win = remote.getCurrentWindow()
  676. let shouldFire = true
  677. for(let i=0; i<identifiers.length; i++){
  678. let iden = identifiers[i]
  679. let r = startAsyncProcess(iden.id, iden.limit)
  680. if(r) shouldFire = false
  681. }
  682. if(shouldFire){
  683. instance.emit('dlcomplete')
  684. }
  685. }
  686. module.exports = {
  687. loadVersionData,
  688. validateAssets,
  689. validateLibraries,
  690. validateMiscellaneous,
  691. validateDistribution,
  692. processDlQueues,
  693. instance,
  694. Asset,
  695. Library
  696. }