« get me outta code hell

playlist-utils.js « src - http-music - Command-line music player + utils (not a server!)
about summary refs log tree commit diff
path: root/src/playlist-utils.js
blob: f8170371c16563d051318474f5157eaf89db898c (plain)
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
'use strict'

const path = require('path')
const fs = require('fs')

const { promisify } = require('util')
const unlink = promisify(fs.unlink)

const parentSymbol = Symbol('Parent group')
const oldSymbol = Symbol('Old track or group reference')
const sourceSymbol = Symbol('Source-playlist item reference')

function updatePlaylistFormat(playlist, firstTime = false) {
  const defaultPlaylist = {
    options: [],
    items: []
  }

  let playlistObj = {}

  // Playlists can be in two formats...
  if (Array.isArray(playlist)) {
    // ..the first, a simple array of tracks and groups;

    playlistObj = {items: playlist}
  } else {
    // ..or an object including metadata and configuration as well as the
    // array described in the first.

    playlistObj = playlist

    // The 'tracks' property was used for a while, but it doesn't really make
    // sense, since we also store groups in the 'tracks' property. So it was
    // renamed to 'items'.
    if ('tracks' in playlistObj) {
      playlistObj.items = playlistObj.tracks
      delete playlistObj.tracks
    }
  }

  const fullPlaylistObj = Object.assign(defaultPlaylist, playlistObj)

  return updateGroupFormat(fullPlaylistObj, firstTime)
}

function updateGroupFormat(group, firstTime = false) {
  const defaultGroup = {
    name: '',
    items: [],
    [oldSymbol]: group
  }

  let groupObj = {}

  if (Array.isArray(group[1])) {
    groupObj = {name: group[0], items: group[1]}
  } else {
    groupObj = group
  }

  groupObj = Object.assign(defaultGroup, groupObj)

  groupObj.items = groupObj.items.map(item => {
    // Check if it's a group; if not, it's probably a track.
    if (typeof item[1] === 'array' || item.items) {
      item = updateGroupFormat(item, firstTime)
    } else {
      item = updateTrackFormat(item)

      // TODO: Should this also apply to groups? Is recursion good? Probably
      // not!
      //
      // TODO: How should saving/serializing handle this? For now it just saves
      // the result, after applying. (I.e., "apply": {"foo": "baz"} will save
      // child tracks with {"foo": "baz"}.)
      if (groupObj.apply) {
        Object.assign(item, groupObj.apply)
      }
    }

    item[parentSymbol] = groupObj

    if (firstTime) {
      item[sourceSymbol] = item
    }

    return item
  })

  return groupObj
}

function updateTrackFormat(track) {
  const defaultTrack = {
    name: '',
    downloaderArg: '',
    [oldSymbol]: track
  }

  let trackObj = {}

  if (Array.isArray(track)) {
    if (track.length === 2) {
      trackObj = {name: track[0], downloaderArg: track[1]}
    } else {
      throw new Error("Unexpected non-length 2 array-format track")
    }
  } else {
    trackObj = track
  }

  return Object.assign(defaultTrack, trackObj)
}

function filterTracks(grouplike, handleTrack) {
  // Recursively filters every track in the passed grouplike. The track-handler
  // function passed should either return true (to keep a track) or false (to
  // remove the track). After tracks are filtered, groups which contain no
  // items are removed.

  if (typeof handleTrack !== 'function') {
    throw new Error("Missing track handler function")
  }

  return Object.assign({}, grouplike, {
    items: grouplike.items.filter(item => {
      if (isTrack(item)) {
        return handleTrack(item)
      } else {
        return true
      }
    }).map(item => {
      if (isGroup(item)) {
        return filterTracks(item, handleTrack)
      } else {
        return item
      }
    }).filter(item => {
      if (isGroup(item)) {
        return item.items.length > 0
      } else {
        return true
      }
    })
  })
}

