added improved Settings Manager

- real database used, instead of a json file --> a remote mysql db
- selective updating of rows and values
- generally better

usages of the old settings manager will be replaced in the following 
days

Author: ShadowLp174

commands/join.js

@@ -42,7 +42,7 @@ function joinChannel(message, cid, cb=()=>{}, ecb=()=>{}) {
     });
   })
   p.on("message", (m) => {
-    if ((this.settingsMgr.getServer(message.channel.serverId).get("songAnnouncements")) == "false") return;
+    if ((this.getSettings(message).get("songAnnouncements")) == "false") return;
     message.channel.sendMessage(this.em(m, message))
   });
   p.on("roomfetched", () => {

commands/settings.js

@@ -45,7 +45,6 @@ module.exports = {
         if (failed) return message.reply(this.em(failed, message), false);
         set.set(data.get("setting").value, data.get("value").value);
         message.reply(this.em("Settings changed!", message), false);
-        this.settingsMgr.saveAsync();
       break;
       case "getSettings":
         const setting = data.get("setting").value;

index.js

@@ -4,7 +4,7 @@ const { Revoice } = require("revoice.js");
 const { Client } = require("revolt.js");
 const path = require("path");
 const fs = require("fs");
-const { SettingsManager } = require("./settings/Settings.js");
+const { SettingsManager, RemoteSettingsManager } = require("./settings/Settings.js");
 if (!process.execArgv.includes("--inspect")) require('console-stamp')(console, 'HH:MM:ss.l');
 const YTDlpWrap = require("yt-dlp-wrap-extended").default;
 
@@ -38,6 +38,9 @@ class Remix {
 
     this.settingsMgr = new SettingsManager();
     this.settingsMgr.loadDefaultsSync("./storage/defaults.json");
+    // updated settings manager based on a mysql database:
+    // TODO: add self-hosting instr
+    this.rSettingsMgr = new RemoteSettingsManager(this.config.mysql, "./storage/defaults.json");
 
     this.uploader = new Uploader(this.client);
 
@@ -120,6 +123,7 @@ class Remix {
 
       if (!this.config.fetchUsers) return;
       this.fetchUsers(); // TODO: find out why I did this, there is a reason (Mabye caching?) but I have no clue and am scared to remove this
+      // future me here: most likely caching. This shouldn't be the reason for rate limits.
       setInterval(() => this.fetchUsers, 60 * 1000 * 30);
     });
     this.client.on("messageCreate", (m) => {
@@ -549,7 +553,7 @@ class Remix {
   }
   getSettings(message) {
     const serverId = message.channel.serverId;
-    return this.settingsMgr.getServer(serverId);
+    return this.rSettingsMgr.getServer(serverId);
   }
   observeUser(id, channel, cb) {
     this.observedUsers.set(id + ";" + channel, cb);

package.json

@@ -30,7 +30,7 @@
     "youtubei.js": "^5.1.0",
     "yt-dlp-wrap-extended": "^2.3.15",
     "yt-search": "^2.10.4",
-    "ytdl-core": "npm:@distube/ytdl-core@^4.15.8"
+    "ytdl-core": "npm:@distube/ytdl-core@^4.16.4"
   },
   "scripts": {
     "dev": "node --inspect index.js --trace-warnings",

settings/Settings.js

@@ -1,4 +1,5 @@
 const fs = require("fs");
+const mysql = require("mysql")
 
 class ServerSettings { // TODO: switch to better db system
   id;
@@ -36,7 +37,7 @@ class ServerSettings { // TODO: switch to better db system
     }
   }
   checkDefaults(d) {
-    for (key in d) {
+    for (let key in d) {
       if (!this.data[key]) this.data[key] = d[key];
     }
   }
@@ -155,4 +156,103 @@ class SettingsManager {
   }
 }
 
-module.exports = { SettingsManager, ServerSettings };
+class RemoteSettingsManager { // mysql based manager
+  guilds = new Map();
+  descriptions = {};
+  defaults = {};
+
+  serverConfig = null;
+
+  db = null;
+
+  constructor(config, defaultsPath) {
+    this.db = mysql.createPool({
+      connectionLimit : 15,
+      ...config
+    });
+
+    this.loadDefaultsSync(defaultsPath);
+
+    this.load();
+
+    return this;
+  }
+
+  query(query) {
+    return new Promise(res => {
+      this.db.query(query, (error, results, fields) => { res({ error, results, fields })});
+    });
+  }
+
+  async load() {
+    const res = await this.query("SELECT * FROM settings");
+    if (res.error) {
+      console.error("settings init error; ", res.error);
+      console.error("retrying in 2 seconds");
+      return setTimeout(() => {
+        this.load();
+      }, 2000);
+    }
+
+    const results = res.results;
+    results.forEach((r) => {
+      let server = new ServerSettings(r.id, this);
+      server.deserialize(JSON.parse(r.data));
+      server.checkDefaults(this.defaults);
+      this.guilds.set(server.id, server);
+    });
+  }
+  async remoteUpdate(server, key) {
+    const r = await this.query("UPDATE settings SET 'data' = JSON_SET('data', $." + key + ", '" + server.data[key] + "')")
+    if (r.error) console.error("settings update error; ", r.error);
+  }
+  async remoteSave(server) {
+    const r = await this.query("UPDATE settings SET 'data' = '" + JSON.stringify(server.data) + "' WHERE id='" + server.id + "'");
+    if (r.error) console.error("settings server save error; ", r.error);
+  }
+
+  loadDefaultsSync(filePath) {
+    const d = fs.readFileSync(filePath, "utf8");
+    let parsed = JSON.parse(d);
+    this.descriptions = parsed.descriptions;
+    this.defaults = parsed.values;
+  }
+
+  saveAsync() {
+    return new Promise(async (res) => {
+      const p = []; // promises
+      this.guilds.forEach((val, _k) => {
+        p.push(this.remoteSave(val));
+      });
+
+      await Promise.all(p);
+      res();
+    });
+  }
+  async create(id, server) {
+    const r = await this.query("INSERT INTO settings (id, data) VALUES ('" + id + "', '" + JSON.stringify(server.data) +  "')");
+    if (r.error) console.error("settings create server error; ", r.error);
+  }
+
+  update(server, key) {
+    if (!this.guilds.has(server.id)) {
+      this.guilds.set(server.id, server);
+      this.create(server.id, server);
+    }
+    const s = this.guilds.get(server.id);
+    s.data[key] = server.data[key];
+    this.remoteUpdate(server, key);
+  }
+  isOption(key) {
+    return key in this.defaults;
+  }
+
+  hasServer(id) {
+    return this.guilds.has(id);
+  }
+  getServer(id) {
+    return (!this.guilds.has(id)) ? new ServerSettings(id, this) : this.guilds.get(id);
+  }
+}
+
+module.exports = { SettingsManager, RemoteSettingsManager, ServerSettings };

storage/defaults.json

@@ -3,12 +3,14 @@
     "songAnnouncements": false,
     "prefix": "%",
     "pfp": "default",
-    "locale": "en"
+    "locale": "en",
+    "restrictVolume": false
   },
   "descriptions": {
     "songAnnouncements": "Wether the bot should announce every song when it starts playing it.",
     "prefix": "The prefix that is used to trigger commands. Alternatively, you can use a ping with a space after it.",
     "pfp": "What profile picture the bot should use. `default | dark | light | mono | <custom url>`",
-    "locale": "The preferred language of your server. For valid language codes please see the github repository."
+    "locale": "The preferred language of your server. For valid language codes please see the github repository.",
+    "restrictVolume": "If this is set to anything else than `false`, every user in the server will be able to change the volume. Otherwise only users with the `ManageChannel` permission can."
   }
 }