forked from miraclx/freyr-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcli.js
executable file
·1759 lines (1684 loc) · 74.6 KB
/
cli.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
#!/usr/bin/env node
/* eslint-disable consistent-return, camelcase, prefer-promise-reject-errors */
const fs = require('fs');
const xurl = require('url');
const xpath = require('path');
const crypto = require('crypto');
const {spawn, spawnSync} = require('child_process');
const Conf = require('conf');
const open = require('open');
const xget = require('libxget');
const ffmpeg = require('fluent-ffmpeg');
const lodash = require('lodash');
const merge2 = require('merge2');
const mkdirp = require('mkdirp');
const xbytes = require('xbytes');
const Promise = require('bluebird');
const cStringd = require('stringd-colors');
const isOnline = require('is-online');
const prettyMs = require('pretty-ms');
const commander = require('commander');
const minimatch = require('minimatch');
const youtubedl = require('youtube-dl');
const filenamify = require('filenamify');
const TimeFormat = require('hh-mm-ss');
const ProgressBar = require('xprogress');
const countryData = require('country-data');
const {isBinaryFile} = require('isbinaryfile');
const symbols = require('./src/symbols');
const fileMgr = require('./src/file_mgr');
const pFlatten = require('./src/p_flatten');
const FreyrCore = require('./src/freyr');
const AuthServer = require('./src/cli_server');
const AsyncQueue = require('./src/async_queue');
const parseRange = require('./src/parse_range');
const StackLogger = require('./src/stack_logger');
const packageJson = require('./package.json');
const streamUtils = require('./src/stream_utils');
const parseSearchFilter = require('./src/filter_parser');
function parseMeta(params) {
return Object.entries(params || {})
.filter(([, value]) => ![undefined, null].includes(value))
.map(([key, value]) =>
Array.isArray(value) ? value.map(tx => (tx ? [`--${key}`, ...(Array.isArray(tx) ? tx : [tx])] : '')) : [`--${key}`, value],
)
.flat(Infinity);
}
function extendPathOnEnv(path) {
return {...process.env, PATH: [process.env.PATH, path].join(process.platform === 'win32' ? ';' : ':')};
}
function ensureBinExtIfWindows(isWin, command) {
return command.replace(/(\.exe)?$/, isWin ? '.exe' : '$1');
}
function check_bin_is_existent(bin, path) {
const isWin = process.platform === 'win32';
const command = isWin ? 'where' : 'which';
const {status} = spawnSync(ensureBinExtIfWindows(isWin, command), [bin], {env: extendPathOnEnv(path)});
if ([127, null].includes(status)) throw Error(`Unable to locate the command [${command}] within your PATH`);
return status === 0;
}
function wrapCliInterface(binaryName, binaryPath) {
return (file, args, cb) => {
const isWin = process.platform === 'win32';
const path = xpath.relative(__dirname, xpath.join('./bins', isWin ? 'windows' : 'posix'));
if (!binaryPath) {
const err = new Error(`Unable to find an executable ${binaryName} binary. Please install.`);
if (!check_bin_is_existent(binaryName, path))
if (typeof file === 'boolean') throw err;
else return cb(err);
binaryPath = ensureBinExtIfWindows(isWin, binaryName);
}
if (typeof file === 'string') spawn(binaryPath, [file, ...parseMeta(args)], {env: extendPathOnEnv(path)}).on('close', cb);
};
}
function getRetryMessage({meta, ref, retryCount, maxRetries, bytesRead, totalBytes, lastErr}) {
return cStringd(
[
':{color(red)}{⯈}:{color:close(red)} ',
`:{color(cyan)}@${meta ? 'meta' : ref}:{color:close(cyan)}`,
`{:{color(yellow)}${retryCount}:{color:close(yellow)}${
Number.isFinite(maxRetries) ? `/:{color(yellow)}${maxRetries}:{color:close(yellow)}` : ''
}}: `,
lastErr
? `${lastErr.code ? `[:{color(yellow)}${lastErr.code}:{color:close(yellow)}] ` : ''}(:{color(yellow)}${lastErr.message ||
lastErr}:{color:close(yellow)}) `
: '',
totalBytes
? `(:{color(cyan)}${
Number.isFinite(totalBytes) ? `${bytesRead}`.padStart(`${totalBytes}`.length, ' ') : bytesRead
}:{color:close(cyan)}${Number.isFinite(totalBytes) ? `/:{color(cyan)}${totalBytes}:{color:close(cyan)}` : ''})`
: '',
].join(''),
);
}
function prePadNum(val, total, min = 2) {
return `${val}`.padStart(Math.max(`${total}`.length, min), '0');
}
function prepProgressGen(options) {
return (size, slots, opts, indentLen, isFragment) => {
const forceFirst = options.singleBar || slots.length === 1 || slots.length > 20;
return ProgressBar.stream(size, slots, {
forceFirst,
length: 47,
pulsate: options.pulsateBar || !Number.isFinite(size),
bar: {separator: '|'},
// eslint-disable-next-line prettier/prettier
template: [
':{indent} [:{bullet}] :{label} :{flipper}',
':{indent} | :{bullet} :{_tag}',
':{bars}'
],
clean: true,
flipper: [...Array(10)].map((...[, i]) => `:{color}${':{bullet}'.repeat(i + 1)}:{color:close}`),
label: 'Downloading',
variables: {
_tag: `:{tag} (${isFragment ? 'fragments' : 'chunks'}: ${slots.length})`,
bullet: '\u2022',
bars: ({total}) =>
(Number.isFinite(total) && !forceFirst
? [':{indent} | [:{bar:complete}] [:3{percentage}%] [:{speed}] (:{eta})', ':{indent} | [:{bar}] [:{size}]']
: [`:{indent} | [:{bar}]${Number.isFinite(total) ? ' [:3{percentage}%]' : ''} [:{speed}] (:{eta}) [:{size}]`]
).join('\n'),
size: (stack, _size, total) => ((total = stack.total), `${stack.size()}${total !== Infinity ? `/:{size:total}` : ''}`),
indent: ` `.repeat(indentLen),
...opts,
},
});
};
}
/**
* Concise promise handler for ensuring proper core method dispatches and logging
*
* **Handlers**:
* * `onInit`: printed before the promise is awaited
* * `onErr`: printed if the promise was rejected
* * `noVal`: printed if a successfully resolved promise returned a null-ish value
* * `arrIsEmpty`: printed if a successfully resolved promise returned an empty array or if an array contains only null-ish values
* * `onPass`: printed only if the promise successfully fulfilled with a proper value
*
* In the event that any handler is `true`, its default printer would be used
* Except in the case of `onInit` and `onPass` whose default printer would be called even if a handler isn't specified
*
* If a handler's value is a function, its return value would only be printed if it is an array.
* Otherwise, `processPromise` assumes that you took care of the printing.
* @param {() => Promise<any>|Promise<any>} promise Promise to be awaited on
* @param {StackLogger} logger Logger to be used
* @param {{
* onInit: string | boolean | (() => any[] | boolean);
* onErr: string | boolean | (() => any[] | boolean);
* noVal: string | boolean | (() => any[] | boolean);
* arrIsEmpty: string | boolean | (() => any[] | boolean);
* onPass: string | boolean | (() => any[] | boolean);
* }} messageHandlers State logging handlers
*/
async function processPromise(promise, logger, messageHandlers) {
/**
* TODO: Add retry functionality
* ? Checking...(failed)
* ? [2/4] Retrying...(failed)
* ? [3/4] Retrying...(failed)
* ? [4/4] Retrying...(done)
*/
if (!messageHandlers) messageHandlers = {};
const isNdef = v => [undefined, null].includes(v);
function handleResultOf(value, msg, defaultHandler) {
if (msg === true || isNdef(msg)) msg = defaultHandler;
if (isNdef(msg)) return;
if (typeof msg === 'function') {
value = msg(value, logger);
if (Array.isArray(value)) logger.write(...value);
else if (typeof value === 'string') logger.write(value);
} else logger.print(msg);
}
// formerly .pre
if (messageHandlers.onInit !== false) handleResultOf(null, messageHandlers.onInit);
const result = await Promise.resolve(typeof promise === 'function' ? promise() : promise).reflect();
if (result.isRejected()) {
// formerly .err
if (messageHandlers.onErr !== false)
handleResultOf(result.reason(), messageHandlers.onErr, reason => [
'(failed%s)',
reason ? `: [${reason['SHOW_DEBUG_STACK' in process.env ? 'stack' : 'message'] || reason}]` : '',
'\n',
]);
return null;
}
const value = result.value();
// formerly .xerr
if (messageHandlers.noVal && (!value || value.err)) handleResultOf(value, messageHandlers.noVal, () => ['(no data)', '\n']);
// formerly .aerr
else if (
messageHandlers.arrIsEmpty &&
Array.isArray(value) &&
(value.length === 0 || value.every(item => [undefined, null].some(item)))
)
handleResultOf(value, messageHandlers.arrIsEmpty, () => ['(array contains no data)', '\n']);
// formerly .post
else if (messageHandlers.onPass !== false) handleResultOf(value, messageHandlers.onPass, () => ['[done]', '\n']);
return value;
}
const VALIDS = {
bitrates: FreyrCore.getBitrates(),
downloaders: FreyrCore.getEngineMetas()
.filter(meta => meta.PROPS.isSourceable)
.map(meta => meta.ID),
concurrency: ['queries', 'tracks', 'trackStage', 'downloader', 'encoder', 'embedder'],
};
function CHECK_FLAG_IS_NUM(variable, flagref, untype) {
// eslint-disable-next-line valid-typeof
if (typeof variable !== untype)
if (!(parseFloat(variable).toString() === variable && parseFloat(variable) >= 0))
throw new Error(`\`${flagref}\` if specified, must be given a valid positive \`${untype}\` datatype`);
else variable = parseInt(variable, 10);
return variable;
}
function CHECK_BIT_RATE_VAL(bitrate_arg) {
const bitrate = (match => (match ? match[1] : ''))((bitrate_arg || '').match(/^(\d+)(?:k(?:b(?:it)?)?(?:ps|\/s)?)?$/i));
if (!(bitrate && VALIDS.bitrates.includes(+bitrate)))
throw new Error(
`Invalid bitrate specification: [${bitrate_arg}]. Bitrate should be either of [${VALIDS.bitrates.join(', ')}]`,
);
return `${bitrate}k`;
}
async function PROCESS_INPUT_FILE(input_arg, type, allowBinary = false) {
if (!fs.existsSync(input_arg)) throw new Error(`${type} file [${input_arg}] is inexistent`);
const stat = fs.statSync(input_arg);
if (stat.size > 1048576) throw new Error(`${type} file [${input_arg}] is beyond the maximum 1 MiB size limit`);
if (!stat.isFile()) throw new Error(`${type} file [${input_arg}] is not a file`);
if (!allowBinary && (await isBinaryFile(input_arg, stat.size)))
throw new Error(`${type} file [${input_arg}] cannot be a binary file`);
return input_arg;
}
function PARSE_INPUT_LINES(lines) {
return lines
.map(line => line.toString().trim()) // Trim whitespaces
.filter(line => !!line && /^(?!\s*#)/.test(line)) // Ignore empty lines or lines that start with comments
.map(line => line.replace(/#.*$/, '').trim()) // Ignore comments at the end of lines
.flatMap(line => line.split(' '));
}
async function PROCESS_INPUT_ARG(input_arg) {
if (!input_arg) return [];
const inputSource =
input_arg === '-' ? process.stdin : fs.createReadStream(await PROCESS_INPUT_FILE(input_arg, 'Input', false));
const lines = await streamUtils
.collectBuffers(inputSource.pipe(streamUtils.buildSplitter(['\n', '\r\n'])), {
max: 1048576, // 1 MiB size limit
timeout: 15000, // Timeout read op after 15 seconds
})
.catch(er => {
if (er.code === 1) throw new Error(`Input stream is beyond the maximum 1 MiB size limit`);
if (er.code === 2) throw new Error(`Input stream read timed out after 15 seconds`);
});
return PARSE_INPUT_LINES(lines);
}
async function PROCESS_CONFIG_ARG(config_arg) {
const local_config = xpath.join(__dirname, 'conf.json');
if (!config_arg) return local_config;
return PROCESS_INPUT_FILE(config_arg, 'Config', false);
}
function PROCESS_IMAGE_SIZE(value) {
if (!['string', 'number'].includes(typeof value)) value = `${value.width}x${value.height}`;
let parts = value.toString().split(/(?<=\d+)x(?=\d+)/);
if (parts.some(part => parseInt(part, 10).toString() !== part)) return false;
parts = parts.map(part => parseInt(part, 10));
return {width: parts[0], height: parts[1] || parts[0]};
}
function PROCESS_DOWNLOADER_ORDER(value, throwEr) {
if (!Array.isArray(value)) return throwEr();
return value.filter(Boolean).map(item => (!VALIDS.downloaders.includes(item) ? throwEr(item) : item));
}
const [RULE_DEFAULTS, RULE_HANDLERS] = [
['id', 'uri', 'album', 'album_artist', 'isrc', 'label'],
{
title(spec, object, props) {
if (!('name' in object)) return;
return minimatch(object.name, spec, {nocase: !props.filterCase});
},
type(spec, object) {
if (spec && !['album', 'compilation'].includes(spec)) throw new Error(`Invalid rule specification: \`${spec}\``);
if (!('compilation' in object)) return;
return spec === 'compilation' ? object.compilation : !object.compilation;
},
artist(spec, object, props) {
if (!('artists' in object)) return;
return object.artists.some(artist => minimatch(artist, spec, {nocase: !props.filterCase}));
},
ntracks(spec, object) {
const parsed = parseRange.num(spec, true);
if (!('total_tracks' in object)) return;
return parsed.check(object.total_tracks);
},
trackn(spec, object) {
const parsed = parseRange.num(spec, true);
if (!('track_number' in object)) return;
return parsed.check(object.track_number);
},
duration(spec, object) {
const parsed = parseRange.time(spec, true);
if (!('duration' in object)) return;
return parsed.check(object.duration);
},
year(spec, object) {
const parsed = parseRange.num(spec, true);
if (!('release_date' in object)) return;
return parsed.check(new Date(object.release_date).getFullYear());
},
diskn(spec, object) {
const parsed = parseRange.num(spec, true);
if (!('track_number' in object)) return;
return parsed.check(object.disc_number);
},
explicit(spec, object) {
if (spec && !['true', 'false', 'inoffensive'].includes(spec)) throw new Error(`Invalid rule specification: \`${spec}\``);
if (!('contentRating' in object)) return;
return object.contentRating === (spec === 'true' ? 'explicit' : spec === 'false' ? 'clean' : undefined);
},
},
];
function CHECK_FILTER_FIELDS(arrayOfFields, props = {}) {
// use different rules to indicate "OR", not "AND"
const coreHandler = (rules, trackObject = {}, uncontain = false) => {
try {
rules.forEach(ruleObject =>
Object.entries(ruleObject).forEach(([rule, value]) => {
if (!(rule in RULE_HANDLERS || RULE_DEFAULTS.includes(rule))) throw new Error(`Invalid filter rule: [${rule}]`);
try {
const status = (
RULE_HANDLERS[rule] ||
((spec, object) => {
if (!(rule in object)) return;
return minimatch(`${object[rule]}`, spec, {nocase: !props.filterCase});
})
)(`${value}`, trackObject, props);
if (status !== undefined && !status) throw new Error(`Expected \`${value}\``);
} catch (reason) {
throw new Error(`<${rule}>, ${reason.message}`);
}
}),
);
return {status: true, reason: null};
} catch (reason) {
if (uncontain) throw new Error(`Filter rule: ${reason.message}`);
return {status: false, reason};
}
};
const rules = (arrayOfFields || []).reduce((a, v) => a.concat(parseSearchFilter(v).filters), []);
const wrappedHandler = (trackObject = {}, uncontain = false) => coreHandler(rules, trackObject, uncontain);
const handler = (...args) => wrappedHandler(...args);
handler.extend = _rules => {
if (!Array.isArray(_rules)) throw new TypeError('Filter rules must be a valid array');
coreHandler(_rules, {}, true);
rules.push(..._rules);
return handler;
};
return handler;
}
async function init(queries, options) {
const initTimeStamp = Date.now();
const stackLogger = new StackLogger({indentSize: 1, autoTick: false});
if (!((Array.isArray(queries) && queries.length > 0) || options.input))
stackLogger.error('\x1b[31m[i]\x1b[0m Please enter a valid query'), process.exit(1);
try {
options.retries = CHECK_FLAG_IS_NUM(
`${options.retries}`.toLowerCase() === 'infinite' ? Infinity : options.retries,
'-r, --retries',
'number',
);
options.metaRetries = CHECK_FLAG_IS_NUM(
`${options.metaRetries}`.toLowerCase() === 'infinite' ? Infinity : options.metaRetries,
'-t, --meta-tries',
'number',
);
options.cover = options.cover && xpath.basename(options.cover);
options.chunks = CHECK_FLAG_IS_NUM(options.chunks, '-n, --chunks', 'number');
options.timeout = CHECK_FLAG_IS_NUM(options.timeout, '--timeout', 'number');
options.bitrate = CHECK_BIT_RATE_VAL(options.bitrate);
options.input = await PROCESS_INPUT_ARG(options.input);
options.config = await PROCESS_CONFIG_ARG(options.config);
if (options.memCache) options.memCache = CHECK_FLAG_IS_NUM(options.memCache, '--mem-cache', 'number');
(options.filter = CHECK_FILTER_FIELDS(options.filter, {filterCase: options.filterCase}))({}, true);
options.concurrency = Object.fromEntries(
(options.concurrency || [])
.map(item => (([k, v]) => (v ? [k, v] : ['tracks', k]))(item.split('=')))
.map(([k, v]) => {
if (!VALIDS.concurrency.includes(k))
throw Error(`key identifier for the \`-z, --concurrency\` flag must be valid. found [key: ${k}]`);
return [k, CHECK_FLAG_IS_NUM(v, '-z, --concurrency', 'number')];
}),
);
if (options.storefront) {
const data = countryData.lookup.countries({alpha2: options.storefront.toUpperCase()});
if (data.length) options.storefront = data[0].alpha2.toLowerCase();
else throw new Error('Country specification with the `--storefront` option is invalid');
}
if (options.coverSize) {
const err = new Error(
`Invalid \`--cover-size\` specification [${options.coverSize}]. (expected: <width>x<height> or <size> as <size>x<size>)`,
);
if (!(options.coverSize = PROCESS_IMAGE_SIZE(options.coverSize))) throw err;
}
options.downloader = PROCESS_DOWNLOADER_ORDER((options.downloader || '').split(','), item => {
throw new Error(`downloader specification within the \`--downloader\` must be valid. found [${item}]`);
});
} catch (err) {
stackLogger.error('\x1b[31m[i]\x1b[0m', err.message || err);
process.exit(2);
}
let Config = {
server: {
hostname: 'localhost',
port: 36346,
useHttps: false,
},
opts: {
netCheck: true,
attemptAuth: true,
autoOpenBrowser: true,
},
dirs: {
output: '.',
},
playlist: {
always: false, // always create playlists for queries
append: true, // append to end of file for regular queries
escape: true, // whether or not to escape invalid characters
forceAppend: false, // whether or not to forcefully append collections as well
dir: null, // directory to write playlist to
namespace: null, // namespace to prefix playlist entries with
},
image: {
width: 640,
height: 640,
},
filters: [],
concurrency: {
queries: 1,
tracks: 1,
trackStage: 6,
downloader: 4,
encoder: 6,
embedder: 10,
},
downloader: {
memCache: true,
cacheSize: 209715200,
order: ['yt_music', 'youtube'],
},
};
try {
if (fs.existsSync(options.config)) {
Config = lodash.mergeWith(Config, JSON.parse(fs.readFileSync(options.config)), (a, b, k) =>
k === 'order' && [a, b].every(Array.isArray) ? b.concat(a) : undefined,
);
} else {
stackLogger.error(`\x1b[31m[!]\x1b[0m Configuration file [${xpath.relative('.', options.config)}] not found`);
process.exit(3);
}
const errMessage = new Error(`[key: image, value: ${JSON.stringify(Config.image)}]`);
if (!(Config.image = PROCESS_IMAGE_SIZE(Config.image))) throw errMessage;
Config.downloader.order = PROCESS_DOWNLOADER_ORDER(Config.downloader.order, item => {
if (item) throw new Error(`Downloader order within the config file must be valid. found [${item}]`);
throw new Error(`Downloader order must be an array of strings`);
});
options.filter.extend(Config.filters);
} catch (err) {
stackLogger.error(`\x1b[31m[!]\x1b[0m Configuration file [${options.config}] wrongly formatted`);
stackLogger.error(err.message || err);
process.exit(3);
}
Config.image = lodash.merge(Config.image, options.coverSize);
Config.concurrency = lodash.merge(Config.concurrency, options.concurrency);
Config.dirs = lodash.merge(Config.dirs, {
output: options.directory,
cache: options.cacheDir,
});
Config.opts = lodash.merge(Config.opts, {
netCheck: options.netCheck,
attemptAuth: options.auth,
autoOpenBrowser: options.browser,
});
Config.playlist = lodash.merge(Config.playlist, {
always: !!options.playlist,
append: !options.playlistNoappend,
escape: !options.playlistNoescape,
forceAppend: options.playlistForceAppend,
dir: options.playlistDir,
namespace: options.playlistNamespace,
});
Config.downloader = lodash.mergeWith(
Config.downloader,
{
memCache: options.memCache !== undefined ? !!options.memCache : undefined,
cacheSize: options.memCache,
order: options.downloader,
},
(a, b, k) => (k === 'order' ? Array.from(new Set(b.concat(a))) : b !== undefined ? b : undefined),
);
if (Config.opts.netCheck && !(await isOnline()))
stackLogger.error('\x1b[31m[!]\x1b[0m Failed To Detect An Internet Connection'), process.exit(4);
const BASE_DIRECTORY = (path => (xpath.isAbsolute(path) ? path : xpath.relative('.', path || '.') || '.'))(Config.dirs.output);
if (!fs.existsSync(BASE_DIRECTORY))
stackLogger.error(`\x1b[31m[!]\x1b[0m Working directory [${BASE_DIRECTORY}] doesn't exist`), process.exit(5);
if (
(await processPromise(Promise.promisify(fs.access)(BASE_DIRECTORY, fs.constants.W_OK), stackLogger, {
onInit: 'Checking directory permissions...',
})) === null
)
process.exit(5);
let freyrCore;
try {
freyrCore = new FreyrCore(Config.services, AuthServer, Config.server);
} catch (err) {
stackLogger.error(`\x1b[31m[!]\x1b[0m Failed to initialize a Freyr Instance`);
stackLogger.error(err.message || err);
process.exit(6);
}
const schema = {
services: {
type: 'object',
additionalProperties: false,
default: {},
properties: {},
},
};
freyrCore.ENGINES.forEach(engine => {
schema.services.default[engine[symbols.meta].ID] = {};
schema.services.properties[engine[symbols.meta].ID] = {
type: 'object',
additionalProperties: false,
properties: engine[symbols.meta].PROP_SCHEMA || {},
};
});
const freyrCoreConfig = new Conf({
projectName: 'FreyrCLI',
projectSuffix: '',
configName: 'd3fault',
fileExtension: 'x4p',
schema,
});
const sourceStack = freyrCore.sortSources(Config.downloader.order);
const atomicParsley = wrapCliInterface('AtomicParsley', options.atomicParsley);
try {
if (options.ffmpeg) {
if (!fs.existsSync(options.ffmpeg)) throw new Error(`\x1b[31mffmpeg\x1b[0m: Binary not found [${options.ffmpeg}]`);
if (!(await isBinaryFile(options.ffmpeg)))
stackLogger.warn('\x1b[33mffmpeg\x1b[0m: Detected non-binary file, trying anyways...');
ffmpeg.setFfmpegPath(options.ffmpeg);
}
if (options.atomicParsley) {
if (!fs.existsSync(options.atomicParsley))
throw new Error(`\x1b[31mAtomicParsley\x1b[0m: Binary not found [${options.atomicParsley}]`);
if (!(await isBinaryFile(options.atomicParsley)))
stackLogger.warn('\x1b[33mAtomicParsley\x1b[0m: Detected non-binary file, trying anyways...');
} else atomicParsley(true);
if (options.youtubeDl) {
if (!fs.existsSync(options.youtubeDl))
throw new Error(`\x1b[31myoutube-dl\x1b[0m: Script not found [${options.youtubeDl}]`);
youtubedl.setYtdlBinary(options.youtubeDl);
}
} catch (err) {
stackLogger.error(err.message);
process.exit(7);
}
const progressGen = prepProgressGen(options);
function createPlaylist(header, stats, logger, filename, playlistTitle, shouldAppend) {
if (options.playlist !== false) {
const validStats = stats.filter(stat => (stat.code === 0 ? stat.complete : !stat.code));
if (validStats.length) {
logger.print('[\u2022] Creating playlist...');
const playlistFile = xpath.join(
Config.playlist.dir || BASE_DIRECTORY,
`${filenamify(filename, {replacement: '_'})}.m3u8`,
);
const isNew =
!(fs.existsSync(playlistFile) && fs.statSync(playlistFile).size) || !(!options.playlistNoappend || shouldAppend);
const plStream = fs.createWriteStream(playlistFile, {encoding: 'utf8', flags: !isNew ? 'a' : 'w'});
if (isNew) {
plStream.write('#EXTM3U\n');
if (playlistTitle) plStream.write(`#${playlistTitle.replace(/\n/gm, '\n# ')}\n`);
if (header) plStream.write(`#${header}\n`);
}
let {namespace} = Config.playlist;
namespace = namespace ? xurl.format(xurl.parse(namespace)).concat('/') : '';
validStats.forEach(({meta: {track: {uri, name, artists, duration}, service, outFilePath}}) =>
plStream.write(
[
'',
`#${service[symbols.meta].DESC} URI: ${uri}`,
`#EXTINF:${Math.round(duration / 1e3)},${artists[0]} - ${name}`,
`${namespace.concat(
(entry => (!Config.playlist.escape ? entry : encodeURI(entry).replace(/#/g, '%23')))(
xpath.relative(BASE_DIRECTORY, outFilePath),
),
)}`,
'',
].join('\n'),
),
);
plStream.close();
logger.write('[done]\n');
logger.log(`[\u2022] Playlist file: [${playlistFile}]`);
}
} else logger.log(`[\u2022] Skipped playlist creation`);
}
function downloadToStream({urlOrFragments, outputFile, logger, opts}) {
opts = {tag: '', successMessage: '', failureMessage: '', retryMessage: '', ...opts};
[opts.tag, opts.errorHandler, opts.retryMessage, opts.failureMessage, opts.successMessage] = [
opts.tag,
opts.errorHandler,
opts.retryMessage,
opts.failureMessage,
opts.successMessage,
].map(val => (typeof val === 'function' || val === false ? val : () => val));
return new Promise((res, rej) => {
let completed = false;
if (!Array.isArray(urlOrFragments)) {
const feed = xget(urlOrFragments, {
auto: false,
cache: Config.downloader.memCache,
chunks: options.chunks,
retries: options.retries,
timeout: options.timeout,
cacheSize: Config.downloader.cacheSize,
})
.with('progressBar', urlMeta =>
progressGen(
urlMeta.size,
urlMeta.chunkStack.map(chunk => chunk.size),
{tag: opts.tag(urlMeta)},
logger.indentation(),
false,
),
)
.use('progressBar', (dataSlice, store) => store.get('progressBar').next(dataSlice.next))
.on('end', () => {
if (feed.store.has('progressBar')) feed.store.get('progressBar').end(opts.successMessage(), '\n');
else logger.write(opts.successMessage(), '\n');
})
.on('retry', data => {
if (opts.retryMessage !== false) {
if (feed.store.has('progressBar'))
data.store.get('progressBar').print(opts.retryMessage({ref: data.index + 1, ...data}));
else logger.write(opts.retryMessage(data), '\n');
}
})
.once('error', err => {
if (completed) return;
err = Object(err);
if (feed.store.has('progressBar')) feed.store.get('progressBar').end(opts.failureMessage(err), '\n');
else logger.write(opts.failureMessage(err), '\n');
opts.errorHandler(err);
rej(err);
});
feed.setHeadHandler(({acceptsRanges}) => {
let [offset, writeStream] = [];
if (acceptsRanges && fs.existsSync(outputFile)) ({size: offset} = fs.statSync(outputFile));
if (offset) {
opts.resumeHandler(offset);
writeStream = fs.createWriteStream(outputFile, {flags: 'a'});
} else writeStream = fs.createWriteStream(outputFile, {flags: 'w'});
feed.pipe(writeStream).on('finish', () => ((completed = true), res(writeStream.bytesWritten)));
return offset;
});
feed.start();
} else {
const barGen = progressGen(
urlOrFragments.reduce((total, fragment) => total + fragment.size, 0),
urlOrFragments.map(fragment => fragment.size),
{tag: opts.tag()},
logger.indentation(),
true,
);
let has_erred = false;
const writeStream = fs.createWriteStream(outputFile);
merge2(
...urlOrFragments.map((frag, i) => {
const feed = xget(frag.url, {
cache: Config.downloader.memCache,
chunks: 1,
retries: options.retries,
timeout: options.timeout,
cacheSize: Config.downloader.cacheSize,
})
.on('retry', data => {
if (opts.retryMessage !== false) barGen.print(opts.retryMessage({ref: `${i}[${data.index + 1}]`, ...data}));
})
.once('error', err => {
if (completed) return;
if (has_erred) return feed.destroy();
err = Object(err);
has_erred = true;
err.segment_index = i;
barGen.end(opts.failureMessage(err), '\n');
opts.errorHandler(err);
rej(err);
});
return feed.pipe(barGen.next(frag.size));
}),
)
.once('end', () => barGen.end(opts.successMessage(), '\n'))
.pipe(writeStream)
.on('finish', () => ((completed = true), res(writeStream.bytesWritten)));
// TODO: support resumption of segmented resources
// TODO: retry fragments?
}
});
}
const downloadQueue = new AsyncQueue(
'cli:downloadQueue',
Config.concurrency.downloader,
async ({track, meta, feedMeta, trackLogger}) => {
const baseCacheDir = 'fr3yrcach3';
const imageFile = await fileMgr({
filename: `freyrcli-${meta.fingerprint}.x4i`,
tempdir: Config.dirs.cacheDir === '<tmp>' ? undefined : Config.dirs.cacheDir,
dirname: baseCacheDir,
keep: true,
});
const imageBytesWritten = await downloadToStream({
urlOrFragments: track.getImage(Config.image.width, Config.image.height),
outputFile: imageFile.name,
logger: trackLogger,
opts: {
tag: '[Retrieving album art]...',
// errorHandler: () => imageFile.removeCallback(),
retryMessage: data => trackLogger.getText(`| ${getRetryMessage(data)}`),
resumeHandler: offset => trackLogger.log(cStringd(`| :{color(yellow)}{i}:{color:close(yellow)} Resuming at ${offset}`)),
failureMessage: err =>
trackLogger.getText(`| [\u2715] Failed to get album art${err ? ` [${err.code || err.message}]` : ''}`),
successMessage: trackLogger.getText(`| [\u2713] Got album art`),
},
}).catch(err => Promise.reject({err, code: 3}));
const rawAudio = await fileMgr({
filename: `freyrcli-${meta.fingerprint}.x4a`,
tempdir: Config.dirs.cacheDir === '<tmp>' ? undefined : Config.dirs.cacheDir,
dirname: baseCacheDir,
keep: true,
});
const audioBytesWritten = await downloadToStream(
lodash.merge(
{
outputFile: rawAudio.name,
logger: trackLogger,
opts: {
tag: `[‘${meta.trackName}’]`,
retryMessage: data => trackLogger.getText(`| ${getRetryMessage(data)}`),
resumeHandler: offset =>
trackLogger.log(cStringd(`| :{color(yellow)}{i}:{color:close(yellow)} Resuming at ${offset}`)),
successMessage: trackLogger.getText('| [\u2713] Got raw track file'),
},
},
feedMeta.protocol !== 'http_dash_segments'
? {
urlOrFragments: feedMeta.url,
opts: {
errorHandler: () => rawAudio.removeCallback(),
failureMessage: err =>
trackLogger.getText(`| [\u2715] Failed to get raw media stream${err ? ` [${err.code || err.message}]` : ''}`),
},
}
: {
urlOrFragments: feedMeta.fragments.map(({path}) => ({
url: `${feedMeta.fragment_base_url}${path}`,
...(([, min, max]) => ({min: +min, max: +max, size: +max - +min + 1}))(path.match(/range\/(\d+)-(\d+)$/)),
})),
opts: {
failureMessage: err =>
trackLogger.getText(
`| [\u2715] Segment error while getting raw media${err ? ` [${err.code || err.message}]` : ''}`,
),
},
},
),
).catch(err => Promise.reject({err, code: 4}));
return {
image: {file: imageFile, bytesWritten: imageBytesWritten},
audio: {file: rawAudio, bytesWritten: audioBytesWritten},
};
},
);
const embedQueue = new AsyncQueue(
'cli:postprocessor:embedQueue',
Config.concurrency.embedder,
async ({track, meta, files, audioSource}) => {
return Promise.promisify(atomicParsley)(meta.outFilePath, {
overWrite: '', // overwrite the file
title: track.name, // ©nam
artist: track.artists[0], // ©ART
composer: track.composers, // ©wrt
album: track.album, // ©alb
genre: (genre => (genre ? genre.concat(' ') : ''))((track.genres || [])[0]), // ©gen | gnre
tracknum: `${track.track_number}/${track.total_tracks}`, // trkn
disk: `${track.disc_number}/${track.disc_number}`, // disk
year: new Date(track.release_date).toISOString().split('T')[0], // ©day
compilation: track.compilation, // ©cpil
gapless: options.gapless, // pgap
rDNSatom: [
// ----
['Digital Media', 'name=MEDIA', 'domain=com.apple.iTunes'],
[track.isrc, 'name=ISRC', 'domain=com.apple.iTunes'],
[track.artists[0], 'name=ARTISTS', 'domain=com.apple.iTunes'],
[track.label, 'name=LABEL', 'domain=com.apple.iTunes'],
[`${meta.service[symbols.meta].DESC}: ${track.uri}`, 'name=SOURCE', 'domain=com.apple.iTunes'],
[
`${audioSource.service[symbols.meta].DESC}: ${audioSource.source.videoId}`,
'name=PROVIDER',
'domain=com.apple.iTunes',
],
],
advisory: ['explicit', 'clean'].includes(track.contentRating) // rtng
? track.contentRating
: track.contentRating === true
? 'explicit'
: 'Inoffensive',
stik: 'Normal', // stik
// geID: 0, // geID: genreID. See `AtomicParsley --genre-list`
// sfID: 0, // ~~~~: store front ID
// cnID: 0, // cnID: catalog ID
albumArtist: track.album_artist, // aART
// ownr? <owner>
purchaseDate: 'timestamp', // purd
apID: 'cli@freyr.git', // apID
copyright: track.copyrights.sort(({type}) => (type === 'P' ? -1 : 1))[0].text, // cprt
encodingTool: `freyr-js cli v${packageJson.version}`, // ©too
encodedBy: 'd3vc0dr', // ©enc
artwork: files.image.file.name, // covr
// sortOrder: [
// ['name', 'NAME'], // sonm
// ['album', 'NAME'], // soal
// ['artist', 'NAME'], // soar
// ['albumartist', 'NAME'], // soaa
// ],
})
.finally(() => files.image.file.removeCallback())
.catch(err => Promise.reject({err, code: 8}));
},
);
const encodeQueue = new AsyncQueue(
'cli:postprocessor:encodeQueue',
Config.concurrency.encoder,
async ({track, meta, files}) => {
return new Promise((res, rej) =>
ffmpeg()
.addInput(files.audio.file.name)
.audioCodec('aac')
.audioBitrate(options.bitrate)
.audioFrequency(44100)
.noVideo()
.setDuration(TimeFormat.fromMs(track.duration, 'hh:mm:ss.sss'))
.toFormat('ipod')
.saveToFile(meta.outFilePath)
.on('error', err => rej({err, code: 7}))
.on('end', res),
).finally(() => files.audio.file.removeCallback());
},
);
const postProcessor = new AsyncQueue('cli:postProcessor', 4, async ({track, meta, files, audioSource}) => {
await mkdirp(meta.outFileDir).catch(err => Promise.reject({err, code: 6}));
const wroteImage =
!!options.cover &&
(outArtPath =>
!(fs.existsSync(outArtPath) && !fs.statSync(outArtPath).isFile()) &&
(fs.copyFileSync(files.image.file.name, outArtPath), true))(xpath.join(meta.outFileDir, options.cover));
await encodeQueue.push({track, meta, files});
await embedQueue.push({track, meta, files, audioSource});
return {wroteImage, finalSize: fs.statSync(meta.outFilePath).size};
});
function buildSourceCollectorFor(track, selector) {
async function handleSource(iterator, lastErr) {
const result = {service: null, sources: null, lastErr};
if ((result.service = iterator.next().value)) {
result.sources = Promise.resolve(
result.service.search(track.artists, track.name.replace(/\s*\((((feat|ft).)|with).+\)/, ''), track.duration),
).then(sources => {
if ([undefined, null].includes(sources)) throw new Error(`incompatible source response. recieved [${sources}]`);
// arrays returned from service source calls should have at least one item
if (Array.isArray(sources) && sources.length === 0) throw new Error('Zero sources found');
const source = (
selector ||
(results => {
try {
return results[0];
} catch {
throw new Error(`error while extracting feed from source, try defining a <selector>. recieved [${results}]`);
}
})
)(sources);
if ([undefined, null].includes(source)) throw new Error(`incompatible response item. recieved: [${source}]`);
if (!('getFeeds' in source)) throw new Error(`service provided no means for source to collect feeds`);
let feedTries = 1;
const getFeeds = () =>
source.getFeeds().catch(err => ((feedTries += 1) <= options.metaRetries ? getFeeds() : Promise.reject(err)));
const feeds = getFeeds();
Promise.resolve(feeds).catch(() => {}); // diffuse feeds result, in case of an asynchronous promise rejection
if ([undefined, null].includes(feeds)) throw new Error(`service returned no valid feeds for source`);
return {sources, source, feeds, service: result.service};
});
result.results = result.sources.catch(err => ({next: handleSource(iterator, err)}));
}
return result;
}
async function collect_contained(process, handler) {
process = await process;
if (!process.sources) return {err: process.lastErr};
await handler(process.service, process.sources);
const results = await process.results;
if (results.next) return collect_contained(results.next, handler);
return results;
}
const process = handleSource(sourceStack.values());
return async handler => collect_contained(process, handler);
}
const trackQueue = new AsyncQueue('cli:trackQueue', Config.concurrency.tracks, async ({track, meta, props}) => {
const trackLogger = props.logger.log(`\u2022 [${meta.trackName}]`).tick(3);
const filterStat = options.filter(track, false);
if (!filterStat.status) {
trackLogger.log("| [\u2022] Didn't match filter. Skipping...");
return {meta, code: 0, skip_reason: new Error(`Filtered out: ${filterStat.reason.message}`), complete: false};
}
if (props.fileExists) {
if (!props.processTrack) {
trackLogger.log('| [\u00bb] Track exists. Skipping...');
return {meta, code: 0, skip_reason: new Error('Exists'), complete: true};
}
trackLogger.log('| [\u2022] Track exists. Overwriting...');
}
trackLogger.log('| \u27a4 Collating sources...');
const audioSource = await props.collectSources((service, sourcesPromise) =>
processPromise(sourcesPromise, trackLogger, {
onInit: `| \u27a4 [\u2022] ${service[symbols.meta].DESC}...`,
arrIsEmpty: '[Unable to gather sources]',
onPass: ({sources}) => `[success, found ${sources.length} source${sources.length === 1 ? '' : 's'}]\n`,
}),
);
if ('err' in audioSource) return {meta, code: 1, err: audioSource.err}; // zero sources found
const audioFeeds = await processPromise(audioSource.feeds, trackLogger, {
onInit: '| \u27a4 Awaiting audiofeeds...',
noVal: '[Unable to collect source feeds]',
});
if (!audioFeeds || audioFeeds.err) return {meta, err: (audioFeeds || {}).err, code: 2};
const feedMeta = audioFeeds.formats.sort((meta1, meta2) => (meta1.abr > meta2.abr ? -1 : meta1.abr < meta2.abr ? 1 : 0))[0];
meta.fingerprint = crypto
.createHash('md5')