function flattenGrouplike(grouplike) {
  // Flattens a group-like, taking all of the non-group items (tracks) at all
  // levels in the group tree and returns them as a new group containing those
  // tracks.

  return {
    items: grouplike.items.map(item => {
      if (isGroup(item)) {
        return flattenGrouplike(item).items
      } else {
        return [item]
      }
    }).reduce((a, b) => a.concat(b), [])
  }
}

function collectGrouplikeChildren(grouplike, filter = null) {
  // Collects all descendants of a grouplike into a single flat array.
  // Can be passed a filter function, which will decide whether or not to add
  // an item to the return array. However, note that all descendants will be
  // checked against this function; a group will be descended through even if
  // the filter function checks false against it.
  // Returns an array, not a grouplike.

  const items = []

  for (const item of grouplike.items) {
    if (filter === null || filter(item) === true) {
      items.push(item)
    }

    if (isGroup(item)) {
      items.push(...collectGrouplikeChildren(item, filter))
    }
  }

  return items
}

function partiallyFlattenGrouplike(grouplike, resultDepth) {
  // Flattens a grouplike so that it is never more than a given number of
  // groups deep, INCLUDING the "top" group -- e.g. a resultDepth of 2
  // means that there can be one level of groups remaining in the resulting
  // grouplike, plus the top group.

  if (resultDepth <= 1) {
    return flattenGrouplike(grouplike)
  }

  const items = grouplike.items.map(item => {
    if (isGroup(item)) {
      return {items: partiallyFlattenGrouplike(item, resultDepth - 1).items}
    } else {
      return item
    }
  })

  return {items}
}

function collapseGrouplike(grouplike) {
  // Similar to partiallyFlattenGrouplike, but doesn't discard the individual
  // ordering of tracks; rather, it just collapses them all to one level.

  // Gather the groups. The result is an array of groups.
  // Collapsing [Kar/Baz/Foo, Kar/Baz/Lar] results in [Foo, Lar].
  // Aha! Just collect the top levels.
  // Only trouble is what to do with groups that contain both groups and
  // tracks. Maybe give them their own separate group (e.g. Baz).

  const subgroups = grouplike.items.filter(x => isGroup(x))
  const nonGroups = grouplike.items.filter(x => !isGroup(x))

  // Get each group's own collapsed groups, and store them all in one big
  // array.
  const ret = subgroups.map(group => {
    return collapseGrouplike(group).items
  }).reduce((a, b) => a.concat(b), [])

  if (nonGroups.length) {
    ret.unshift({name: grouplike.name, items: nonGroups})
  }

  return {items: ret}
}

function filterGrouplikeByProperty(grouplike, property, value) {
  // Returns a copy of the original grouplike, only keeping tracks with the
  // given property-value pair. (If the track's value for the given property
  // is an array, this will check if that array includes the given value.)

  return Object.assign({}, grouplike, {
    items: grouplike.items.map(item => {
      if (isGroup(item)) {
        const newGroup = filterGrouplikeByProperty(item, property, value)
        if (newGroup.items.length) {
          return newGroup
        } else {
          return false
        }
      } else if (isTrack(item)) {
        const itemValue = item[property]
        if (Array.isArray(itemValue) && itemValue.includes(value)) {
          return item
        } else if (item[property] === value) {
          return item
        } else {
          return false
        }
      } else {
        return item
      }
    }).filter(item => item !== false)
  })
}

function filterPlaylistByPathString(playlist, pathString) {
  // Calls filterGroupContentsByPath, taking an unparsed path string.

  return filterGrouplikeByPath(playlist, parsePathString(pathString))
}

function filterGrouplikeByPath(grouplike, pathParts) {
  // Finds a group by following the given group path and returns it. If the
  // function encounters an item in the group path that is not found, it logs
  // a warning message and returns the group found up to that point. If the
  // pathParts array is empty, it returns the group given to the function.

  if (pathParts.length === 0) {
    return grouplike
  }

  let firstPart = pathParts[0]
  let possibleMatches

  if (firstPart.startsWith('?')) {
    possibleMatches = collectGrouplikeChildren(grouplike)
    firstPart = firstPart.slice(1)
  } else {
    possibleMatches = grouplike.items
  }

  const titleMatch = (group, caseInsensitive = false) => {
    let a = group.name
    let b = firstPart

    if (caseInsensitive) {
      a = a.toLowerCase()
      b = b.toLowerCase()
    }

    return a === b || a === b + '/'
  }

  let match = possibleMatches.find(g => titleMatch(g, false))

  if (!match) {
    match = possibleMatches.find(g => titleMatch(g, true))
  }

  if (match) {
    if (pathParts.length > 1) {
      const rest = pathParts.slice(1)
      return filterGrouplikeByPath(match, rest)
    } else {
      return match
    }
  } else {
    console.warn(`Not found: "${firstPart}"`)
    return null
  }
}

