-
Notifications
You must be signed in to change notification settings - Fork 11
/
server.js
4618 lines (3875 loc) · 198 KB
/
server.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
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @preserve
*
* .,,,;;,'''..
* .'','... ..',,,.
* .,,,,,,',,',;;:;,. .,l,
* .,',. ... ,;, :l.
* ':;. .'.:do;;. .c ol;'.
* ';;' ;.; ', .dkl';, .c :; .'.',::,,'''.
* ',,;;;,. ; .,' .'''. .'. .d;''.''''.
* .oxddl;::,,. ', .'''. .... .'. ,:;..
* .'cOX0OOkdoc. .,'. .. ..... 'lc.
* .:;,,::co0XOko' ....''..'.'''''''.
* .dxk0KKdc:cdOXKl............. .. ..,c....
* .',lxOOxl:'':xkl,',......'.... ,'.
* .';:oo:... .
* .cd, ╔═╗┌─┐┬─┐┬ ┬┌─┐┬─┐ .
* .l; ╚═╗├┤ ├┬┘└┐┌┘├┤ ├┬┘ '
* 'l. ╚═╝└─┘┴└─ └┘ └─┘┴└─ '.
* .o. ...
* .''''','.;:''.........
* .' .l
* .:. l'
* .:. .l.
* .x: :k;,.
* cxlc; cdc,,;;.
* 'l :.. .c ,
* o.
* .,
*
* ╦ ╦┬ ┬┌┐ ┬─┐┬┌┬┐ ╔═╗┌┐ ┬┌─┐┌─┐┌┬┐┌─┐
* ╠═╣└┬┘├┴┐├┬┘│ ││ ║ ║├┴┐ │├┤ │ │ └─┐
* ╩ ╩ ┴ └─┘┴└─┴─┴┘ ╚═╝└─┘└┘└─┘└─┘ ┴ └─┘
*
* Created by Valentin on 10/22/14.
* Modified by Carsten on 12/06/15.
* Modified by Psomdecerff (PCS) on 12/21/15.
*
* Copyright (c) 2015 Valentin Heun
*
* All ascii characters above must be included in any redistribution.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
/**********************************************************************************************************************
******************************************** constant settings *******************************************************
**********************************************************************************************************************/
try {
require('module-alias/register');
} catch (err) {
console.clear();
console.warn('\x1b[33mYou\'re not done with the installation! You need to execute the following commands:');
console.warn('\x1b[0m1.\x1b[32m npm install');
console.warn('\x1b[0m2.\x1b[32m git submodule update --init --recursive');
console.warn('\x1b[0m3.\x1b[32m cd addons/vuforia-spatial-core-addon');
console.warn('\x1b[0m4.\x1b[32m npm install', '\x1b[0m');
console.warn('');
console.warn('');
console.warn('\x1b[33mWhenever you install a new addon make sure to:', '\x1b[0m');
console.warn('\x1b[0m3.\x1b[32m cd addons/<new addon folder>');
console.warn('\x1b[0m4.\x1b[32m npm install', '\x1b[0m');
if (process.send) {
process.send('exit');
}
let keepRunning = true;
while (keepRunning) {
// Since process.send is async, just hold the server for preventing more errors
}
}
const _logger = require('./logger');
const {objectsPath, beatPort, serverPort, allowSecureMode, persistToCloud} = require('./config');
const {providedServices} = require('./services');
const os = require('os');
const {isLightweightMobile, isStandaloneMobile} = require('./isMobile.js');
// These variables are used for global status, such as if the server sends debugging messages and if the developer
// user interfaces should be accesable
const globalVariables = {
// Show developer web GUI
developer: true,
// Send more debug messages to console
debug: false,
isMobile: isLightweightMobile && !isStandaloneMobile,
// Prohibit saving to file system if we're in a mobile env that doesn't
// support that
saveToDisk: !isLightweightMobile || isStandaloneMobile,
// Create an object for attaching frames to the world
worldObject: isLightweightMobile || isStandaloneMobile,
listenForHumanPose: false,
initializations: {
udp: false,
web: false,
system: false
},
useHTTPS: allowSecureMode &&
!(isLightweightMobile || isStandaloneMobile) // on mobile devices node.js doesn't fully support HTTPS
};
exports.useHTTPS = globalVariables.useHTTPS;
let forceGCInterval = null;
if (global.gc) {
setInterval(() => {
const usage = process.memoryUsage();
// Total memory usage less than 100 MB
if (!usage || usage.rss < 100 * 1024 * 1024) {
return;
}
global.gc();
}, 7919); // arbitrary prime number delay to distribute around the gc hitches
}
// ports used to define the server behaviour
/*
The server uses port 8080 to communicate with other servers and with the Reality Editor.
As such the Server reacts to http and web sockets on this port.
The beat port is used to send UDP broadcasting messages in a local network. The Reality Editor and other Objects
pick up these messages to identify the object.
*/
const serverUserInterfaceAppPort = 49368;
const socketPort = serverPort; // server and socket port are always identical
exports.serverPort = serverPort;
exports.beatPort = beatPort;
const timeToLive = 3; // the amount of routers a UDP broadcast can jump. For a local network 2 is enough.
const beatInterval = 5000; // how often is the heartbeat sent
const socketUpdateIntervalMs = 2000; // how often the system checks if the socket connections are still up and running.
let socketUpdaterInterval;
const netmask = '255.255.0.0'; // define the network scope from which this server is accessable.
// for a local network 255.255.0.0 allows a 16 bit block of local network addresses to reach the object.
// basically all your local devices can see the object, however the internet is unable to reach the object.
const fs = require('fs'); // Filesystem library
const fsProm = require('./persistence/fsProm.js');
const SyncInterval = require('./persistence/syncInterval.js');
const syncInterval = new SyncInterval();
const path = require('path');
const DecompressZip = require('decompress-zip');
const dirTree = require('directory-tree');
const addonPaths = [
path.join(__dirname, 'addons'),
path.join(os.homedir(), 'Documents', 'spatialToolbox-addons'),
];
const Addons = require('./libraries/addons/Addons');
const AddonFolderLoader = require('./libraries/addons/AddonFolderLoader');
const AddonSecretsLoader = require('./libraries/addons/AddonSecretsLoader');
const addons = new Addons(addonPaths);
const addonFolders = addons.listAddonFolders();
// The path to all frames types that this server hosts, containing a directory for each frame (containing the html/etc).
const frameLibPaths = addonFolders.map(folder => path.join(folder, 'tools'));
// All visual UI representations for IO Points are stored in this folder:
const nodePaths = addonFolders.map(folder => path.join(folder, 'nodes'));
// All visual UI representations for logic blocks are stored in this folder:
const blockPaths = addonFolders.map(folder => path.join(folder, 'blocks'));
// All interfaces for different hardware such as Arduino Yun, PI, Philips Hue are stored in this folder.
const hardwareInterfacePaths = addonFolders.map(folder => path.join(folder, 'interfaces'));
// The web service level on which objects are accessable. http(s)://<IP>:8080 <objectInterfaceFolder> <object>
const objectInterfaceFolder = '/';
/**********************************************************************************************************************
******************************************** Requirements ************************************************************
**********************************************************************************************************************/
const storage = require('./libraries/storage');
let dir = path.join(require('os').homedir(), 'vst-edge-server');
try {
storage.initSync({dir: dir});
} catch (e) {
console.error('Something went wrong with initSync', e);
}
var dgram = require('dgram'); // UDP Broadcasting library
let udpServer;
var services = {};
if (!isLightweightMobile) {
services.networkInterface = require('network-interfaces');
}
services.ips = {activeInterface: null, tempActiveInterface: null, interfaces: {}};
services.ip = null;
services.updateAllObjects = function (ip) {
for (let key in objects) {
objects[key].ip = ip;
}
};
services.getIP = function () {
this.ips.interfaces = {};
// if this is mobile, only allow local interfaces
if (isLightweightMobile) {
this.ips.interfaces['mobile'] = 'localhost';
this.ips.activeInterface = 'mobile';
return 'localhost';
}
// Get All available interfaces
let interfaceNames;
try {
interfaceNames = this.networkInterface.getInterfaces({ipVersion: 4});
let interfaceNamesFiltered = interfaceNames.filter((interfaceName) => {
return !interfaceName.startsWith('utun'); // discard docker's virtual network interface on mac
});
if (interfaceNamesFiltered.length > 0) {
interfaceNames = interfaceNamesFiltered;
}
} catch (e) {
console.error('Failed to get network interfaces', e);
return this.ip;
}
if (isStandaloneMobile) {
let knownGoodMobileInterfaces = {
en0: true,
};
interfaceNames = interfaceNames.filter(interfaceName => {
return knownGoodMobileInterfaces[interfaceName];
});
if (interfaceNames.length === 0) {
this.ips.interfaces['mobile'] = 'localhost';
this.ips.activeInterface = 'mobile';
return 'localhost';
}
}
for (let key in interfaceNames) {
let tempIps = this.networkInterface.toIps(interfaceNames[key], {ipVersion: 4});
tempIps = tempIps.filter(ip => !['127.0.0.1', 'localhost'].includes(ip));
this.ips.interfaces[interfaceNames[key]] = tempIps[0];
}
// if activeInterface is empty, read from storage and check if it exists in found interfaces
if (storage.getItemSync('activeNetworkInterface') !== undefined && this.ips.activeInterface === null) {
var storedIPS = null;
storedIPS = storage.getItemSync('activeNetworkInterface');
if (storedIPS in this.ips.interfaces) {
this.ips.activeInterface = storedIPS;
}
}
// if it is still empty give it a default
if (this.ips.activeInterface === null) {
// No active interface found, defaulting to "en0"
this.ips.activeInterface = 'en0';
// make sure all objects got the memo
this.updateAllObjects(this.ips.interfaces[this.ips.activeInterface]);
}
// if activeInterface is not available, get the first available one and refresh all objects
if (!(this.ips.activeInterface in this.ips.interfaces)) {
console.warn(`Current active network interface "${this.ips.activeInterface}" not found`);
this.ips.tempActiveInterface = this.ips.activeInterface;
for (var tempKey in this.ips.interfaces) {
if (!this.ips.interfaces[tempKey]) {
continue;
}
console.warn(`Activated fallback network interface "${tempKey}" from`, this.ips.interfaces);
this.ips.activeInterface = tempKey;
// make sure all objects got the memo
this.updateAllObjects(this.ips.interfaces[this.ips.activeInterface]);
break;
}
}
// check if active interface is back
if (this.ips.tempActiveInterface) {
if (this.ips.tempActiveInterface in this.ips.interfaces) {
console.info(`Re-activated network interface "${this.ips.tempActiveInterface}"`);
this.ips.activeInterface = this.ips.tempActiveInterface;
this.ips.tempActiveInterface = null;
}
}
// return active IP
return this.ips.interfaces[this.ips.activeInterface];
};
exports.getIP = services.getIP.bind(services);
services.ip = services.getIP(); //ip.address();
var express = require('express'); // Web Sever library
const {
identityFolderName,
protocol,
version,
} = require('./constants.js');
// This file hosts the functions related to loading the set of available frames
// from the each add-ons tools directory
const AddonFrames = require('./libraries/addons/AddonFrames');
const addonFrames = new AddonFrames();
const frameFolderLoader = new AddonFolderLoader(frameLibPaths);
frameFolderLoader.calculatePathResolution();
for (const frameLibPath of frameLibPaths) {
if (fs.existsSync(frameLibPath)) {
addonFrames.addFramesSource(frameLibPath);
}
}
if (process.env.NODE_ENV !== 'test' && persistToCloud) {
syncInterval.start();
}
// constrution for the werbserver using express combined with socket.io
var webServer = express();
exports.webServer = webServer;
if (!isLightweightMobile) {
webServer.set('views', 'libraries/webInterface/views');
var exphbs = require('express-handlebars'); // View Template library
webServer.engine('handlebars', exphbs({
defaultLayout: 'main',
layoutsDir: 'libraries/webInterface/views/layouts',
partialsDir: 'libraries/webInterface/views/partials'
}));
webServer.set('view engine', 'handlebars');
}
let httpServer = null;
if (globalVariables.useHTTPS) {
let options = {
key: fs.readFileSync('key.pem'),
cert: fs.readFileSync('cert.pem')
};
httpServer = require('https').createServer(options, webServer);
} else {
httpServer = require('http').createServer(webServer);
}
const http = httpServer.listen(serverPort, function () {
console.info('Server (http' + (globalVariables.useHTTPS ? 's' : '') + ' and websockets) is listening on port', serverPort);
checkInit('web');
});
const ToolSocket = require('toolsocket');
const io = new ToolSocket.Server({server: http, maxPayload: 1024 * 1024 * 1024}); // Websocket library
io.addEventListener('listening', () => {
console.info(`ToolSocket server started`);
});
exports.io = io;
var cors = require('cors'); // Library for HTTP Cross-Origin-Resource-Sharing
var formidable = require('formidable'); // Multiple file upload library
var cheerio = require('cheerio');
// use the cors cross origin REST model
// allow requests from all origins. TODO make it dependent on the local network. this is important for security
webServer.use(cors());
// Image resizing library, not available on mobile
let Jimp = null;
if (!isLightweightMobile) {
try {
Jimp = require('jimp');
} catch (e) {
console.warn('Unable to import jimp for image resizing on this platform', e);
}
}
// additional files containing project code
// This file hosts all kinds of utilities programmed for the server
const utilities = require('./libraries/utilities');
const {fileExists, mkdirIfNotExists, rmdirIfExists, unlinkIfExists} = utilities;
const nodeUtilities = require('./libraries/nodeUtilities');
const recorder = require('./libraries/recorder');
// The web frontend a developer is able to see when creating new user interfaces.
let webFrontend;
if (isLightweightMobile) {
webFrontend = require('./libraries/mobile/webFrontend');
} else {
webFrontend = require('./libraries/webFrontend');
}
// Definition for a simple API for hardware interfaces talking to the server.
// This is used for the interfaces defined in the hardwareAPI folder.
let hardwareAPI;
if (isLightweightMobile) {
hardwareAPI = require('./libraries/mobile/hardwareInterfaces');
} else {
hardwareAPI = require('./libraries/hardwareInterfaces');
}
// This file hosts the constructor and class methods for human pose objects (generated by human body tracking)
const HumanPoseObject = require('./libraries/HumanPoseObject');
// Set web frontend debug to inherit from global debug
webFrontend.debug = globalVariables.debug;
// Controller imports
const blockController = require('./controllers/block.js');
const blockLinkController = require('./controllers/blockLink.js');
const frameController = require('./controllers/frame.js');
const linkController = require('./controllers/link.js');
const logicNodeController = require('./controllers/logicNode.js');
const nodeController = require('./controllers/node.js');
const objectController = require('./controllers/object.js');
const {splatTasks} = require('./controllers/object/SplatTask.js');
const spatialController = require('./controllers/spatial');
const signallingController = require('./controllers/signalling.js');
/**********************************************************************************************************************
******************************************** Constructors ************************************************************
**********************************************************************************************************************/
const Frame = require('./models/Frame.js');
const Node = require('./models/Node.js');
const ObjectModel = require('./models/ObjectModel.js');
const ObjectSocket = require('./models/ObjectSocket.js');
const Protocols = require('./models/Protocols.js');
/**********************************************************************************************************************
******************************************** Variables and Objects ***************************************************
**********************************************************************************************************************/
// This variable will hold the entire tree of all objects and their sub objects.
var objects = {};
const availableModules = require('./libraries/availableModules');
const nodeFolderLoader = new AddonFolderLoader(nodePaths);
const nodeTypeModules = nodeFolderLoader.loadModules(); // Will hold all available data point interfaces
availableModules.setNodes(nodeTypeModules);
const blockFolderLoader = new AddonFolderLoader(blockPaths);
const blockModules = blockFolderLoader.loadModules(); // Will hold all available data point interfaces
availableModules.setBlocks(blockModules);
const addonSecrets = AddonSecretsLoader.load(addonFolders); // Holds secrets by addon name
const getFrameSecrets = (frameName) => {
const frameFolderPath = frameFolderLoader.resolvePath(frameName);
const addonFolderPath = path.dirname(frameFolderPath);
const addonName = path.basename(addonFolderPath);
if (!addonSecrets[addonName]) {
throw new Error(`Addon ${addonName} does not have any registered secrets`);
}
return addonSecrets[addonName];
};
exports.getFrameSecrets = getFrameSecrets;
var hardwareInterfaceModules = {}; // Will hold all available hardware interfaces.
var hardwareInterfaceLoader = null;
// A list of all objects known and their IPs in the network. The objects are found via the udp heart beat.
// If a new link is linking to another objects, this knownObjects list is used to establish the connection.
// This list is also used to keep track of the actual IP of an object. If the IP of an object in a network changes,
// It has no influance on the connectivity, as it is referenced by the object UUID through the entire time.
var knownObjects = {};
exports.knownObjects = knownObjects;
// A lookup table used to process faster through the objects.
var objectLookup = {};
// This list holds all the socket connections that are kept alive. Socket connections are kept alive if a link is
// associated with this object. Once there is no more link the socket connection is deleted.
var socketArray = {}; // all socket connections that are kept alive
var realityEditorSocketSubscriptions = []; // all socket connections that are kept alive
var realityEditorBlockSocketSubscriptions = []; // all socket connections that are kept alive
var realityEditorUpdateSocketSubscriptions = []; // all socket connections to keep UIs in sync (frame position, etc)
var realityEditorCameraMatrixSocketSubscriptions = []; // all socket connections to notify clients of each other's position
var realityEditorObjectMatrixSocketSubscriptions = []; // all socket connections to keep object world positions in sync
var activeHeartbeats = {}; // Prevents multiple recurring beats for the same object
// counter for the socket connections
// this counter is used for the Web Developer Interface to reflect the state of the server socket connections.
var sockets = {
sockets: 0, // amount of created socket connections
connected: 0, // amount of connected socket connections
notConnected: 0, // not connected
socketsOld: 0, // used internally to react only on updates
connectedOld: 0, // used internally to react only on updates
notConnectedOld: 0 // used internally to react only on updates
};
// For realtime updates, rather than sending N^2 messages when many clients are updating at once,
// aggregate them at send at most one aggregate message per small interval.
const BatchedUpdateAggregator = require('./libraries/BatchedUpdateAggregator');
const updateAggregator = new BatchedUpdateAggregator(broadcastAggregatedUpdates, {
minAggregationIntervalMs: 33,
maxAggregationIntervalMs: 1000,
rollingWindowSize: 10
});
// Define the callback function to broadcast updates
function broadcastAggregatedUpdates(aggregatedUpdates) {
for (const entry of realityEditorUpdateSocketSubscriptions) {
if (!entry) continue;
entry.subscriptions.forEach((subscription) => {
if (aggregatedUpdates.batchedUpdates.some(update => update.editorId === subscription.editorId)) {
// Don't send updates to the editor that triggered them
return;
}
if (entry.socket.connected) {
entry.socket.emit('/batchedUpdate', JSON.stringify(aggregatedUpdates));
}
});
}
}
const StaleObjectCleaner = require('./libraries/StaleObjectCleaner');
const staleObjectCleaner = new StaleObjectCleaner(objects, deleteObject);
function resetObjectTimeout(objectKey) {
staleObjectCleaner.resetObjectTimeout(objectKey);
}
exports.resetObjectTimeout = resetObjectTimeout;
var worldObjectName = '_WORLD_';
if (isLightweightMobile || isStandaloneMobile) {
worldObjectName += 'local';
}
var worldObject;
const SceneGraph = require('./libraries/sceneGraph/SceneGraph');
const sceneGraph = new SceneGraph(true);
const WorldGraph = require('./libraries/sceneGraph/WorldGraph');
const worldGraph = new WorldGraph(sceneGraph);
const tempUuid = utilities.uuidTime().slice(1); // UUID of current run of the server (removed initial underscore)
const HumanPoseFuser = require('./libraries/HumanPoseFuser');
const humanPoseFuser = new HumanPoseFuser(objects, sceneGraph, objectLookup, services.ip, beatPort, tempUuid);
/**********************************************************************************************************************
******************************************** Initialisations *********************************************************
**********************************************************************************************************************/
// Load all the hardware interfaces
const hardwareAPICallbacks = {
publicData: function (objectKey, frameKey, nodeKey) {
socketHandler.sendPublicDataToAllSubscribers(objectKey, frameKey, nodeKey);
},
actions: function (thisAction) {
utilities.actionSender(thisAction);
},
data: function (objectKey, frameKey, nodeKey, data) {
//these are the calls that come from the objects before they get processed by the object engine.
// send the saved value before it is processed
sendMessageToEditors({
object: objectKey,
frame: frameKey,
node: nodeKey,
data: data
});
hardwareAPI.readCall(objectKey, frameKey, nodeKey, getNode(objectKey, frameKey, nodeKey).data);
engine.trigger(objectKey, frameKey, nodeKey, getNode(objectKey, frameKey, nodeKey));
},
write: function (objectID) {
// note: throwing away async
utilities.writeObjectToFile(objects, objectID, globalVariables.saveToDisk);
}
};
// set all the initial states for the Hardware Interfaces in order to run with the Server.
hardwareAPI.setup(objects, objectLookup, knownObjects, socketArray, globalVariables, __dirname, objectsPath, nodeTypeModules, blockModules, services, serverPort, hardwareAPICallbacks, sceneGraph, worldGraph);
const utilitiesCallbacks = {
triggerUDPCallbacks: hardwareAPI.triggerUDPCallbacks
};
utilities.setup({realityEditorUpdateSocketSubscriptions}, utilitiesCallbacks);
nodeUtilities.setup(objects, sceneGraph, knownObjects, socketArray, globalVariables, hardwareAPI, objectsPath, linkController);
(async () => {
// This function will load all the Objects
await loadObjects();
if (globalVariables.worldObject) {
await loadWorldObject();
}
await startSystem();
// Get the directory names of all available sources for the 3D-UI
if (!isLightweightMobile) {
hardwareInterfaceLoader = new AddonFolderLoader(hardwareInterfacePaths);
hardwareInterfaceModules = hardwareInterfaceLoader.loadModules();
availableModules.setHardwareInterfaces(hardwareInterfaceModules);
// statically serve the "public" directory in each hardware interface
for (let folderName in hardwareInterfaceLoader.folderMap) {
let publicPath = path.join(hardwareInterfaceLoader.folderMap[folderName], folderName, 'public');
webServer.use('/hardwareInterface/' + folderName + '/public', express.static(publicPath));
}
}
hardwareAPI.reset();
console.info('Server has the following enabled hardware interfaces: ' + Object.keys(hardwareInterfaceModules).join(', '));
})();
// This function calls an initialization callback that will help hardware interfaces to start after the entire system
// is initialized.
/**
* Returns the file extension (portion after the last dot) of the given filename.
* If a file name starts with a dot, returns an empty string.
*
* @author VisioN @ StackOverflow
* @param {string} fileName - The name of the file, such as foo.zip
* @return {string} The lowercase extension of the file, such has "zip"
*/
function getFileExtension(fileName) {
return fileName.substr((~-fileName.lastIndexOf('.') >>> 0) + 2).toLowerCase();
}
/**
* @param {ObjectModel} obj
* @param {string} objectKey
*/
function migrateObjectValuesToFrames(obj, objectKey) {
// this is for transforming old lists to new lists
if (typeof obj.objectValues !== 'undefined') {
obj.frames[objectKey].nodes = obj.objectValues;
delete obj.objectValues;
}
if (typeof obj.objectLinks !== 'undefined') {
obj.frames[objectKey].links = obj.objectLinks;
delete obj.objectLinks;
}
if (typeof obj.nodes !== 'undefined') {
obj.frames[objectKey].nodes = obj.nodes;
delete obj.nodes;
}
if (typeof obj.links !== 'undefined') {
obj.frames[objectKey].links = obj.links;
delete obj.links;
}
}
/**
* @desc Add objects from the objects folder to the system
**/
async function loadObjects() {
// check for objects in the objects folder by reading the objects directory content.
// get all directory names within the objects directory
const objectFolderList = await utilities.getObjectFolderList();
for (var i = 0; i < objectFolderList.length; i++) {
const objectFolder = objectFolderList[i];
const tempFolderName = await utilities.getObjectIdFromObjectFile(objectFolder);
if (tempFolderName !== null) {
// fill objects with objects named by the folders in objects
objects[tempFolderName] = new ObjectModel(services.ip, version, protocol, tempFolderName);
objects[tempFolderName].port = serverPort;
objects[tempFolderName].name = objectFolderList[i];
// create first frame
// todo this need to be checked in the system
// objects[tempFolderName].frames[tempFolderName] = new Frame();
//objects[tempFolderName].frames[tempFolderName].name = objectFolderList[i];
// add object to object lookup table
utilities.writeObject(objectLookup, objectFolderList[i], tempFolderName);
// try to read a saved previous state of the object
try {
const objectJsonText = await fsProm.readFile(objectsPath + '/' + objectFolderList[i] + '/' + identityFolderName + '/object.json', 'utf8');
objects[tempFolderName] = JSON.parse(objectJsonText);
const obj = objects[tempFolderName];
obj.ip = services.ip; // ip.address();
// update the targetId if needed
try {
obj.targetId = await utilities.getTargetIdFromTargetDat(path.join(objectsPath, objectFolderList[i], identityFolderName, 'target'));
} catch (e) {
console.warn(`object ${tempFolderName} has no targetId in .dat file, or no .dat file`);
}
migrateObjectValuesToFrames(obj, tempFolderName);
if (obj.frames[tempFolderName]) {
for (var nodeKey in obj.frames[tempFolderName].nodes) {
if (typeof obj.nodes[nodeKey].item !== 'undefined') {
var tempItem = obj.frames[tempFolderName].nodes[nodeKey].item;
obj.frames[tempFolderName].nodes[nodeKey].data = utilities.deepCopy(tempItem[0]);
}
}
}
// fix corrupted state of world objects whose worldId isn't their own id
if ((obj.isWorldObject || obj.type === 'world') && obj.objectId && obj.worldId !== obj.objectId) {
obj.worldId = obj.objectId;
}
// cast everything from JSON to Object, Frame, and Node classes
let newObj = new ObjectModel(obj.ip,
obj.version,
obj.protocol,
obj.objectId);
newObj.setFromJson(obj);
objects[tempFolderName] = newObj;
} catch (e) {
objects[tempFolderName].ip = services.ip; //ip.address();
objects[tempFolderName].objectId = tempFolderName;
console.warn('No saved data for: ' + tempFolderName, e);
}
// add this object to the sceneGraph
sceneGraph.addObjectAndChildren(tempFolderName, objects[tempFolderName]);
} else {
console.warn(' object ' + objectFolderList[i] + ' has no marker yet');
}
utilities.actionSender({reloadObject: {object: tempFolderName}, lastEditor: null});
}
// update parents of any sceneGraph nodes to be relative to the world where they were localized
for (let objectId in objects) {
let thisObject = objects[objectId];
if (thisObject.worldId && typeof objects[thisObject.worldId] !== 'undefined') {
sceneGraph.updateObjectWorldId(objectId, thisObject.worldId);
}
if (thisObject.deactivated) {
sceneGraph.deactivateElement(objectId);
}
}
// delete each object that represented a client that was connected to the server in its last session
// this needs to happen before hardwareAPI.reset, or the object will get corrupted when its nodes are parsed
await removeAvatarAndHumanPoseFiles();
hardwareAPI.reset();
sceneGraph.recomputeGraph();
executeInitialProcessBlockLinks();
}
/**
* Go through all objects and processBlockLinks once. Useful on initial load
*/
function executeInitialProcessBlockLinks() {
for (let objectKey in objects) {
for (let frameKey in objects[objectKey].frames) {
var thisFrame = objects[objectKey].frames[frameKey];
for (let nodeKey in thisFrame.nodes) {
for (let blockKey in thisFrame.nodes[nodeKey].blocks) {
var thisBlock = objects[objectKey].frames[frameKey].nodes[nodeKey].blocks[blockKey];
if (blockModules[thisBlock.type]) {
blockModules[thisBlock.type].setup(
objectKey, frameKey, nodeKey, blockKey, thisBlock,
function (object, frame, node, block, index, thisBlockCb) {
engine.processBlockLinks(object, frame, node, block, index, thisBlockCb);
}
);
}
}
}
}
}
}
/**
* Initialize worldObject to contents of spatialToolbox/_WORLD_local/.identity/object.json
* Create the json file if doesn't already exist
*/
async function loadWorldObject() {
const identityPath = path.join(objectsPath, worldObjectName, '.identity');
const jsonFilePath = path.join(identityPath, 'object.json');
// create a /.identity folder within it to hold the object.json data
if (globalVariables.saveToDisk) {
await mkdirIfNotExists(identityPath, {recursive: true});
}
// create a new world object
let thisWorldObjectId = (isLightweightMobile || isStandaloneMobile) ? worldObjectName : (worldObjectName + utilities.uuidTime());
worldObject = new ObjectModel(services.ip, version, protocol, thisWorldObjectId);
worldObject.port = serverPort;
worldObject.name = worldObjectName;
worldObject.isWorldObject = true;
worldObject.type = 'world';
// try to read previously saved data to overwrite the default world object
if (globalVariables.saveToDisk) {
try {
const contents = await fsProm.readFile(jsonFilePath, 'utf8');
worldObject = JSON.parse(contents);
} catch (e) {
console.error('No saved data for world object on server: ' + services.ip, e);
}
}
worldObject.ip = services.ip;
worldObject.port = serverPort;
objects[worldObject.objectId] = worldObject;
hardwareAPI.reset();
if (globalVariables.saveToDisk) {
try {
await fsProm.writeFile(jsonFilePath, JSON.stringify(worldObject, null, 4));
} catch (err) {
console.error('Error saving world object', err);
}
} else {
console.error('Server is not allowed to save to disk');
}
}
async function loadAnchor(anchorName) {
// create the file for it if necessary
var identityPath = path.join(objectsPath, anchorName, '.identity');
var jsonFilePath = path.join(identityPath, 'object.json');
let anchorUuid = anchorName + utilities.uuidTime();
// create a /.identity folder within it to hold the object.json data
if (globalVariables.saveToDisk) {
await mkdirIfNotExists(identityPath, {recursive: true});
}
// try to read previously saved data to overwrite the default anchor object
if (globalVariables.saveToDisk) {
try {
const contents = await fsProm.readFile(jsonFilePath, 'utf8');
let anchor = JSON.parse(contents);
anchorUuid = anchor.objectId;
if (anchorUuid) {
objects[anchorUuid] = anchor;
}
return;
} catch (e) {
console.warn('No saved data for anchor object on server: ' + services.ip, e);
}
}
// create a new anchor object
objects[anchorUuid] = new ObjectModel(services.ip, version, protocol, anchorUuid);
objects[anchorUuid].port = serverPort;
objects[anchorUuid].name = anchorName;
objects[anchorUuid].isAnchor = false;
objects[anchorUuid].matrix = [
1, 0, 0, 0,
0, 1, 0, 0,
0, 0, 1, 0,
0, 0, 0, 1
];
objects[anchorUuid].tcs = 0;
if (globalVariables.saveToDisk) {
try {
await fsProm.writeFile(jsonFilePath, JSON.stringify(objects[anchorUuid], null, 4));
} catch (err) {
console.log('error persisting anchor object', err);
}
await objectBeatSender(beatPort, anchorUuid, objects[anchorUuid].ip);
hardwareAPI.reset();
} else {
console.warn('Server is not allowed to save to disk');
await objectBeatSender(beatPort, anchorUuid, objects[anchorUuid].ip);
hardwareAPI.reset();
}
// store in lookup table so we can correctly change ID if target data is later uploaded
utilities.writeObject(objectLookup, anchorName, anchorUuid);
sceneGraph.addObjectAndChildren(anchorUuid, objects[anchorUuid]);
}
async function setAnchors() {
let hasValidWorldObject = false;
// load all object folders
let tempFiles = await utilities.getObjectFolderList();
// populate all objects folders with object.json files.
for (const objectKey of tempFiles) {
if (objectKey.indexOf('_WORLD_') === -1) {
let thisObjectKey = null;
let tempKey = await utilities.getObjectIdFromObjectFile(objectKey); // gets the object id from the xml target file
if (tempKey) {
thisObjectKey = tempKey;
} else {
thisObjectKey = objectKey;
}
if (!(thisObjectKey in objects)) {
await loadAnchor(objectKey);
}
}
}
// check if there is an initialized World Object
for (let key in objects) {
if (!objects[key]) {
continue;
}
// TODO: world objects are now considered initialized by default... update how anchor objects work (do they still require that the world has target data?)
if (objects[key].isWorldObject || objects[key].type === 'world') {
// check if the object is correctly initialized with tracking targets
let datExists = await fileExists(path.join(objectsPath, objects[key].name, identityFolderName, '/target/target.dat'));
let xmlExists = await fileExists(path.join(objectsPath, objects[key].name, identityFolderName, '/target/target.xml'));
let jpgExists = await fileExists(path.join(objectsPath, objects[key].name, identityFolderName, '/target/target.jpg'));
if ((xmlExists && datExists && jpgExists) || (xmlExists && jpgExists)) {
hasValidWorldObject = true;
}
break;
}
}
// check if there are uninitialized objects and turn them into anchors if an initialized world object exists.
for (let key in objects) {
if (!objects[key]) {
continue;
}
objects[key].isAnchor = false;
if (objects[key].isWorldObject ||
objects[key].type === 'world' ||
objects[key].type === 'human' ||
objects[key].type === 'avatar') {
continue;
}
// check if the object is correctly initialized with tracking targets
let datExists = await fileExists(path.join(objectsPath, objects[key].name, identityFolderName, '/target/target.dat'));
let xmlExists = await fileExists(path.join(objectsPath, objects[key].name, identityFolderName, '/target/target.xml'));
let jpgExists = await fileExists(path.join(objectsPath, objects[key].name, identityFolderName, '/target/target.jpg'));
if (xmlExists && (datExists || jpgExists)) {
continue;
}
if (hasValidWorldObject) {
objects[key].isAnchor = true;
objects[key].tcs = 0;
}
}
}
async function removeAvatarAndHumanPoseFiles() {
let objectsToDelete = [];
// load all object folders
let tempFiles = await utilities.getObjectFolderList();
// remove hidden directories
for (const objectFolderName of tempFiles) {
if (objectFolderName.indexOf('_AVATAR_') === 0 || objectFolderName.indexOf('_HUMAN_') === 0) {
objectsToDelete.push(objectFolderName);
}
}
for (const objectFolderName of objectsToDelete) {
let objectKey = utilities.readObject(objectLookup, objectFolderName);
if (objects[objectKey]) {
await deleteObject(objectKey);
} else {
console.warn('problem deleting avatar/humanPose object (' + objectFolderName + ') because can\'t get objectID from name');
}
}
}
/**********************************************************************************************************************
******************************************** Starting the System ******************************************************
**********************************************************************************************************************/
/**
* @desc starting the system
**/
async function startSystem() {
// make sure that the system knows about the state of anchors.
await setAnchors();
// generating a udp heartbeat signal for every object that is hosted in this device
for (let key in objects) {
if (!objects[key]) {