-
Notifications
You must be signed in to change notification settings - Fork 975
/
Copy pathcommon.js
3846 lines (3566 loc) · 137 KB
/
common.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
/**
* Module for some common utility functions and references
* @module api/utils/common
*/
/** @lends module:api/utils/common */
var common = {},
moment = require('moment-timezone'),
crypto = require('crypto'),
logger = require('./log.js'),
mcc_mnc_list = require('mcc-mnc-list'),
plugins = require('../../plugins/pluginManager.js'),
countlyConfig = require('./../config', 'dont-enclose'),
argon2 = require('argon2'),
mongodb = require('mongodb'),
getRandomValues = require('get-random-values'),
_ = require('lodash');
var matchHtmlRegExp = /"|'|&(?!amp;|quot;|#39;|lt;|gt;|#46;|#36;)|<|>/;
var matchLessHtmlRegExp = /[<>]/;
/**
* Because why requiring both all the time
*/
common.plugins = plugins;
/**
* Escape special characters in the given string of html.
* @param {string} string - The string to escape for inserting into HTML
* @param {bool} more - if false, escapes only tags, if true escapes also quotes and ampersands
* @returns {string} escaped string
**/
common.escape_html = function(string, more) {
var str = '' + string;
var match;
if (more) {
match = matchHtmlRegExp.exec(str);
}
else {
match = matchLessHtmlRegExp.exec(str);
}
if (!match) {
return str;
}
var escape;
var html = '';
var index = 0;
var lastIndex = 0;
for (index = match.index; index < str.length; index++) {
switch (str.charCodeAt(index)) {
case 34: // "
escape = '"';
break;
case 38: // &
escape = '&';
break;
case 39: // '
escape = ''';
break;
case 60: // <
escape = '<';
break;
case 62: // >
escape = '>';
break;
default:
continue;
}
if (lastIndex !== index) {
html += str.substring(lastIndex, index);
}
lastIndex = index + 1;
html += escape;
}
return lastIndex !== index ? html + str.substring(lastIndex, index) : html;
};
/**
* Function to escape unicode characters
* @param {string} str - string for which to escape
* @returns {string} escaped string
*/
common.encodeCharacters = function(str) {
try {
str = str + "";
str = str.replace(/\u0000/g, "▯");
str.replace(/[^\x00-\x7F]/g, function(c) {
return encodeURI(c);
});
return str;
}
catch {
return str;
}
};
/**
* Decode escaped html
* @param {string} string - The string to decode
* @returns {string} escaped string
**/
common.decode_html = function(string) {
string = string.replace(/'/g, "'");
string = string.replace(/"/g, '"');
string = string.replace(/</g, '<');
string = string.replace(/>/g, '>');
string = string.replace(/&/g, '&');
return string;
};
/**
* Escape special characters in the given value, may be nested object
* @param {string} key - key of the value
* @param {vary} value - value to escape
* @param {bool} more - if false, escapes only tags, if true escapes also quotes and ampersands
* @returns {vary} escaped value
**/
function escape_html_entities(key, value, more) {
if (typeof value === 'object' && value && (value.constructor === Object || value.constructor === Array)) {
if (Array.isArray(value)) {
let replacement = [];
for (let k = 0; k < value.length; k++) {
if (typeof value[k] === "string") {
let ob = getJSON(value[k]);
if (ob.valid) {
replacement[common.escape_html(k, more)] = JSON.stringify(escape_html_entities(k, ob.data, more));
}
else {
replacement[k] = common.escape_html(value[k], more);
}
}
else {
replacement[k] = escape_html_entities(k, value[k], more);
}
}
return replacement;
}
else {
let replacement = {};
for (let k in value) {
if (Object.hasOwnProperty.call(value, k)) {
if (typeof value[k] === "string") {
let ob = getJSON(value[k]);
if (ob.valid) {
replacement[common.escape_html(k, more)] = JSON.stringify(escape_html_entities(k, ob.data, more));
}
else {
replacement[common.escape_html(k, more)] = common.escape_html(value[k], more);
}
}
else {
replacement[common.escape_html(k, more)] = escape_html_entities(k, value[k], more);
}
}
}
return replacement;
}
}
return value;
}
common.getJSON = getJSON;
/**
* Check if string is a valid json
* @param {string} val - string that might be json encoded
* @returns {object} with property data for parsed data and property valid to check if it was valid json encoded string or not
**/
function getJSON(val) {
var ret = {valid: false};
try {
ret.data = JSON.parse(val);
if (ret.data && typeof ret.data === "object") {
ret.valid = true;
}
}
catch (ex) {
//silent error
}
return ret;
}
/**
* Logger object for creating module-specific logging
* @type {function(string): Logger}
* @example
* const log = common.log('myplugin:api');
* log.i('myPlugin got a request: %j', params.qstring);
*/
common.log = logger;
/**
* Mapping some common property names from longer understandable to shorter representation stored in database
* @type {object}
*/
common.dbMap = {
'events': 'e',
'total': 't',
'new': 'n',
'unique': 'u',
'duration': 'd',
'durations': 'ds',
'frequency': 'f',
'loyalty': 'l',
'sum': 's',
'dur': 'dur',
'count': 'c'
};
/**
* Mapping some common user property names from longer understandable to shorter representation stored in database
* @type {object}
*/
common.dbUserMap = {
'device_id': 'did',
'user_id': 'uid',
'first_seen': 'fs',
'last_seen': 'ls',
'last_payment': 'lp',
'session_duration': 'sd',
'total_session_duration': 'tsd',
'session_count': 'sc',
'device': 'd',
'device_type': 'dt',
'manufacturer': 'mnf',
'carrier': 'c',
'city': 'cty',
'region': 'rgn',
'country_code': 'cc',
'platform': 'p',
'platform_version': 'pv',
'app_version': 'av',
'last_begin_session_timestamp': 'lbst',
'last_end_session_timestamp': 'lest',
'has_ongoing_session': 'hos',
'previous_events': 'pe',
'resolution': 'r',
'has_hinge': 'hh',
};
common.dbUniqueMap = {
"*": [common.dbMap.unique],
users: [common.dbMap.unique, common.dbMap.durations, common.dbMap.frequency, common.dbMap.loyalty]
};
/**
* Mapping some common event property names from longer understandable to shorter representation stored in database
* @type {object}
*/
common.dbEventMap = {
'user_properties': 'up',
'timestamp': 'ts',
'segmentations': 'sg',
'count': 'c',
'sum': 's',
'duration': 'dur',
'previous_events': 'pe'
};
/**
* Default {@link countlyConfig} object for API server
* @type {object}
*/
common.config = countlyConfig;
/**
* Reference to momentjs
* @type {object}
*/
common.moment = moment;
/**
* Reference to crypto module
* @type {object}
*/
common.crypto = crypto;
/**
* Operating syste/platform mappings from what can be passed in metrics to shorter representations
* stored in db as prefix to OS segmented values
* @type {object}
*/
common.os_mapping = {
"webos": "webos",
"brew": "brew",
"unknown": "unk",
"undefined": "unk",
"tvos": "atv",
"apple tv": "atv",
"watchos": "wos",
"unity editor": "uty",
"qnx": "qnx",
"os/2": "os2",
"amazon fire tv": "aft",
"amazon": "amz",
"web": "web",
"windows": "mw",
"open bsd": "ob",
"searchbot": "sb",
"sun os": "so",
"solaris": "so",
"beos": "bo",
"mac osx": "o",
"macos": "o",
"mac": "o",
"osx": "o",
"linux": "l",
"unix": "u",
"ios": "i",
"android": "a",
"blackberry": "b",
"windows phone": "w",
"wp": "w",
"roku": "r",
"symbian": "s",
"chrome": "c",
"debian": "d",
"nokia": "n",
"firefox": "f",
"tizen": "t",
"arch": "l"
};
/**
* Whole base64 alphabet for fetching splitted documents
* @type {object}
*/
common.base64 = ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "+", "/"];
common.dbPromise = function() {
var args = Array.prototype.slice.call(arguments);
return new Promise(function(resolve, reject) {
var collection = common.db.collection(args[0]),
method = args[1];
if (method === 'find') {
collection[method].apply(collection, args.slice(2)).toArray(function(err, result) {
if (err) {
reject(err);
}
else {
resolve(result);
}
});
}
else {
collection[method].apply(collection, args.slice(2).concat([function(err, result) {
if (err) {
reject(err);
}
else {
resolve(result);
}
}]));
}
});
};
/**
* Fetches nested property values from an obj.
* @param {object} obj - standard countly metric object
* @param {string} desc - dot separate path to fetch from object
* @returns {object} fetched object from provided path
* @example
* //outputs {"u":20,"t":20,"n":5}
* common.getDescendantProp({"2017":{"1":{"2":{"u":20,"t":20,"n":5}}}}, "2017.1.2");
*/
common.getDescendantProp = function(obj, desc) {
desc = String(desc);
if (desc.indexOf(".") === -1) {
return obj[desc];
}
var arr = desc.split(".");
while (arr.length && (obj = obj[arr.shift()])) {
//doing operator in the loop condition
}
return obj;
};
/**
* Checks if provided value could be converted to a number,
* even if current type is other, as string, as example value "42"
* @param {any} n - value to check if it can be converted to number
* @returns {boolean} true if can be a number, false if can't be a number
* @example
* common.isNumber(1) //outputs true
* common.isNumber("2") //outputs true
* common.isNumber("test") //outputs false
*/
common.isNumber = function(n) {
return !isNaN(parseFloat(n)) && isFinite(n);
};
/**
* This default Countly behavior of type conversion for storing proeprties accepted through API requests
* dealing with numbers as strings and too long numbers
* @param {any} value - value to convert to usable type
* @param {boolean} preventParsingToNumber - do not change value to number (e.g. "1", ["1"]);
* @returns {varies} converted value
* @example
* common.convertToType(1) //outputs 1
* common.convertToType("2") //outputs 2
* common.convertToType("test") //outputs "test"
* common.convertToType("12345678901234567890") //outputs "12345678901234567890"
*/
common.convertToType = function(value, preventParsingToNumber) {
//handle array values
if (Array.isArray(value)) {
for (var i = 0; i < value.length; i++) {
value[i] = common.convertToType(value[i], true);
}
return value;
}
else if (value && typeof value === "object") {
for (var key in value) {
value[key] = common.convertToType(value[key]);
}
return value;
}
//if value can be a number
else if (common.isNumber(value)) {
//check if it is string but is less than 16 length
if (preventParsingToNumber) {
return value;
}
else if (value.length && value.length <= 16) {
//convert to number
return parseFloat(value);
}
//check if it is number, but longer than 16 digits (max limit)
else if ((Math.round(value) + "").length > 16) {
//convert to string
return value + "";
}
else {
//return number as is
return value;
}
}
else {
//return as string
return value + "";
}
};
/**
* Safe division between numbers providing 0 as result in cases when dividing by 0
* @param {number} dividend - number which to divide
* @param {number} divisor - number by which to divide
* @returns {number} result of division
* @example
* //outputs 0
* common.safeDivision(100, 0);
*/
common.safeDivision = function(dividend, divisor) {
var tmpAvgVal;
tmpAvgVal = dividend / divisor;
if (!tmpAvgVal || tmpAvgVal === Number.POSITIVE_INFINITY) {
tmpAvgVal = 0;
}
return tmpAvgVal;
};
/**
* Pad number with specified character from left to specified length
* @param {number} number - number to pad
* @param {number} width - pad to what length in symbols
* @returns {string} padded number
* @example
* //outputs 0012
* common.zeroFill(12, 4, "0");
*/
common.zeroFill = function(number, width) {
width -= number.toString().length;
if (width > 0) {
return new Array(width + (/\./.test(number) ? 2 : 1)).join('0') + number;
}
return number + ""; // always return a string
};
/**
* Add item or array to existing array only if values are not already in original array
* @param {array} arr - original array where to add unique elements
* @param {string|number|array} item - item to add or array to merge
*/
common.arrayAddUniq = function(arr, item) {
if (!arr) {
arr = [];
}
if (toString.call(item) === "[object Array]") {
for (var i = 0; i < item.length; i++) {
if (arr.indexOf(item[i]) === -1) {
arr[arr.length] = item[i];
}
}
}
else {
if (arr.indexOf(item) === -1) {
arr[arr.length] = item;
}
}
};
/**
* Create HMAC sha1 hash from provided value and optional salt
* @param {string} str - value to hash
* @param {string=} addSalt - optional salt, uses ms timestamp by default
* @returns {string} HMAC sha1 hash
*/
common.sha1Hash = function(str, addSalt) {
var salt = (addSalt) ? new Date().getTime() : '';
return crypto.createHmac('sha1', salt + '').update(str + '').digest('hex');
};
/**
* Create HMAC sha512 hash from provided value and optional salt
* @param {string} str - value to hash
* @param {string=} addSalt - optional salt, uses ms timestamp by default
* @returns {string} HMAC sha1 hash
*/
common.sha512Hash = function(str, addSalt) {
var salt = (addSalt) ? new Date().getTime() : '';
return crypto.createHmac('sha512', salt + '').update(str + '').digest('hex');
};
/**
* Create argon2 hash string
* @param {string} str - string to hash
* @returns {promise} hash promise
**/
common.argon2Hash = function(str) {
return argon2.hash(str);
};
/**
* Create MD5 hash from provided value
* @param {string} str - value to hash
* @returns {string} MD5 hash
*/
common.md5Hash = function(str) {
return crypto.createHash('md5').update(str + '').digest('hex');
};
/**
* Modifies provided object in the format object["2012.7.20.property"] = increment.
* Usualy used when filling up Countly metric model data
* @param {params} params - {@link params} object
* @param {object} object - object to fill
* @param {string} property - meric value or segment or property to fill/increment
* @param {number=} increment - by how much to increments, default is 1
* @returns {void} void
* @example
* var obj = {};
* common.fillTimeObject(params, obj, "u", 1);
* console.log(obj);
* //outputs
* { '2017.u': 1,
* '2017.2.u': 1,
* '2017.2.23.u': 1,
* '2017.2.23.8.u': 1,
* '2017.w8.u': 1 }
*/
common.fillTimeObject = function(params, object, property, increment) {
increment = (increment) ? increment : 1;
var timeObj = params.time;
if (!timeObj || !timeObj.yearly || !timeObj.monthly || !timeObj.weekly || !timeObj.daily || !timeObj.hourly) {
return false;
}
object[timeObj.yearly + '.' + property] = increment;
object[timeObj.monthly + '.' + property] = increment;
object[timeObj.daily + '.' + property] = increment;
// If the property parameter contains a dot, hourly data is not saved in
// order to prevent two level data (such as 2012.7.20.TR.u) to get out of control.
if (property.indexOf('.') === -1) {
object[timeObj.hourly + '.' + property] = increment;
}
// For properties that hold the unique visitor count we store weekly data as well.
if (property.substr(-2) === ("." + common.dbMap.unique) ||
property === common.dbMap.unique ||
property.substr(0, 2) === (common.dbMap.frequency + ".") ||
property.substr(0, 2) === (common.dbMap.loyalty + ".") ||
property.substr(0, 3) === (common.dbMap.durations + ".") ||
property === common.dbMap.paying) {
object[timeObj.yearly + ".w" + timeObj.weekly + '.' + property] = increment;
}
};
/**
* Creates a time object from request's milisecond or second timestamp in provided app's timezone
* @param {string} appTimezone - app's timezone
* @param {number} reqTimestamp - timestamp in the request
* @returns {timeObject} Time object for current request
*/
common.initTimeObj = function(appTimezone, reqTimestamp) {
var currTimestamp,
curMsTimestamp,
tmpMoment,
currDateWithoutTimestamp = moment();
// Check if the timestamp parameter exists in the request and is a 10 or 13 digit integer, handling also float timestamps with ms after dot
if (reqTimestamp && (Math.round(parseFloat(reqTimestamp, 10)) + "").length === 10 && common.isNumber(reqTimestamp)) {
// If the received timestamp is greater than current time use the current time as timestamp
currTimestamp = (parseInt(reqTimestamp, 10) > currDateWithoutTimestamp.unix()) ? currDateWithoutTimestamp.unix() : parseInt(reqTimestamp, 10);
curMsTimestamp = (parseInt(reqTimestamp, 10) > currDateWithoutTimestamp.unix()) ? currDateWithoutTimestamp.valueOf() : parseFloat(reqTimestamp, 10) * 1000;
tmpMoment = moment(currTimestamp * 1000);
}
else if (reqTimestamp && (Math.round(parseFloat(reqTimestamp, 10)) + "").length === 13 && common.isNumber(reqTimestamp)) {
var tmpTimestamp = Math.floor(parseInt(reqTimestamp, 10) / 1000);
currTimestamp = (tmpTimestamp > currDateWithoutTimestamp.unix()) ? currDateWithoutTimestamp.unix() : tmpTimestamp;
curMsTimestamp = (tmpTimestamp > currDateWithoutTimestamp.unix()) ? currDateWithoutTimestamp.valueOf() : parseInt(reqTimestamp, 10);
tmpMoment = moment(currTimestamp * 1000);
}
else {
tmpMoment = moment();
currTimestamp = tmpMoment.unix(); // UTC
curMsTimestamp = tmpMoment.valueOf();
}
if (appTimezone) {
currDateWithoutTimestamp.tz(appTimezone);
tmpMoment.tz(appTimezone);
}
/**
* @typedef timeObject
* @type {object}
* @global
* @property {momentjs} now - momentjs instance for request's time in app's timezone
* @property {momentjs} nowUTC - momentjs instance for request's time in UTC
* @property {momentjs} nowWithoutTimestamp - momentjs instance for current time in app's timezone
* @property {number} timestamp - request's seconds timestamp
* @property {number} mstimestamp - request's miliseconds timestamp
* @property {string} yearly - year of request time in app's timezone in YYYY format
* @property {string} monthly - month of request time in app's timezone in YYYY.M format
* @property {string} daily - date of request time in app's timezone in YYYY.M.D format
* @property {string} hourly - hour of request time in app's timezone in YYYY.M.D.H format
* @property {number} weekly - week of request time in app's timezone as result day of the year, divided by 7
* @property {string} month - month of request time in app's timezone in format M
* @property {string} day - day of request time in app's timezone in format D
* @property {string} hour - hour of request time in app's timezone in format H
*/
return {
now: tmpMoment,
nowUTC: tmpMoment.clone().utc(),
nowWithoutTimestamp: currDateWithoutTimestamp,
timestamp: currTimestamp,
mstimestamp: curMsTimestamp,
yearly: tmpMoment.format("YYYY"),
monthly: tmpMoment.format("YYYY.M"),
daily: tmpMoment.format("YYYY.M.D"),
hourly: tmpMoment.format("YYYY.M.D.H"),
weekly: Math.ceil(tmpMoment.format("DDD") / 7),
weeklyISO: tmpMoment.isoWeek(),
month: tmpMoment.format("M"),
day: tmpMoment.format("D"),
hour: tmpMoment.format("H")
};
};
/**
* Creates a Date object from provided seconds timestamp in provided timezone
* @param {number} timestamp - unix timestamp in seconds
* @param {string} timezone - name of the timezone
* @returns {moment} moment object for provided time
*/
common.getDate = function(timestamp, timezone) {
var tmpDate = (timestamp) ? moment.unix(timestamp) : moment();
if (timezone) {
tmpDate.tz(timezone);
}
return tmpDate;
};
/**
* Returns day of the year from provided seconds timestamp in provided timezone
* @param {number} timestamp - unix timestamp in seconds
* @param {string} timezone - name of the timezone
* @returns {number} current day of the year
*/
common.getDOY = function(timestamp, timezone) {
var endDate;
if (timestamp && timestamp.toString().length === 13) {
endDate = (timestamp) ? moment.unix(timestamp / 1000) : moment();
}
else {
endDate = (timestamp) ? moment.unix(timestamp) : moment();
}
if (timezone) {
endDate.tz(timezone);
}
return endDate.dayOfYear();
};
/**
* Returns amount of days in provided year
* @param {number} year - year to check for days
* @returns {number} number of days in provided year
*/
common.getDaysInYear = function(year) {
if (new Date(year, 1, 29).getMonth() === 1) {
return 366;
}
else {
return 365;
}
};
/**
* Returns amount of iso weeks in provided year
* @param {number} year - year to check for days
* @returns {number} number of iso weeks in provided year
*/
common.getISOWeeksInYear = function(year) {
var d = new Date(year, 0, 1),
isLeap = new Date(year, 1, 29).getMonth() === 1;
//Check for a Jan 1 that's a Thursday or a leap year that has a
//Wednesday Jan 1. Otherwise it's 52
return d.getDay() === 4 || isLeap && d.getDay() === 3 ? 53 : 52;
};
/**
* Validates provided arguments
* @param {object} args - arguments to validate
* @param {object} argProperties - rules for validating each argument
* @param {boolean} argProperties.required - should property be present in args
* @param {string} argProperties.type - what type should property be, possible values: String, Array, Number, URL, Boolean, Object, Email
* @param {string} argProperties.max-length - property should not be longer than provided value
* @param {string} argProperties.min-length - property should not be shorter than provided value
* @param {string} argProperties.exclude-from-ret-obj - should property be present in returned validated args object
* @param {string} argProperties.has-number - should string property has any number in it
* @param {string} argProperties.has-char - should string property has any latin character in it
* @param {string} argProperties.has-upchar - should string property has any upper cased latin character in it
* @param {string} argProperties.has-special - should string property has any none latin character in it
* @param {boolean} returnErrors - return error details as array or only boolean result
* @returns {object} validated args in obj property, or false as result property if args do not pass validation and errors array
*/
common.validateArgs = function(args, argProperties, returnErrors) {
if (arguments.length === 2) {
returnErrors = false;
}
var returnObj;
if (returnErrors) {
returnObj = {
result: true,
errors: [],
obj: {}
};
}
else {
returnObj = {};
}
if (!args) {
if (returnErrors) {
returnObj.result = false;
returnObj.errors.push("Missing 'args' parameter");
delete returnObj.obj;
return returnObj;
}
else {
return false;
}
}
for (var arg in argProperties) {
let argState = true,
parsed;
if (argProperties[arg].required) {
if (args[arg] === void 0) {
if (returnErrors) {
returnObj.errors.push("Missing " + arg + " argument");
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
}
if (args[arg] !== void 0) {
if (argProperties[arg].type) {
if (argProperties[arg].type === 'Number') {
if (toString.call(args[arg]) !== '[object ' + argProperties[arg].type + ']') {
if (returnErrors) {
returnObj.errors.push("Invalid type for " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
}
else if (argProperties[arg].type === 'String') {
if (argState && argProperties[arg].trim && args[arg]) {
args[arg] = args[arg].trim();
}
if (toString.call(args[arg]) !== '[object ' + argProperties[arg].type + ']') {
if (returnErrors) {
returnObj.errors.push("Invalid type for " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
}
else if (argProperties[arg].type === 'IntegerString') {
if (args[arg] === null && !argProperties[arg].required) {
// do nothing
}
else if (typeof args[arg] === 'string' && !isNaN(parseInt(args[arg]))) {
parsed = parseInt(args[arg]);
}
else if (typeof args[arg] === 'number') {
parsed = args[arg];
}
else {
if (returnErrors) {
returnObj.errors.push("Invalid type for " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
}
else if (argProperties[arg].type === 'URL') {
if (toString.call(args[arg]) !== '[object String]') {
if (returnErrors) {
returnObj.errors.push("Invalid type for " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
else {
if (argState && argProperties[arg].trim && args[arg]) {
args[arg] = args[arg].trim();
}
let { URL } = require('url');
try {
new URL(args[arg]);
}
catch (ignored) {
if (returnErrors) {
returnObj.errors.push('Invalid url string ' + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
}
}
else if (argProperties[arg].type === 'URLString') {
if (toString.call(args[arg]) !== '[object String]') {
if (returnErrors) {
returnObj.errors.push("Invalid type for " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
else {
let { URL } = require('url');
try {
parsed = new URL(args[arg]);
}
catch (ignored) {
if (returnErrors) {
returnObj.errors.push('Invalid URL string ' + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
}
}
else if (argProperties[arg].type === 'Email') {
if (toString.call(args[arg]) !== '[object String]') {
if (returnErrors) {
returnObj.errors.push("Invalid type for " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
else if (args[arg] && !/[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?/i.test(args[arg])) {
if (returnErrors) {
returnObj.errors.push("Invalid url string " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
}
else if (argProperties[arg].type === 'Boolean') {
if (!(args[arg] !== true || args[arg] !== false || toString.call(args[arg]) !== '[object Boolean]')) {
if (returnErrors) {
returnObj.errors.push("Invalid type for " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
}
else if (argProperties[arg].type === 'BooleanString') {
if (args[arg] === null && !argProperties[arg].required) {
// do nothing
}
else if (typeof args[arg] === 'string' && (args[arg] === 'true' || args[arg] === 'false')) {
parsed = args[arg] === 'true';
}
else if (typeof args[arg] === 'boolean') {
parsed = args[arg];
}
else {
if (returnErrors) {
returnObj.errors.push("Invalid type for " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
}
else if (argProperties[arg].type === 'Date') {
if (args[arg] === null && !argProperties[arg].required) {
// do nothing
}
else if (typeof args[arg] === 'string' && !isNaN(new Date(args[arg]))) {
parsed = new Date(args[arg]);
}
else if (typeof args[arg] === 'number' && args[arg] > 1000000000000 && args[arg] < 2000000000000) { // it's bad and I know it!
parsed = new Date(args[arg]);
}
else if (typeof args[arg] === 'number' && args[arg] > 1000000000 && args[arg] < 2000000000) { // it's bad and I know it!
parsed = new Date(args[arg] * 1000);
}
else if (args[arg] instanceof Date && !isNaN(new Date(args[arg]))) {
parsed = args[arg];
}
else {
if (returnErrors) {
returnObj.errors.push("Invalid type for " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;
}
}
}
else if (argProperties[arg].type === 'Array') {
if (!Array.isArray(args[arg])) {
if (returnErrors) {
returnObj.errors.push("Invalid type for " + arg);
returnObj.result = false;
argState = false;
}
else {
return false;