function removeGroupByPathString(playlist, pathString) {
  // Calls removeGroupByPath, taking a path string, rather than a parsed path.

  return removeGroupByPath(playlist, parsePathString(pathString))
}

function removeGroupByPath(playlist, pathParts) {
  // Removes the group at the given path from the given playlist.

  const groupToRemove = filterGrouplikeByPath(playlist, pathParts)

  if (groupToRemove === null) {
    return
  }

  if (playlist === groupToRemove) {
    console.error(
      'You can\'t remove the playlist from itself! Instead, try --clear' +
      ' (shorthand -c).'
    )

    return
  }

  if (!(parentSymbol in groupToRemove)) {
    console.error(
      `Group ${pathParts.join('/')} doesn't have a parent, so we can't` +
      ' remove it from the playlist.'
    )

    return
  }

  const parent = groupToRemove[parentSymbol]

  const index = parent.items.indexOf(groupToRemove)

  if (index >= 0) {
    parent.items.splice(index, 1)
  } else {
    console.error(
      `Group ${pathParts.join('/')} doesn't exist, so we can't explicitly ` +
      'ignore it.'
    )
  }
}

function getPlaylistTreeString(playlist, showTracks = false) {
  function recursive(group) {
    const groups = group.items.filter(x => isGroup(x))
    const nonGroups = group.items.filter(x => !isGroup(x))

    const childrenString = groups.map(group => {
      const name = group.name
      const groupString = recursive(group)

      if (groupString) {
        const indented = groupString.split('\n').map(l => '| ' + l).join('\n')
        return '\n' + name + '\n' + indented
      } else {
        return name
      }
    }).join('\n')

    let tracksString = ''
    if (showTracks) {
      tracksString = nonGroups.map(g => g.name).join('\n')
    }

    if (tracksString && childrenString) {
      return tracksString + '\n' + childrenString
    } else if (childrenString) {
      return childrenString
    } else if (tracksString) {
      return tracksString
    } else {
      return ''
    }
  }

  return recursive(playlist)
}

function getItemPath(item) {
  if (item[parentSymbol]) {
    return [...getItemPath(item[parentSymbol]), item]
  } else {
    return [item]
  }
}

function getItemPathString(item) {
  // Gets the playlist path of an item by following its parent chain.
  //
  // Returns a string in format Foo/Bar/Baz, where Foo and Bar are group
  // names, and Baz is the name of the item.
  //
  // Unnamed parents are given the name '(Unnamed)'.
  // Always ignores the root (top) group.
  //
  // Requires that the given item be from a playlist processed by
  // updateGroupFormat.

  // Check if the parent is not the top level group.
  // The top-level group is included in the return path as '/'.
  if (item[parentSymbol]) {
    const displayName = item.name || '(Unnamed)'

    if (item[parentSymbol][parentSymbol]) {
      return getItemPathString(item[parentSymbol]) + '/' + displayName
    } else {
      return '/' + displayName
    }
  } else {
    return '/'
  }
}

function parsePathString(pathString) {
  const pathParts = pathString.split('/').filter(item => item.length)
  return pathParts
}

function isSameTrack(track1, track2) {
  // Compares the two old-version chains of the given tracks. If there's any
  // overlap, return true, as they are simply different versions of the same
  // track; otherwise, return false.

  // HAHAHA. You cannot convince me this isn't a good usage of generators.
  const chain = function*(track) {
    let oldTrack = track
    while (oldTrack[oldSymbol]) {
      yield (oldTrack = oldTrack[oldSymbol])
    }
  }

  const track2Chain = Array.from(chain(track2))

  for (const oldTrack1 of chain(track1)) {
    if (track2Chain.includes(oldTrack1)) {
      return true
    }
  }

  return false
}

