/
sandbox.js
4196 lines (3864 loc) · 178 KB
/
sandbox.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
/// <reference path="./javascript.d.ts" />
/* jslint global: console */
/* eslint-env node */
'use strict';
const { isObject, isArray, promisify } = require('./tools');
const utils = require('@iobroker/adapter-core');
const pattern2RegEx = utils.commonTools.pattern2RegEx;
// let context = {
// adapter,
// mods,
// errorLogFunction,
// subscriptions,
// subscribedPatterns,
// states,
// adapterSubs,
// objects,
// cacheObjectEnums,
// stateIds,
// logWithLineInfo,
// timers,
// enums,
// channels,
// devices,
// isEnums
// };
/**
* @typedef {Object} SandboxContext
* @property {Record<string, string[]>} channels
* @property {Record<string, string[]>} devices
* @property {string[]} stateIds
*/
/**
* @param {{[prop: string]: any} & SandboxContext} context
*/
function sandBox(script, name, verbose, debug, context) {
const consts = require('./consts');
const words = require('./words');
const eventObj = require('./eventObj');
const patternCompareFunctions = require('./patternCompareFunctions');
const jsonata = require('jsonata');
/** @type {ioBroker.Adapter} */
const adapter = context.adapter;
const mods = context.mods;
const states = context.states;
const objects = context.objects;
const timers = context.timers;
const enums = context.enums;
const debugMode = context.debugMode;
function errorInCallback(e) {
adapter.setState(`scriptProblem.${name.substring('script.js.'.length)}`, { val: true, ack: true, c: 'errorInCallback' });
context.logError('Error in callback', e);
context.debugMode && console.log(`error$$${name}$$Exception in callback: ${e}`, Date.now());
}
function subscribePattern(script, pattern) {
if (adapter.config.subscribe) {
if (!script.subscribes[pattern]) {
script.subscribes[pattern] = 1;
} else {
script.subscribes[pattern]++;
}
if (!context.subscribedPatterns[pattern]) {
context.subscribedPatterns[pattern] = 1;
adapter.subscribeForeignStates(pattern);
// request current value to deliver old value on change.
if (typeof pattern === 'string' && !pattern.includes('*')) {
adapter.getForeignState(pattern, (err, state) => {
if (state) {
states[pattern] = state;
}
});
} else {
adapter.getForeignStates(pattern, (err, _states) =>
_states && Object.keys(_states).forEach(id => states[id] = _states[id]));
}
} else {
context.subscribedPatterns[pattern]++;
}
}
}
function unsubscribePattern(script, pattern) {
if (adapter.config.subscribe) {
if (script.subscribes[pattern]) {
script.subscribes[pattern]--;
if (!script.subscribes[pattern]) {
delete script.subscribes[pattern];
}
}
if (context.subscribedPatterns[pattern]) {
context.subscribedPatterns[pattern]--;
if (!context.subscribedPatterns[pattern]) {
adapter.unsubscribeForeignStates(pattern);
delete context.subscribedPatterns[pattern];
// if pattern was regex or with * some states will stay in RAM, but it is OK.
if (states[pattern]) {
delete states[pattern];
}
}
}
}
}
function subscribeFile(script, id, fileNamePattern) {
const key = `${id}$%$${fileNamePattern}`;
if (!script.subscribesFile[key]) {
script.subscribesFile[key] = 1;
} else {
script.subscribesFile[key]++;
}
if (!context.subscribedPatternsFile[key]) {
context.subscribedPatternsFile[key] = 1;
adapter.subscribeForeignFiles(id, fileNamePattern);
} else {
context.subscribedPatternsFile[key]++;
}
}
function unsubscribeFile(script, id, fileNamePattern) {
const key = `${id}$%$${fileNamePattern}`;
if (script.subscribesFile[key]) {
script.subscribesFile[key]--;
if (!script.subscribesFile[key]) {
delete script.subscribesFile[key];
}
}
if (context.subscribedPatternsFile[key]) {
context.subscribedPatternsFile[key]--;
if (!context.subscribedPatternsFile[key]) {
adapter.unsubscribeForeignFiles(id, fileNamePattern);
delete context.subscribedPatternsFile[key];
}
}
}
/**
* @typedef PatternCompareFunctionArray
* @type {Array<any> & {logic?: string}}
*/
function getPatternCompareFunctions(pattern) {
let func;
/** @type {PatternCompareFunctionArray} */
const functions = [];
functions.logic = pattern.logic || 'and';
// adapter.log.info('## ' + JSON.stringify(pattern));
for (const key in pattern) {
if (!Object.prototype.hasOwnProperty.call(pattern, key)) {
continue;
}
if (key === 'logic') {
continue;
}
if (key === 'change' && pattern.change === 'any') {
continue;
}
if (!(func = patternCompareFunctions[key])) {
continue;
}
if (typeof (func = func(pattern)) !== 'function') {
continue;
}
functions.push(func);
}
return functions;
}
/** @typedef {{attr: string, value: string, idRegExp?: RegExp}} Selector */
/**
* Splits a selector string into attribute and value
* @param {string} selector The selector string to split
* @returns {Selector}
*/
function splitSelectorString(selector) {
const parts = selector.split('=', 2);
if (parts[1] && parts[1][0] === '"') {
parts[1] = parts[1].substring(1);
const len = parts[1].length;
if (parts[1] && parts[1][len - 1] === '"') {
parts[1] = parts[1].substring(0, len - 1);
}
}
if (parts[1] && parts[1][0] === "'") {
parts[1] = parts[1].substring(1);
const len = parts[1].length;
if (parts[1] && parts[1][len - 1] === "'") {
parts[1] = parts[1].substring(0, len - 1);
}
}
if (parts[1]) {
parts[1] = parts[1].trim();
}
parts[0] = parts[0].trim();
return {attr: parts[0], value: parts[1]};
}
/**
* Transforms a selector string with wildcards into a regular expression
* @param {string} str The selector string to transform into a regular expression
*/
function selectorStringToRegExp(str) {
const startsWithWildcard = str[0] === '*';
const endsWithWildcard = str[str.length - 1] === '*';
// Sanitize the selector, so it is safe to use in a RegEx
// Taken from https://stackoverflow.com/a/3561711/10179833 but modified
// since * has a special meaning in our selector and should not be escaped
// eslint-disable-next-line no-useless-escape
str = str.replace(/[-\/\\^$+?.()|[\]{}]/g, '\\$&').replace(/\*/g, '.*');
return new RegExp(
(startsWithWildcard ? '' : '^')
+ str
+ (endsWithWildcard ? '' : '$')
);
}
/**
* Adds a regular expression for selectors targeting the state ID
* @param {Selector} selector The selector to apply the transform to
* @returns {Selector}
*/
function addRegExpToIdAttrSelectors(selector) {
if (
(selector.attr === 'id' || selector.attr === 'state.id')
&& (!selector.idRegExp && selector.value)
) {
return {
attr: selector.attr,
value: selector.value,
idRegExp: selectorStringToRegExp(selector.value)
};
} else {
return selector;
}
}
/**
* Tests if a value loosely equals (==) the reference string.
* In contrast to the equality operator, this treats true == "true" as well
* so we can test common and native attributes for boolean values
* @param {boolean | string | number | undefined} value The value to compare with the reference
* @param {string} reference The reference to compare the value to
*/
function looselyEqualsString(value, reference) {
// For booleans, compare the string representation
// For other types do a loose comparison
return typeof value === 'boolean'
? (value && reference === 'true') || (!value && reference === 'false')
: value == reference
;
}
/**
* Returns the `common.type` for a given variable
* @param {any} value
* @returns {iobJS.CommonType}
*/
function getCommonTypeOf(value) {
// @ts-ignore we do not support bigint
return isArray(value) ? 'array'
: (isObject(value) ? 'object'
: typeof value);
}
/**
* Returns if an id is in an allowed namespace for automatic object creations
* @param id {string} id to check
* @returns {boolean}
*/
function validIdForAutomaticFolderCreation(id) {
return id.startsWith('javascript.') || id.startsWith('0_userdata.0.') || id.startsWith('alias.0.');
}
/**
* Iterate through object structure to create missing folder objects
* @param id {string} id
* @returns {Promise<void>}
*/
async function ensureObjectStructure(id) {
// adapter.log.debug(`ensure Logic called for "${id}": ${verifiedObjects[id]}`);
if (!validIdForAutomaticFolderCreation(id)) {
return;
}
if (context.folderCreationVerifiedObjects[id] === true) {
return;
}
const idArr = id.split('.');
idArr.pop(); // the last is created as an object in any way
if (idArr.length < 3) {
return; // Nothing to do
}
// We just create sublevel projects
let idToCheck = idArr.splice(0, 2).join('.');
context.folderCreationVerifiedObjects[id] = true;
for (const part of idArr) {
idToCheck += `.${part}`;
//adapter.log.debug(` check "${idToCheck}": ${verifiedObjects[idToCheck]}`);
if (context.folderCreationVerifiedObjects[idToCheck] === true || objects[idToCheck]) {
continue;
}
context.folderCreationVerifiedObjects[idToCheck] = true;
let obj;
try {
obj = await adapter.getForeignObjectAsync(idToCheck);
} catch (err) {
// ignore
}
if (!obj || !obj.common) {
adapter.log.debug(`Create folder object for ${idToCheck}`);
try {
await adapter.setForeignObjectAsync(idToCheck, {
type: 'folder',
common: {
name: part,
},
native: {
autocreated: 'by automatic ensure logic',
},
});
} catch (err) {
adapter.log.info(`Could not automatically create folder object ${idToCheck}: ${err.message}`);
}
} else {
//adapter.log.debug(` already existing "${idToCheck}": ${JSON.stringify(obj)}`);
}
}
}
function setStateHelper(sandbox, isCreate, isBinary, id, state, isAck, callback) {
let setStateFunc;
if (isBinary) {
sandbox.log(`setBinaryState(id=${id}) is deprecated. Please use Files instead!`, 'info');
if (typeof adapter.setForeignBinaryState === 'function') {
setStateFunc = adapter.setForeignBinaryState.bind(adapter);
} else {
setStateFunc = adapter.setBinaryState.bind(adapter);
}
} else {
setStateFunc = adapter.setForeignState.bind(adapter);
}
if (typeof isAck === 'function') {
callback = isAck;
isAck = undefined;
}
if (!isBinary) {
if (state === null) {
state = {val: null};
}
if (isAck === true || isAck === false || isAck === 'true' || isAck === 'false') {
if (isObject(state) && state.val !== undefined) {
// we assume that we were given a state object if
// state is an object that contains a `val` property
state.ack = isAck;
} else {
// otherwise, assume that the given state is the value to be set
state = {val: state, ack: isAck};
}
}
}
// Check a type of state
if (!objects[id] && objects[`${adapter.namespace}.${id}`]) {
id = `${adapter.namespace}.${id}`;
}
if (isCreate) {
if (id.match(/^javascript\.\d+\.scriptEnabled/)) {
sandbox.log(`Own states (${id}) should not be used in javascript.X.scriptEnabled.*! Please move the states to 0_userdata.0.*`, 'info');
} else if (id.match(/^javascript\.\d+\.scriptProblem/)) {
sandbox.log(`Own states (${id}) should not be used in javascript.X.scriptProblem.*! Please move the states to 0_userdata.0.*`, 'info');
}
}
const common = objects[id] ? objects[id].common : null;
if (common &&
common.type &&
common.type !== 'mixed' &&
common.type !== 'file' &&
common.type !== 'json'
) {
// Find out which type the value has
let actualCommonType;
if (isObject(state)) {
if (state && state.val !== undefined && state.val !== null) {
actualCommonType = getCommonTypeOf(state.val);
}
} else if (state !== null && state !== undefined) {
actualCommonType = getCommonTypeOf(state);
}
// If this is not the expected one, issue a warning
if (actualCommonType && actualCommonType !== common.type) {
context.logWithLineInfo && context.logWithLineInfo.warn(
`You are assigning a ${actualCommonType} to the state "${id}" which expects a ${common.type}. `
+ `Please fix your code to use a ${common.type} or change the state type to ${actualCommonType}. `
+ `This warning might become an error in future versions.`
);
}
if (!isBinary && (actualCommonType === 'array' || actualCommonType === 'object')) {
try {
if (isObject(state) && typeof state.val !== 'undefined') {
state.val = JSON.stringify(state.val);
} else {
state = JSON.stringify(state);
}
} catch (err) {
context.logWithLineInfo && context.logWithLineInfo.warn(`Could not stringify value for type ${actualCommonType} and id ${id}: ${err.message}`);
if (typeof callback === 'function') {
try {
callback.call(sandbox, `Could not stringify value for type ${actualCommonType} and id ${id}: ${err.message}`);
} catch (e) {
errorInCallback(e); // adapter.log.error('Error in callback: ' + e)
}
}
}
}
}
// Check min and max of value
if (!isBinary && isObject(state)) {
if (common && typeof state.val === 'number') {
if (common.min !== undefined && state.val < common.min) state.val = common.min;
if (common.max !== undefined && state.val > common.max) state.val = common.max;
}
} else if (!isBinary && common && typeof state === 'number') {
if (common.min !== undefined && state < common.min) state = common.min;
if (common.max !== undefined && state > common.max) state = common.max;
}
// modify state here, to make it available in callback
if (!isBinary && (!isObject(state) || state.val === undefined)) {
state = {val: state};
state.ack = isAck || false;
}
if (!isBinary) {
// we only need this when state cache is used
state = context.prepareStateObject(id, state, isAck);
// set as comment: from which script this state was set.
state.c = sandbox.name;
}
if (objects[id]) {
script.setStatePerMinuteCounter++;
sandbox.verbose && sandbox.log(`setForeignState(id=${id}, state=${JSON.stringify(state)})`, 'info');
if (debug) {
sandbox.log(`setForeignState(id=${id}, state=${JSON.stringify(state)}) - ${words._('was not executed, while debug mode is active')}`, 'warn');
if (typeof callback === 'function') {
setImmediate(() => {
try {
callback.call(sandbox);
} catch (e) {
errorInCallback(e); //adapter.log.error('Error in callback: ' + e)
}
});
}
} else {
if (!adapter.config.subscribe) {
// store actual state to make possible to process value in callback
// risk that there will be an error on setState is very low
context.interimStateValues[id] = state;
}
setStateFunc(id, state, err => {
err && sandbox.log(`setForeignState: ${err}`, 'error');
// If adapter holds all states
if (err && !adapter.config.subscribe) {
delete context.interimStateValues[id];
}
if (typeof callback === 'function') {
setImmediate(() => {
try {
callback.call(sandbox);
} catch (e) {
errorInCallback(e); // adapter.log.error('Error in callback: ' + e)
}
});
}
});
}
} else {
context.logWithLineInfo && context.logWithLineInfo.warn(`State "${id}" not found`);
if (typeof callback === 'function') {
setImmediate(() => {
try {
callback.call(sandbox, `State "${id}" not found`);
} catch (e) {
errorInCallback(e); // adapter.log.error('Error in callback: ' + e)
}
});
}
}
}
const sandbox = {
mods,
_id: script._id,
name, // deprecated
scriptName: name,
instance: adapter.instance,
verbose,
request: mods.request,
exports: {}, // Polyfill for the export object in TypeScript modules
require: function (md) {
if (mods[md]) {
return mods[md];
} else {
try {
mods[md] = require(md);
return mods[md];
} catch (e) {
adapter.setState(`scriptProblem.${name.substring('script.js.'.length)}`, { val: true, ack: true, c: 'require' });
context.logError(name, e, 6);
}
}
},
Buffer: Buffer,
__engine: {
__subscriptionsObject: 0,
__subscriptions: 0,
__subscriptionsMessage: 0,
__subscriptionsFile: 0,
__subscriptionsLog: 0,
__schedules: 0,
},
/**
* @param {string} selector
* @returns {iobJS.QueryResult}
*/
$: function (selector) {
// following is supported
// 'type[commonAttr=something]', 'id[commonAttr=something]', id(enumName="something")', id{nativeName="something"}
// Type can be state, channel or device
// Attr can be any of the common attributes and can have wildcards *
// E.g. "state[id='hm-rpc.0.*]" or "hm-rpc.0.*" returns all states of adapter instance hm-rpc.0
// channel(room="Living room") => all states in room "Living room"
// channel{TYPE=BLIND}[state.id=*.LEVEL]
// Switch all states with .STATE of channels with role "switch" in "Wohnzimmer" to false
// $('channel[role=switch][state.id=*.STATE](rooms=Wohnzimmer)').setState(false);
//
// Following functions are possible, setValue, getValue (only from first), on, each
// Todo CACHE!!!
/** @type {iobJS.QueryResult} */
const result = {};
let name = '';
/** @type {string[]} */
const commonStrings = [];
/** @type {string[]} */
const enumStrings = [];
/** @type {string[]} */
const nativeStrings = [];
let isInsideName = true;
let isInsideCommonString = false;
let isInsideEnumString = false;
let isInsideNativeString = false;
let currentCommonString = '';
let currentNativeString = '';
let currentEnumString = '';
// parse string
let selectorHasInvalidType = false;
if (typeof selector === 'string') {
for (let i = 0; i < selector.length; i++) {
if (selector[i] === '{') {
isInsideName = false;
if (isInsideCommonString || isInsideEnumString || isInsideNativeString) {
// Error
break;
}
isInsideNativeString = true;
} else if (selector[i] === '}') {
isInsideNativeString = false;
nativeStrings.push(currentNativeString);
currentNativeString = '';
} else if (selector[i] === '[') {
isInsideName = false;
if (isInsideCommonString || isInsideEnumString || isInsideNativeString) {
// Error
break;
}
isInsideCommonString = true;
} else if (selector[i] === ']') {
isInsideCommonString = false;
commonStrings.push(currentCommonString);
currentCommonString = '';
} else if (selector[i] === '(') {
isInsideName = false;
if (isInsideCommonString || isInsideEnumString || isInsideNativeString) {
// Error
break;
}
isInsideEnumString = true;
} else if (selector[i] === ')') {
isInsideEnumString = false;
enumStrings.push(currentEnumString);
currentEnumString = '';
} else if (isInsideName) {
name += selector[i];
} else if (isInsideCommonString) {
currentCommonString += selector[i];
} else if (isInsideEnumString) {
currentEnumString += selector[i];
} else if (isInsideNativeString) {
currentNativeString += selector[i];
} //else {
// some error
//}
}
} else {
selectorHasInvalidType = true;
}
// If some error in the selector
if (selectorHasInvalidType || isInsideEnumString || isInsideCommonString || isInsideNativeString) {
result.length = 0;
result.each = function () {
return this;
};
result.getState = function () {
return null;
};
result.setState = function () {
return this;
};
result.setBinaryState = function () {
return this;
};
result.on = function () {
return this;
};
}
if (isInsideEnumString) {
adapter.log.warn(`Invalid selector: enum close bracket ")" cannot be found in "${selector}"`);
result.error = 'Invalid selector: enum close bracket ")" cannot be found';
return result;
} else if (isInsideCommonString) {
adapter.log.warn(`Invalid selector: common close bracket "]" cannot be found in "${selector}"`);
result.error = 'Invalid selector: common close bracket "]" cannot be found';
return result;
} else if (isInsideNativeString) {
adapter.log.warn(`Invalid selector: native close bracket "}" cannot be found in "${selector}"`);
result.error = 'Invalid selector: native close bracket "}" cannot be found';
return result;
} else if (selectorHasInvalidType) {
const message = `Invalid selector: selector must be a string but is of type ${typeof selector}`;
adapter.log.warn(message);
result.error = message;
return result;
}
/** @type {Selector[]} */
let commonSelectors = commonStrings.map(selector => splitSelectorString(selector));
let nativeSelectors = nativeStrings.map(selector => splitSelectorString(selector));
const enumSelectorObjects = enumStrings.map(_enum => splitSelectorString(_enum));
const allSelectors = commonSelectors.concat(nativeSelectors, enumSelectorObjects);
// These selectors match the state or object ID and don't belong in the common/native selectors
// Also use RegExp for the ID matching
const stateIdSelectors = allSelectors
.filter(selector => selector.attr === 'state.id')
.map(selector => addRegExpToIdAttrSelectors(selector))
;
const objectIdSelectors = allSelectors
.filter(selector => selector.attr === 'id')
.map(selector => addRegExpToIdAttrSelectors(selector))
;
commonSelectors = commonSelectors.filter(selector => selector.attr !== 'state.id' && selector.attr !== 'id');
nativeSelectors = nativeSelectors.filter(selector => selector.attr !== 'state.id' && selector.attr !== 'id');
const enumSelectors = enumSelectorObjects
.filter(selector => selector.attr !== 'state.id' && selector.attr !== 'id')
// enums are filtered by their enum id, so transform the selector into that
.map(selector => `enum.${selector.attr}.${selector.value}`)
;
name = name.trim();
if (name === 'channel' || name === 'device') {
// Fill the channels and devices objects with the IDs of all their states,
// so we can loop over them afterward
if (!context.channels || !context.devices) {
context.channels = {};
context.devices = {};
for (const _id in objects) {
if (Object.prototype.hasOwnProperty.call(objects, _id) && objects[_id].type === 'state') {
const parts = _id.split('.');
parts.pop();
const chn = parts.join('.');
parts.pop();
const dev = parts.join('.');
context.devices[dev] = context.devices[dev] || [];
context.devices[dev].push(_id);
context.channels[chn] = context.channels[chn] || [];
context.channels[chn].push(_id);
}
}
}
}
if (name === 'schedule') {
if (!context.schedules) {
context.schedules = [];
for (const _id in objects) {
if (Object.prototype.hasOwnProperty.call(objects, _id) && objects[_id].type === 'schedule') {
context.schedules.push(_id);
}
}
}
}
/**
* applies all selectors targeting an object or state ID
* @param {string} objId
* @param {Selector[]} selectors
*/
function applyIDSelectors(objId, selectors) {
// Only keep the ID if it matches every ID selector
return selectors.every(selector =>
!selector.idRegExp || selector.idRegExp.test(objId));
}
/**
* Applies all selectors targeting the Object common properties
* @param {string} objId - The ID of the object in question
*/
function applyCommonSelectors(objId) {
const obj = objects[objId];
if (!obj || !obj.common) return false;
const objCommon = obj.common;
// make sure this object satisfies all selectors
return commonSelectors.every(selector =>
// ensure a property exists
(selector.value === undefined && objCommon[selector.attr] !== undefined)
// or match exact values
|| looselyEqualsString(objCommon[selector.attr], selector.value));
}
/**
* Applies all selectors targeting the Object native properties
* @param {string} objId - The ID of the object in question
*/
function applyNativeSelectors(objId) {
const obj = objects[objId];
if (!obj || !obj.native) return false;
const objNative = obj.native;
// make sure this object satisfies all selectors
return nativeSelectors.every(selector =>
// ensure a property exists
(selector.value === undefined && objNative[selector.attr] !== undefined)
// or match exact values
|| looselyEqualsString(objNative[selector.attr], selector.value));
}
/**
* Applies all selectors targeting the Objects enums
* @param {string} objId - The ID of the object in question
*/
function applyEnumSelectors(objId) {
const enumIds = [];
eventObj.getObjectEnumsSync(context, objId, enumIds);
// make sure this object satisfies all selectors
return enumSelectors.every(_enum => enumIds.includes(_enum));
}
/** @type {string[]} */
let res = [];
if (name === 'schedule') {
res = context.schedules;
if (objectIdSelectors.length) {
res = res.filter(channelId => applyIDSelectors(channelId, objectIdSelectors));
}
// filter out those that don't match every common selector
if (commonSelectors.length) {
res = res.filter(id => applyCommonSelectors(id));
}
// filter out those that don't match every native selector
if (nativeSelectors.length) {
res = res.filter(id => applyNativeSelectors(id));
}
// filter out those that don't match every enum selector
if (enumSelectors.length) {
res = res.filter(channelId => applyEnumSelectors(channelId));
}
} else if (name === 'channel') {
if (!context.channels) {
// TODO: fill the channels and maintain them on all places where context.stateIds will be changed
}
// go through all channels
res = Object.keys(context.channels);
// filter out those that don't match every ID selector for the channel ID
if (objectIdSelectors.length) {
res = res.filter(channelId => applyIDSelectors(channelId, objectIdSelectors));
}
// filter out those that don't match every common selector
if (commonSelectors.length) {
res = res.filter(channelId => applyCommonSelectors(channelId));
}
// filter out those that don't match every native selector
if (nativeSelectors.length) {
res = res.filter(channelId => applyNativeSelectors(channelId));
}
// filter out those that don't match every enum selector
if (enumSelectors.length) {
res = res.filter(channelId => applyEnumSelectors(channelId));
}
// retrieve the state ID collection for all remaining channels
res = res.map(id => context.channels[id])
// and flatten the array to get only the state IDs
.reduce((acc, next) => acc.concat(next), []);
// now filter out those that don't match every ID selector for the state ID
if (stateIdSelectors.length) {
res = res.filter(stateId => applyIDSelectors(stateId, stateIdSelectors));
}
} else if (name === 'device') {
if (!context.devices) {
// TODO: fill the devices and maintain them on all places where context.stateIds will be changed
}
// go through all devices
res = Object.keys(context.devices);
// filter out those that don't match every ID selector for the channel ID
if (objectIdSelectors.length) {
res = res.filter(deviceId => applyIDSelectors(deviceId, objectIdSelectors));
}
// filter out those that don't match every common selector
if (commonSelectors.length) {
res = res.filter(deviceId => applyCommonSelectors(deviceId));
}
// filter out those that don't match every native selector
if (nativeSelectors.length) {
res = res.filter(deviceId => applyNativeSelectors(deviceId));
}
// filter out those that don't match every enum selector
if (enumSelectors.length) {
res = res.filter(deviceId => applyEnumSelectors(deviceId));
}
// retrieve the state ID collection for all remaining devices
res = res.map(id => context.devices[id])
// and flatten the array to get only the state IDs
.reduce((acc, next) => acc.concat(next), []);
// now filter out those that don't match every ID selector for the state ID
if (stateIdSelectors.length) {
res = res.filter(stateId => applyIDSelectors(stateId, stateIdSelectors));
}
} else {
// go through all states
res = context.stateIds;
// if the "name" is not state, then we filter for the ID as well
if (name && name !== 'state') {
const r = new RegExp(`^${name.replace(/\./g, '\\.').replace(/\*/g, '.*')}$`);
res = res.filter(id => r.test(id));
}
// filter out those that don't match every ID selector for the object ID or the state ID
if (objectIdSelectors.length) {
res = res.filter(id => applyIDSelectors(id, objectIdSelectors));
}
// filter out those that don't match every ID selector for the state ID
if (stateIdSelectors.length) {
res = res.filter(id => applyIDSelectors(id, stateIdSelectors));
}
// filter out those that don't match every common selector
if (commonSelectors.length) {
res = res.filter(id => applyCommonSelectors(id));
}
// filter out those that don't match every native selector
if (nativeSelectors.length) {
res = res.filter(id => applyNativeSelectors(id));
}
// filter out those that don't match every enum selector
if (enumSelectors.length) {
res = res.filter(id => applyEnumSelectors(id));
}
}
const resUnique = [...new Set(res)];
for (let i = 0; i < resUnique.length; i++) {
result[i] = resUnique[i];
}
result.length = resUnique.length;
// Implementing the Symbol.iterator contract makes the query result iterable
result[Symbol.iterator] = function*() {
for (let i = 0; i < result.length; i++) {
yield result[i];
}
};
result.each = function (callback) {
if (typeof callback === 'function') {
let r;
for (let i = 0; i < this.length; i++) {
r = callback(result[i], i);
if (r === false) break;
}
}
return this;
};
result.getState = function (callback) {
if (adapter.config.subscribe) {
if (typeof callback !== 'function') {
sandbox.log('You cannot use this function synchronous', 'error');
} else {
adapter.getForeignState(this[0], (err, state) => callback(err, context.convertBackStringifiedValues(this[0], state)));
}
} else {
if (!this[0]) {
return null;
}
if (context.interimStateValues[this[0]] !== undefined) {
return context.convertBackStringifiedValues(this[0], context.interimStateValues[this[0]]);
}
return context.convertBackStringifiedValues(this[0], states[this[0]]);
}
};
result.getStateAsync = async function() {
if (adapter.config.subscribe) {
const state = await adapter.getForeignStateAsync(this[0]);
return context.convertBackStringifiedValues(this[0], state);
} else {
if (!this[0]) {
return null;
}
if (context.interimStateValues[this[0]] !== undefined) {
return context.convertBackStringifiedValues(this[0], context.interimStateValues[this[0]]);
}
return context.convertBackStringifiedValues(this[0], states[this[0]]);
}
};
result.getBinaryState = function (callback) {
sandbox.log(`$.getBinaryState(id=${this[0]}) is deprecated. Please use Files instead!`, 'info');
if (adapter.config.subscribe) {
if (typeof callback !== 'function') {
sandbox.log('You cannot use this function synchronous', 'error');
} else {
if (typeof adapter.getForeignBinaryState === 'function') {
adapter.getForeignBinaryState(this[0], callback);
} else {
adapter.getBinaryState(this[0], callback);
}
}
} else {
return this[0] ? states[this[0]] : null;
}
};
result.getBinaryStateAsync = function() {
sandbox.log(`$.getBinaryStateAsync(id=${this[0]}) is deprecated. Please use Files instead!`, 'info');
if (adapter.config.subscribe) {
if (typeof adapter.getForeignBinaryStateAsync === 'function') {
return adapter.getForeignBinaryStateAsync(this[0]);
} else {
return adapter.getBinaryStateAsync(this[0]);
}
} else {
return this[0] ? states[this[0]] : null;
}
};
result.setState = function (state, isAck, callback) {
if (typeof isAck === 'function') {