-
Notifications
You must be signed in to change notification settings - Fork 30
/
logic.js
740 lines (740 loc) · 26.7 KB
/
logic.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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
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
189
190
191
192
193
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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
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
375
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
413
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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
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
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
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
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
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
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
const { execSync } = require("child_process");
const fs = require('fs');
const superAgent = require('superagent');
const admZip = require("adm-zip");
const config = require('./configLoader.js');
// builds content from template and input
const fromTemplate = (template, input) => {
for (let item in input) {
template = template.replaceAll(`{${item}}`, input[item]);
}
return template;
}
// retrieves org & repoName from git url
const parseGitUrl = (gitUrl) => {
const type = gitUrl.slice(0, 4);
switch (type) {
case 'git@': {
gitUrl = gitUrl.replace('git@', '');
gitUrl = gitUrl.replace('.git', '');
let pieces = gitUrl.split(':');
const host = pieces[0];
pieces = pieces[1].split('/');
return {
host,
org: pieces[0],
repoName: pieces[1]
}
break;
}
case 'http': {
gitUrl = gitUrl.replace('https://', '');
gitUrl = gitUrl.replace('.git', '');
const pieces = gitUrl.split('/');
return {
host: pieces[0],
org: pieces[1],
repoName: pieces[2]
}
break;
}
}
}
// get file from source and optionally parse it as JSON
const getFile = async (source, parseJson) => {
const local = source.indexOf('http') !== 0 ? true : false;
let output;
if (local) {
if (!fs.existsSync(source)) {
return '';
}
output = fs.readFileSync(source, 'utf-8');
}
else {
output = (await superAgent.get(source).set('User-Agent', 'h5p-cli').ok(res => [200, 404].includes(res.status))).text;
}
if (output == '404: Not Found') {
return '';
}
if (parseJson) {
output = JSON.parse(output);
}
return output;
}
// clone repo and retrieve file
const getRepoFile = (gitUrl, path, branch = 'master', parseJson, cleanStart) => {
const { repoName } = parseGitUrl(gitUrl);
const target = `${config.folders.temp}/${repoName}_${branch}`;
const filePath = `${target}/${path}`;
if (cleanStart) {
fs.rmSync(target, { recursive: true, force: true });
}
if (!fs.existsSync(target)) {
execSync(`git clone ${gitUrl} ${target} --branch ${branch}`, { stdio : 'pipe' }).toString();
}
if (!fs.existsSync(filePath)) {
return '';
}
const data = fs.readFileSync(filePath, 'utf-8');
return parseJson ? JSON.parse(data) : data;
}
// generates list of files and their relative paths in a folder tree
const getFileList = (folder) => {
const output = [];
let toDo = [folder];
let list = [];
const compute = () => {
for (let item of list) {
const dirs = fs.readdirSync(item);
for (let entry of dirs) {
const file = `${item}/${entry}`;
if (fs.lstatSync(file).isDirectory()) {
toDo.push(file);
}
else {
output.push(file);
}
}
}
}
while (toDo.length) {
list = toDo;
toDo = [];
compute();
}
return output;
}
module.exports = {
// debug console log
log: function (message) {
if (process.argv[2] === 'server') {
return;
}
console.log(message);
},
// debug process.stdout.write
write: function (message) {
if (process.argv[2] === 'server') {
return;
}
process.stdout.write(message);
},
// imports content type from zip archive file in the .h5p format
import: (folder, archive) => {
const target = `${config.folders.temp}/${folder}`;
new admZip(archive).extractAllTo(target);
fs.renameSync(`${target}/content`, `content/${folder}`);
fs.renameSync(`${target}/h5p.json`, `content/${folder}/h5p.json`);
fs.rmSync(target, { recursive: true, force: true });
return folder;
},
// creates zip archive export file in the .h5p format
export: async (library, folder) => {
const registry = await module.exports.getRegistry();
const libraryDirs = await module.exports.parseLibraryFolders();
const libFolder = libraryDirs[registry.regular[library].id];
const target = `${config.folders.temp}/${folder}`;
fs.rmSync(target, { recursive: true, force: true });
fs.mkdirSync(target);
fs.cpSync(`content/${folder}`, `${target}/content`, { recursive: true });
fs.renameSync(`${target}/content/h5p.json`, `${target}/h5p.json`);
fs.rmSync(`${target}/content/sessions`, { recursive: true, force: true });
let libs = await module.exports.computeDependencies(library, 'view', null, libFolder);
const editLibs = await module.exports.computeDependencies(library, 'edit', null, libFolder);
libs = {...libs, ...editLibs};
for (let item in libs) {
const folder = libraryDirs[libs[item].id];
fs.cpSync(`${config.folders.libraries}/${folder}`, `${target}/${folder}`, { recursive: true });
}
const files = getFileList(target);
const zip = new admZip();
for (let item of files) {
const file = item;
item = item.replace(target, '');
let path = item.split('/');
const name = path.pop();
if (config.files.patterns.ignored.test(name) || !config.files.patterns.allowed.test(name)) {
continue;
}
path = path.join('/');
zip.addLocalFile(file, path);
}
const zipped = `${target}.h5p`;
zip.writeZip(zipped);
fs.rmSync(target, { recursive: true, force: true });
return zipped;
},
/* retrieves list of h5p librarie
ignoreFile - if true file is overwritten with online data */
getRegistry: async (ignoreFile) => {
let list;
if (!ignoreFile && fs.existsSync(config.registry)) {
list = JSON.parse(fs.readFileSync(config.registry, 'utf-8'));
}
else {
list = await getFile(config.urls.registry, true);
}
const output = {
regular: {},
reversed: {}
}
for (let item in list) {
if (list[item].repo) {
if (!list[item].repoName) {
list[item].repoName = list[item].repo.url.split('/').slice(-1)[0];
}
if (!list[item].org) {
list[item].org = list[item].repo.url.split('/').slice(3, 4)[0];
}
}
if (!list[item].shortName) {
list[item].shortName = list[item].repoName;
}
delete list[item].resume;
delete list[item].fullscreen;
delete list[item].xapiVerbs;
output.reversed[list[item].id] = list[item];
output.regular[list[item].shortName] = list[item];
}
if (ignoreFile) {
fs.writeFileSync(config.registry, JSON.stringify(list));
}
return output;
},
/* computes list of library dependencies in their correct load order
mode - 'view' or 'edit' to compute non-editor or editor dependencies
version - optional version to compute; defaults to 'master'
folder - optional local library folder to use instead of git repo; use "" to ignore */
computeDependencies: async (library, mode, version, folder) => {
module.exports.log(`> ${library} deps ${mode}`);
version = version || 'master';
let level = -1;
let registry = {};
const toDo = {};
const cache = {};
const done = {};
const weights = {};
toDo[library] = {
parent: '',
version,
folder
};
const libraryDirs = await module.exports.parseLibraryFolders();
const getOptionals = async (dep, org, repoName, version, dir) => {
if (cache[dep].optionals) {
return cache[dep].optionals;
}
cache[dep].semantics = dir ? await getFile(`${config.folders.libraries}/${dir}/semantics.json`, true)
: getRepoFile(fromTemplate(config.urls.library.clone, { org, repo: repoName }), 'semantics.json', version, true);
cache[dep].optionals = parseSemanticLibraries(cache[dep].semantics);
return cache[dep].optionals;
}
const latestPatch = (org, repo, version) => {
const tags = module.exports.tags(org, repo);
let patch = -1;
for (let item of tags) {
if (item.indexOf(version) != 0) {
continue;
}
const numbers = item.split('.');
if (numbers.length < 3) {
continue;
}
if (numbers[2] > patch) {
patch = numbers[2];
break;
}
}
return patch > -1 ? `${version}.${patch}` : version;
}
// determine if dependency needs to be processed
const handleDepListEntry = (machineName, parent, ver, dir) => {
const lib = registry.reversed[machineName];
const entry = lib?.shortName;
if (!entry) {
const optional = isOptional(cache[parent], machineName);
if (!done[level][machineName] || done[level][machineName].optional) {
done[level][machineName] = { optional, parent };
}
const parentVersion = `${done[level][parent].version.major}.${done[level][parent].version.minor}.${done[level][parent].version.patch}`;
process.stdout.write(`\n!!! ${optional ? 'optional' : 'required'} library ${machineName} ${ver} not found in registry; required by ${parent} (${parentVersion}) `);
return;
}
const version = ver == 'master' ? ver : latestPatch(lib.org, entry, ver);
if (!done[level][entry]?.id && !toDo[entry]?.parent) {
toDo[entry] = { parent, version, folder: dir };
}
weights[entry] = weights[entry] ? weights[entry] + 1 : 1;
return;
}
// determine if a library is a soft dependency of its parent
const isOptional = (parent, machineName) => {
if (!parent) {
return false;
}
if (parent && parent.optional) {
return true;
}
const finder = (element) => element.machineName === machineName;
if (parent?.preloadedDependencies?.find(finder) !== undefined || parent?.editorDependencies?.find(finder) !== undefined) {
return false;
}
return true;
}
const compute = async (org, dep, version) => {
const parent = toDo[dep].parent ? `/${toDo[dep].parent}` : '';
const lastParent = registry.regular[toDo[dep].parent]?.requiredBy[registry.regular[toDo[dep].parent]?.requiredBy.length - 1] || '';
const requiredByPath = lastParent + parent;
if (pathHasDuplicates(requiredByPath)) {
delete toDo[dep];
return;
}
if (registry.regular[dep].requiredBy && registry.regular[dep].requiredBy.includes(requiredByPath)) {
delete toDo[dep];
return;
}
done[level][dep] = registry.regular[dep];
let list;
const { repoName } = registry.regular[dep]?.repo?.url ? parseGitUrl(registry.regular[dep].repo.url) : dep;
if (cache[dep]) {
list = cache[dep];
}
else {
list = toDo[dep].folder ? await getFile(`${config.folders.libraries}/${toDo[dep].folder}/library.json`, true)
: getRepoFile(fromTemplate(config.urls.library.clone, { org, repo: repoName }), 'library.json', version, true);
cache[dep] = list;
}
if (!list.title) {
throw new Error(`missing library.json for ${toDo[dep].folder || dep}`);
}
done[level][dep].title = list.title;
done[level][dep].version = {
major: list.majorVersion,
minor: list.minorVersion,
patch: list.patchVersion
}
done[level][dep].runnable = list.runnable;
done[level][dep].optional = registry.regular[dep].optional === false ? false : isOptional(cache[toDo[dep].parent], list.machineName);
cache[dep].optional = done[level][dep].optional;
module.exports.write(`>> ${dep} required by ${toDo[dep].parent} (${done[level][dep].optional ? 'optional' : 'required'}) ... `);
done[level][dep].preloadedJs = list.preloadedJs || [];
done[level][dep].preloadedCss = list.preloadedCss || [];
done[level][dep].preloadedDependencies = list.preloadedDependencies || [];
done[level][dep].editorDependencies = list.editorDependencies || [];
done[level][dep].metadataSettings = list.metadataSettings;
if (!done[level][dep].requiredBy) {
done[level][dep].requiredBy = [];
}
done[level][dep].requiredBy.push(requiredByPath);
done[level][dep].level = level;
let ver = version == 'master' ? version : `${done[level][dep].version.major}.${done[level][dep].version.minor}.${done[level][dep].version.patch}`;
const optionals = await getOptionals(dep, org, repoName, ver, toDo[dep].folder);
if (list.preloadedDependencies) {
for (let item of list.preloadedDependencies) {
ver = version == 'master' ? version : `${item.majorVersion}.${item.minorVersion}`;
const dir = folder ? libraryDirs[item.machineName] : null;
handleDepListEntry(item.machineName, dep, ver, dir);
}
}
for (let item in optionals) {
ver = version == 'master' ? version : optionals[item].version;
const dir = folder ? libraryDirs[item] : null;
handleDepListEntry(item, dep, ver, dir);
}
if (mode == 'edit' && list.editorDependencies) {
for (let item of list.editorDependencies) {
ver = version == 'master' ? version : `${item.majorVersion}.${item.minorVersion}`;
const dir = folder ? libraryDirs[item.machineName] : null;
handleDepListEntry(item.machineName, dep, ver, dir);
}
}
delete toDo[dep];
module.exports.log('done');
}
registry = await module.exports.getRegistry();
if (!folder && !registry.regular[library]) {
throw new Error(`unregistered ${library} library`);
}
while (Object.keys(toDo).length) {
level++;
module.exports.log(`>> on level ${level}`);
done[level] = {};
for (let item in toDo) {
await compute(registry.regular[item].org, item, toDo[item].version);
}
}
let output = {};
for (let i = level; i >= 0; i--) {
const keys = Object.keys(done[i]);
keys.sort((a, b) => {
return weights[b] - weights[a];
});
for (let key of keys) {
if (!output[key] || output[key]?.optional) {
output[key] = done[i][key];
}
if (!done[i][key].id) {
continue;
}
}
}
module.exports.write('\n');
return output;
},
// list tags for library using git
tags: (org, repo, mainBranch = 'master') => {
const library = getRepoFile(fromTemplate(config.urls.library.clone, { org, repo }), 'library.json', mainBranch, true);
const label = `${repo}_${mainBranch}`;
const folder = `${config.folders.temp}/${label}`;
if (!fs.existsSync(folder)) {
module.exports.clone(org, repo, mainBranch, label);
}
execSync(`git checkout ${mainBranch}`, { cwd: folder, stdio : 'pipe' });
execSync(`git pull origin ${mainBranch}`, { cwd: folder, stdio : 'pipe' });
const tags = execSync('git tag', { cwd: folder }).toString().split('\n');
const output = [];
for (let item of tags) {
if (!item) {
continue;
}
output.push(item);
}
output.sort((a, b) => {
a = a.split('.');
b = b.split('.');
return b[0] - a[0] || b[1] - a[1] || b[2] - a[2];
});
return output;
},
// download & unzip repository
download: async (org, repo, version, target) => {
const blob = (await superAgent.get(fromTemplate(config.urls.library.zip, { org, repo, version })))._body;
const zipFile = `${config.folders.temp}/temp.zip`;
fs.writeFileSync(zipFile, blob);
new admZip(zipFile).extractAllTo(config.folders.libraries);
fs.rmSync(zipFile);
fs.renameSync(`${config.folders.libraries}/${repo}-master`, target);
},
// clone repository using git
clone: (org, repo, branch, target) => {
return execSync(`git clone ${fromTemplate(config.urls.library.clone, {org, repo})} ${target} --branch ${branch}`, { cwd: config.folders.libraries }).toString();
},
/* clones/downloads dependencies to libraries folder using git and runs relevant npm commands
mode - 'view' or 'edit' to fetch non-editor or editor libraries
latest - if true master branch versions of libraries are used
toSkip - optional array of libraries to skip; after a library is parsed by the function it's auto-added to the array so it's skipped for efficiency */
getWithDependencies: async (action, library, mode, latest, toSkip = []) => {
const list = await module.exports.computeDependencies(library, mode);
for (let item in list) {
if (toSkip.indexOf(item) != -1) {
continue;
}
toSkip.push(item);
if (!list[item].id) {
if (list[item].optional) {
console.log(`> skipping optional unregistered ${item} library`);
continue;
}
else {
throw new Error(`unregistered ${item} library`);
}
}
const label = `${list[item].id}-${list[item].version.major}.${list[item].version.minor}`;
const listVersion = `${list[item].version.major}.${list[item].version.minor}.${list[item].version.patch}`;
const version = latest ? 'master' : listVersion;
const folder = `${config.folders.libraries}/${label}`;
if (fs.existsSync(folder)) {
if (latest && !process.env.H5P_NO_UPDATES) {
console.log(`>> ~ updating to ${list[item].repoName} ${listVersion}`);
execSync(`git checkout master`, { cwd: folder, stdio : 'pipe' });
console.log(execSync('git pull origin', { cwd: folder }).toString());
}
else {
console.log(`>> ~ skipping updates for ${list[item].repoName} ${listVersion}`);
}
continue;
}
console.log(`>> + installing ${list[item].repoName} ${listVersion}`);
if (action == 'download') {
await module.exports.download(list[item].org, list[item].repoName, version, folder);
}
else {
console.log(module.exports.clone(list[item].org, list[item].repoName, version, label));
}
const packageFile = `${folder}/package.json`;
if (!fs.existsSync(packageFile)) {
continue;
}
const info = JSON.parse(fs.readFileSync(packageFile));
if (!info?.scripts?.build) {
continue;
}
console.log('>>> npm install');
console.log(execSync('npm install', {cwd: folder}).toString());
console.log('>>> npm run build');
console.log(execSync('npm run build', {cwd: folder}).toString());
fs.rmSync(`${folder}/node_modules`, { recursive: true, force: true });
}
return toSkip;
},
/* checks if dependencies are installed for a given library;
returns a report with boolean statuses; the overall status is reflected under the "ok" attribute;*/
verifySetup: async (library) => {
const registry = await module.exports.getRegistry();
const libraryDirs = await module.exports.parseLibraryFolders();
const libFolder = libraryDirs[registry.regular[library].id];
const output = {
registry: registry.regular[library] ? true : false,
libraries: {},
ok: true
}
if (!output.registry) {
output.ok = false;
}
let list = await module.exports.computeDependencies(library, 'view', null, libFolder);
list = {...list, ...await module.exports.computeDependencies(library, 'edit', null, libFolder)};
for (let item in list) {
if (!list[item]?.id) {
output.libraries[item] = {
optional: list[item].optional,
present: false
}
if (!list[item].optional) {
output.ok = false;
}
continue;
}
const label = `${list[item].id}-${list[item].version.major}.${list[item].version.minor}`;
output.libraries[label] = {
optional: list[item].optional,
present: fs.existsSync(`${config.folders.libraries}/${libraryDirs[list[item].id]}`)
}
if (!list[item].optional && !output.libraries[label].present) {
output.ok = false;
}
}
return output;
},
// generates h5p.json file with info describing the library in the specified folder
generateInfo: async (folder, library) => {
const registry = await module.exports.getRegistry();
const libraryDirs = await module.exports.parseLibraryFolders();
const libFolder = libraryDirs[registry.regular[library].id];
const target = `content/${folder}`;
let libs = await module.exports.computeDependencies(library, 'view', null, libFolder);
const editLibs = await module.exports.computeDependencies(library, 'edit', null, libFolder);
libs = {...libs, ...editLibs};
const map = {};
const preloadedDependencies = [];
for (let item in libs) {
for (let predep of libs[item].preloadedDependencies) {
if (map[predep.machineName]) {
continue;
}
map[predep.machineName] = true;
preloadedDependencies.push(predep);
}
}
preloadedDependencies.push({
machineName: libs[library].id,
minorVersion: libs[library].version.minor,
majorVersion: libs[library].version.major,
});
const info = {
title: folder,
language: 'en',
mainLibrary: libs[library].id,
license: 'U',
defaultLanguage: 'en',
embedTypes: ['div'],
preloadedDependencies
};
fs.writeFileSync(`${target}/h5p.json`, JSON.stringify(info));
},
// upgrades content via current main library upgrades.js scripts
upgrade: async (folder, library) => {
const registry = await module.exports.getRegistry();
const libraryDirs = await module.exports.parseLibraryFolders();
const libFolder = libraryDirs[registry.regular[library].id];
const lib = (await module.exports.computeDependencies(library, 'view', null, libFolder))[library];
const info = JSON.parse(fs.readFileSync(`content/${folder}/h5p.json`, 'utf-8'));
const extraAttrs = [
'authors', 'source', 'license', 'licenseVersion', 'licenseExtras', 'yearsFrom',
'yearsTo', 'changes', 'authorComments', 'w', 'h', 'metaKeywords', 'metaDescription'
];
const extra = {};
for (let item of extraAttrs) {
extra[item] = info[item];
}
let mainLib = {};
for (let item of info.preloadedDependencies) {
if (item.machineName == lib.id) {
mainLib = item;
break;
}
}
mainLib.majorVersion = parseInt(mainLib.majorVersion);
mainLib.minorVersion = parseInt(mainLib.minorVersion);
lib.version.major = parseInt(lib.version.major);
lib.version.minor = parseInt(lib.version.minor);
if (lib.version.major <= mainLib.majorVersion && lib.version.minor <= mainLib.minorVersion) {
return;
}
const upgradesFile = `${config.folders.libraries}/${libraryDirs[lib.id]}/upgrades.js`;
if (!fs.existsSync(upgradesFile)) {
return;
}
const contentFile = `content/${folder}/content.json`;
let content = fs.readFileSync(contentFile, 'utf-8');
const backupContent = content;
content = JSON.parse(content);
eval(fs.readFileSync(upgradesFile, 'utf-8'));
let upgraded = false;
for (let major in H5PUpgrades[lib.id]) {
major = parseInt(major);
if (mainLib.majorVersion > major) {
continue;
}
for (let minor in H5PUpgrades[lib.id][major]) {
minor = parseInt(minor);
if (mainLib.majorVersion == major && mainLib.minorVersion >= minor) {
continue;
}
upgraded = true;
console.log(`>>> running content upgrade script for ${library} version ${major}.${minor}`);
H5PUpgrades[lib.id][major][minor](content, (error, result) => {
content = result;
}, extra);
}
}
if (!upgraded) {
return;
}
const label = `${mainLib.majorVersion}.${mainLib.minorVersion}`;
fs.writeFileSync(`content/${folder}/${label}_content.json`, backupContent);
fs.writeFileSync(`content/${folder}/${label}_h5p.json`, JSON.stringify(info));
fs.writeFileSync(contentFile, JSON.stringify(content));
module.exports.generateInfo(folder, library);
},
parseLibraryFolders: async () => {
const registry = await module.exports.getRegistry();
const output = {};
const dirs = fs.readdirSync(config.folders.libraries);
for (let folder of dirs) {
const libraryFile = `${config.folders.libraries}/${folder}/library.json`;
if (!fs.existsSync(libraryFile)) {
continue;
}
const info = await module.exports.getFile(libraryFile, true);
const id = info.machineName;
output[id] = folder;
if (!registry.reversed[id]) {
registry.reversed[id] =
{
"id": id,
"title": info.title,
"author": info.author,
"runnable": info.runnable,
"shortName": module.exports.machineToShort(id)
}
fs.writeFileSync(config.registry, JSON.stringify(registry.reversed));
console.log(`> registered local library ${id}`);
}
}
return output;
},
machineToShort: (machineName) => {
machineName = machineName.replace('H5PEditor', 'H5P-Editor');
return machineName.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase().replace('.', '-');
},
registryEntryFromRepoUrl: function(gitUrl) {
let { host, org, repoName } = parseGitUrl(gitUrl);
const list = getRepoFile(gitUrl, 'library.json', 'master', true);
const shortName = module.exports.machineToShort(list.machineName);
const type = host.split('.')[0];
const output = {};
output[list.machineName] = {
id: list.machineName,
title: list.title,
repo: {
type: type,
url: `https://${host}/${org}/${repoName}`
},
author: list.author,
runnable: list.runnable,
shortName,
repoName,
org
}
return output;
},
fromTemplate,
parseGitUrl,
getFile,
getFileList
}
// determines if provided path has duplicate entries; entries are separated by '/';
const pathHasDuplicates = (path) => {
const ledger = {};
const list = path.split('/');
for (let item of list) {
if (ledger[item]) {
return true;
}
else {
ledger[item] = true;
}
}
return false;
}
// parses semantics array of objects for entries of library type
const parseSemanticLibraries = (entries) => {
if (!Array.isArray(entries)) {
return {};
}
let toDo = [];
let list = [];
const output = {};
const parseList = () => {
toDo = [];
for (let obj of list) { // go through semantics array entries
if (obj?.type === 'library' && Array.isArray(obj?.options)) {
for (let lib of obj.options) {
const parts = lib.split(' ');
output[parts[0]] = {
name: parts[0],
version: parts[1]
};
}
continue;
}
for (let attr in obj) { // go through entry attributes
if (attr === 'fields' && Array.isArray(obj[attr])) {
for (let item of obj[attr]) {
if (item?.type === 'library' && Array.isArray(item?.options)) {
for (let lib of item.options) {
const parts = lib.split(' ');
output[parts[0]] = {
name: parts[0],
version: parts[1]
};
}
}
else {
toDo.push(item);
}
}
}
if (typeof obj[attr] === 'object' && !Array.isArray(obj[attr])) {
toDo.push(obj[attr]);
}
}
}
list = toDo;
}
list = entries;
while (list.length) {
parseList();
}
return output;
}