function getTrackIndexInParent(track) {
  if (parentSymbol in track === false) {
    throw new Error(
      'getTrackIndexInParent called with a track that has no parent!'
    )
  }

  const parent = track[parentSymbol]

  let i = 0, foundTrack = false;
  for (; i < parent.items.length; i++) {
    if (isSameTrack(track, parent.items[i])) {
      foundTrack = true
      break
    }
  }

  if (foundTrack === false) {
    return [-1, parent.items.length]
  } else {
    return [i, parent.items.length]
  }
}

function isGroup(obj) {
  return !!(obj && obj.items)

  // return Array.isArray(array[1])
}

function isTrack(obj) {
  return !!(obj && obj.downloaderArg)

  // return typeof array[1] === 'string'
}

async function safeUnlink(file, playlist) {
  if (!playlist) {
    throw new Error('No playlist given to safe-unlink.')
  }

  // TODO: Is it good to call this every time? - But flattening a list probably
  // isn't THAT big of a task.
  const flat = flattenGrouplike(playlist)

  if (
    flat.items.some(t => path.resolve(t.downloaderArg) === path.resolve(file))
  ) {
    throw new Error(
      'Attempted to delete a file path found in the playlist.json file - ' +
      'this is almost definitely a bug!'
    )
  }

  try {
    await unlink(file)
  } catch(err) {
    if (err.code === 'ENOENT') {
      console.trace(
        `Attempted to delete file "${file}" which does not exist. This ` +
        'could be because of a temporary file being automatically deleted ' +
        'by the system before now, or because of http-music attempting to ' +
        'delete a temporary file which it has already deleted; otherwise ' +
        'this is almost certainly a bug.'
      )
    } else {
      throw err
    }
  }
}

module.exports = {
  parentSymbol, oldSymbol, sourceSymbol,
  updatePlaylistFormat, updateTrackFormat,
  filterTracks,
  flattenGrouplike,
  partiallyFlattenGrouplike, collapseGrouplike,
  filterGrouplikeByProperty,
  filterPlaylistByPathString, filterGrouplikeByPath,
  removeGroupByPathString, removeGroupByPath,
  getPlaylistTreeString,
  getItemPath, getItemPathString,
  parsePathString,
  isSameTrack,
  getTrackIndexInParent,
  isGroup, isTrack,
  safeUnlink
}

