Implemented static overrides

Author: sdasda7777

src/helpers/configs/default_config.js

@@ -34,13 +34,14 @@ module.exports = {
     // How frequently in milliseconds to check for updates
     updateInterval: 1000,
 
-    // Preferred provider of the album artwork
-    // Supported: "apple", "bandcamp", "deezer", "qobuz", "spotify", "soundcloud" and "tidal"
-    //   Use "musichoarders" to use closest fit from all services above
-    whereToFetchOnline: "musichoarders",
+    // Preferred provider of the album artwork. Supported values
+    //   "staticcverrides" (for values from `config/staticoverrides.js`)
+    //   "musichoarders" (for closest fit from servicese below)
+    //   "apple", "bandcamp", "deezer", "qobuz", "spotify", "soundcloud" and "tidal"
+    whereToFetchOnline: "staticoverrides",
 
     // Preferred provider of the rpc button (as above + "youtube")
-    changeButtonProvider: "spotify",
+    changeButtonProvider: "staticoverrides",
 
     // Whether to use persistent cache for MusicHoarders queries
     persistentMusicHoardersCache: false,

src/helpers/configs/default_staticoverrides.js

@@ -0,0 +1,43 @@
+
+// Include your static overrides here
+// Overrides may use album artist name or album name in keys, most specific combination being used first
+// Overrides must contain fetchedFrom, artworkUrl and joinUrl in aggregate value to be used
+// For example:
+/*
+module.exports = [
+  {key: {albumArtist: "Artist1", albumName: "Album1"},
+   value: {fetchedFrom: "Example1", artworkUrl: "example1.jpg", joinUrl: "example1"}},
+
+  {key: {albumName: "Album2"},
+   value: {joinUrl: "example2a"}},
+  {key: {albumArtist: "Artist1", albumName: "Album2"},
+   value: {fetchedFrom: "Example2b", artworkUrl: "example2b.jpg", joinUrl: "example2b"}},
+
+  {key: {albumArtist: "Artist1"},
+   value: {fetchedFrom: "Example3", artworkUrl: "example3.jpg"}},
+  {key: {albumName: "Album3"},
+   value: {joinUrl: "example3"}},
+]
+*/
+// will return:
+
+//   for "Album1" by "Artist1":
+//     {fetchedFrom: "Example1", artworkUrl: "example1.jpg", joinUrl: "example1"}
+//       (no tricks here, key is exact match and values are complete)
+
+//   for "Album2" by "Artist1":
+//     {fetchedFrom: "Example2b", artworkUrl: "example2b.jpg", joinUrl: "example2b"}
+//       (because the most specific key is used first)
+
+//   for "Album3" by "Artist1":
+//     {fetchedFrom: "Example3", artworkUrl: "example3.jpg", joinUrl: "example3"}
+//       (because partial information gets combined)
+
+//   for "Album4" by "Artist1" or "Album1", "Album2", "Album3" by "Artist2":
+//     nothing
+//       (because some values wouldn't be set)
+
+
+module.exports = [
+
+]

src/rpc/format.js

@@ -5,11 +5,13 @@
 
 const fs = require('fs');
 const log = require('../helpers/lager.js');
-const config = require('../helpers/configLoader.js').getOrInit('config.js');
+const cl = require('../helpers/configLoader.js');
+const config = cl.getOrInit('config.js');
 const axios = require('axios');
 const yt = require("ytsr");
 const path = require("path");
 
+let staticOverridesFetcher = new (require('./staticOverridesFetcher.js'))(cl.getOrInit('staticoverrides.js'));
 let musichoardersFetcher = new (require('./musichoardersFetcher.js'))(config.rpc.persistentMusicHoardersCache);
 
 // These functions, 'fetchers', provide uniform inteface for simple access to the APIs
@@ -18,6 +20,12 @@ let musichoardersFetcher = new (require('./musichoardersFetcher.js'))(config.rpc
 // In order to be as simple as possible, the functions may throw exceptions or not return anything.
 //   They are expected to be called through the `fetchSafely()` wrapper.
 const fetchers = {
+  "staticoverrides": async (metadata) => {
+    return staticOverridesFetcher.fetch(metadata);
+  },
+  "musichoarders": async (metadata) => {
+    return musichoardersFetcher.fetch("musichoarders", metadata);
+  },
   "apple": async (metadata) => { // Doesn't rely on MusicHoarders, keep it that way, just in case
     if ((metadata.ALBUMARTIST || metadata.artist) && metadata.title)
     {
@@ -44,9 +52,6 @@ const fetchers = {
   "deezer": async (metadata) => {
     return musichoardersFetcher.fetch("deezer", metadata);
   },
-  "musichoarders": async (metadata) => {
-    return musichoardersFetcher.fetch("musichoarders", metadata);
-  },
   "qobuz": async (metadata) => {
     return musichoardersFetcher.fetch("qobuz", metadata);
   },

src/rpc/staticOverridesFetcher.js

@@ -0,0 +1,56 @@
+
+class StaticOverridesFetcher
+{
+  /** Overrides data to use */
+  #data
+
+  constructor(rawData)
+  {
+    this.#data = {};
+    for (let v of rawData)
+    {
+      // Use key stringified with sorted keys
+      this.#data[JSON.stringify(v.key, Object.keys(v.key).sort())] = v.value;
+    }
+  }
+
+  fetch(metadata)
+  {
+    let result = {};
+
+    for (let v of StaticOverridesFetcher.createPowerset(metadata.ALBUMARTIST,
+                                                        metadata.album))
+    {
+      let lookup_result = this.#data[JSON.stringify(v)];
+
+      if (lookup_result)
+      {
+        if (!result.fetchedFrom && lookup_result.fetchedFrom)
+          result.fetchedFrom = lookup_result.fetchedFrom;
+        if (!result.artworkUrl && lookup_result.artworkUrl)
+          result.artworkUrl = lookup_result.artworkUrl;
+        if (!result.joinUrl && lookup_result.joinUrl)
+          result.joinUrl = lookup_result.joinUrl;
+
+        if (result.fetchedFrom && result.artworkUrl && result.joinUrl)
+          return result;
+      }
+    }
+  }
+
+  static createPowerset(albumArtist, albumName)
+  {
+    let result = [];
+
+    if (albumArtist && albumName)
+      result.push({albumArtist, albumName});
+    if (albumArtist)
+      result.push({albumArtist});
+    if (albumName)
+      result.push({albumName});
+
+    return result;
+  }
+}
+
+module.exports = StaticOverridesFetcher;