if (require.main === module) {
  const compareArrays = (a, b) => {
    return a.length === b.length && a.every((x, i) => b[i] === x)
  }

  const _assert = (value, condition) => {
    if (condition(value)) {
      console.log('  ..good.')
    } else {
      console.log('  BAD! result:', value)
    }
  }

  const assert = (value, expectedValue) => {
    return _assert(value, x => x === expectedValue)
  }

  const assertArray = (value, expectedValue) => {
    return _assert(value, x => compareArrays(x, expectedValue))
  }

  console.log('compareArrays')

  {
    console.log('- ([a, b], [a, b]) should return true')
    assert(compareArrays(['a', 'b'], ['a', 'b']), true)
  }

  {
    console.log('- ([a, b], [30, 20]) should return false')
    assert(compareArrays(['a', 'b'], [30, 20]), false)
  }

  {
    console.log('- ([a, b], [a, b, c]) should return false')
    assert(compareArrays(['a', 'b'], ['a', 'b', 'c']), false)
  }

  console.log('getItemPathString')

  {
    console.log('- (root with name) should return /a/b/c/Foo')

    const playlist = updatePlaylistFormat(
      {name: 'root', items: [
        {name: 'a', items: [
          {name: 'b', items: [
            {name: 'c', items: [
              {name: 'Foo'}
            ]}
          ]}
        ]}
      ]}
    )

    const deepTrack = playlist.items[0].items[0].items[0].items[0]

    assert(getItemPathString(deepTrack), '/a/b/c/Foo')
  }

  {
    console.log('- (root without name) should return /a/b/c/Foo')

    const playlist = updatePlaylistFormat(
      {items: [
        {name: 'a', items: [
          {name: 'b', items: [
            {name: 'c', items: [
              {name: 'Foo'}
            ]}
          ]}
        ]}
      ]}
    )

    const deepTrack = playlist.items[0].items[0].items[0].items[0]

    assert(getItemPathString(deepTrack), '/a/b/c/Foo')
  }

  {
    console.log('- (sub-group without name) should return /a/b/(Unnamed)/c/Foo')

    const playlist = updatePlaylistFormat(
      {items: [
        {name: 'a', items: [
          {name: 'b', items: [
            {items: [
              {name: 'c', items: [
                {name: 'Foo'}
              ]}
            ]}
          ]}
        ]}
      ]}
    )

    const deepTrack = playlist.items[0].items[0].items[0].items[0].items[0]

    assert(getItemPathString(deepTrack), '/a/b/(Unnamed)/c/Foo')
  }

  {
    console.log('- (path string of root) should return /')

    const playlist = updatePlaylistFormat({items: []})

    assert(getItemPathString(playlist), '/')
  }

  console.log('parsePathString')

  {
    console.log('- (foo/bar/baz) should return [foo, bar, baz]')
    assertArray(parsePathString('foo/bar/baz'), ['foo', 'bar', 'baz'])
  }

  {
    console.log('- (/foo/bar/baz) should return [foo, bar, baz]')
    assertArray(parsePathString('/foo/bar/baz'), ['foo', 'bar', 'baz'])
  }

  {
    console.log('- (/) should return []')
    assertArray(parsePathString('/'), [])
  }

  {
    console.log('- (/////foo) should return [foo]')
    assertArray(parsePathString('/////foo'), ['foo'])
  }

  {
    console.log('- (//foo/////bar//) should return [foo, bar]')
    assertArray(parsePathString('//foo/////bar//'), ['foo', 'bar'])
  }

  console.log('partiallyFlattenGrouplike')

  test: {
    console.log('- ([[a1, [aa1]], out], 2) should return [[a1, aa1], out]')

    const playlist = updatePlaylistFormat({name: 'top', items: [
      {name: 'a', items: [
        {name: 'a1'},
        {name: 'aa', items: [
          {name: 'aa1'}
        ]}
      ]},
      {name: 'out'}
    ]})

    const result = partiallyFlattenGrouplike(playlist, 2)

    console.log('  -> ' + JSON.stringify(result, null))

    // TODO: A nicer way to compare playlists, haha.
    assert(result.items.length, 2)
    assert(result.items[0].items.length, 2)
    assert(result.items[0].items[0].name, 'a1')
    assert(result.items[0].items[1].name, 'aa1')
    assert(result.items[1].name, 'out')
  }

  console.log('collapseGrouplike')

  test: {
    console.log('- (top: [a: [a1, aa: [aa1], a2], out])')

    const playlist = updatePlaylistFormat({name: 'top', items: [
      {name: 'a', items: [
        {name: 'a1'},
        {name: 'aa', items: [
          {name: 'aa1'}
        ]},
        {name: 'a2'}
      ]},
      {name: 'out'}
    ]})

    const result = collapseGrouplike(playlist)

    console.log('  -> ' + JSON.stringify(result, null))

    // output should be [top: [out], a: [a1, a2], aa: [aa1]]
    assert(result.items.length, 3)
    assert(result.items[0].name, 'top')
    assert(result.items[0].items.length, 1)
    assert(result.items[0].items[0].name, 'out')
    assert(result.items[1].name, 'a')
    assert(result.items[1].items.length, 2)
    assert(result.items[1].items[0].name, 'a1')
    assert(result.items[1].items[1].name, 'a2')
    assert(result.items[2].name, 'aa')
    assert(result.items[2].items.length, 1)
    assert(result.items[2].items[0].name, 'aa1')
  }
}