dbgate/packages/api/src/controllers/config.js

const fs = require('fs-extra');
const os = require('os');
const path = require('path');
const axios = require('axios');
const { datadir, getLogsFilePath } = require('../utility/directories');
const { hasPermission } = require('../utility/hasPermission');
const socket = require('../utility/socket');
const _ = require('lodash');
const AsyncLock = require('async-lock');

const currentVersion = require('../currentVersion');
const platformInfo = require('../utility/platformInfo');
const connections = require('../controllers/connections');
const { getAuthProviderFromReq } = require('../auth/authProvider');
const { checkLicense, checkLicenseKey } = require('../utility/checkLicense');
const { storageWriteConfig } = require('./storageDb');

const lock = new AsyncLock();

module.exports = {
  // settingsValue: {},

  // async _init() {
  //   try {
  //     this.settingsValue = JSON.parse(await fs.readFile(path.join(datadir(), 'settings.json'), { encoding: 'utf-8' }));
  //   } catch (err) {
  //     this.settingsValue = {};
  //   }
  // },

  get_meta: true,
  async get(_params, req) {
    const authProvider = getAuthProviderFromReq(req);
    const login = authProvider.getCurrentLogin(req);
    const permissions = authProvider.getCurrentPermissions(req);
    const isUserLoggedIn = authProvider.isUserLoggedIn(req);

    const singleConid = authProvider.getSingleConnectionId(req);

    const singleConnection = singleConid
      ? await connections.getCore({ conid: singleConid })
      : connections.singleConnection;

    let configurationError = null;
    if (process.env.STORAGE_DATABASE && process.env.BASIC_AUTH) {
      configurationError =
        'Basic authentization is not allowed, when using storage. Cannot use both STORAGE_DATABASE and BASIC_AUTH';
    }

    const checkedLicense = await checkLicense();
    const isLicenseValid = checkedLicense?.status == 'ok';

    return {
      runAsPortal: !!connections.portalConnections,
      singleDbConnection: connections.singleDbConnection,
      singleConnection: singleConnection,
      isUserLoggedIn,
      // hideAppEditor: !!process.env.HIDE_APP_EDITOR,
      allowShellConnection: platformInfo.allowShellConnection,
      allowShellScripting: platformInfo.allowShellScripting,
      isDocker: platformInfo.isDocker,
      isElectron: platformInfo.isElectron,
      isLicenseValid,
      checkedLicense,
      configurationError,
      logoutUrl: await authProvider.getLogoutUrl(),
      permissions,
      login,
      // ...additionalConfigProps,
      isBasicAuth: !!process.env.BASIC_AUTH,
      isAdminLoginForm: !!(
        process.env.STORAGE_DATABASE &&
        process.env.ADMIN_PASSWORD &&
        !process.env.BASIC_AUTH &&
        checkedLicense?.type == 'premium'
      ),
      storageDatabase: process.env.STORAGE_DATABASE,
      logsFilePath: getLogsFilePath(),
      connectionsFilePath: path.join(datadir(), 'connections.jsonl'),
      ...currentVersion,
    };
  },

  logout_meta: {
    method: 'get',
    raw: true,
  },
  logout(req, res) {
    res.status(401).send('Logged out<br><a href="../..">Back to DbGate</a>');
  },

  platformInfo_meta: true,
  async platformInfo() {
    return platformInfo;
  },

  getSettings_meta: true,
  async getSettings() {
    const res = await lock.acquire('settings', async () => {
      return await this.loadSettings();
    });
    return res;
  },

  fillMissingSettings(value) {
    const res = {
      ...value,
    };
    if (value['app.useNativeMenu'] !== true && value['app.useNativeMenu'] !== false) {
      // res['app.useNativeMenu'] = os.platform() == 'darwin' ? true : false;
      res['app.useNativeMenu'] = false;
    }
    for (const envVar in process.env) {
      if (envVar.startsWith('SETTINGS_')) {
        const key = envVar.substring('SETTINGS_'.length);
        if (!res[key]) {
          res[key] = process.env[envVar];
        }
      }
    }
    return res;
  },

  async loadSettings() {
    try {
      const settingsText = await fs.readFile(path.join(datadir(), 'settings.json'), { encoding: 'utf-8' });
      return {
        ...this.fillMissingSettings(JSON.parse(settingsText)),
        'other.licenseKey': platformInfo.isElectron ? await this.loadLicenseKey() : undefined,
      };
    } catch (err) {
      return this.fillMissingSettings({});
    }
  },

  async loadLicenseKey() {
    try {
      const licenseKey = await fs.readFile(path.join(datadir(), 'license.key'), { encoding: 'utf-8' });
      return licenseKey;
    } catch (err) {
      return null;
    }
  },

  saveLicenseKey_meta: true,
  async saveLicenseKey({ licenseKey }) {
    try {
      if (process.env.STORAGE_DATABASE) {
        await storageWriteConfig('license', { licenseKey });
      } else {
        await fs.writeFile(path.join(datadir(), 'license.key'), licenseKey);
      }
      socket.emitChanged(`config-changed`);
    } catch (err) {
      return null;
    }
  },

  updateSettings_meta: true,
  async updateSettings(values, req) {
    if (!hasPermission(`settings/change`, req)) return false;

    const res = await lock.acquire('settings', async () => {
      const currentValue = await this.loadSettings();
      try {
        const updated = {
          ...currentValue,
          ..._.omit(values, ['other.licenseKey']),
        };
        await fs.writeFile(path.join(datadir(), 'settings.json'), JSON.stringify(updated, undefined, 2));
        // this.settingsValue = updated;

        if (currentValue['other.licenseKey'] != values['other.licenseKey']) {
          await this.saveLicenseKey({ licenseKey: values['other.licenseKey'] });
          socket.emitChanged(`config-changed`);
        }

        socket.emitChanged(`settings-changed`);
        return updated;
      } catch (err) {
        return false;
      }
    });
    return res;
  },

  changelog_meta: true,
  async changelog() {
    const resp = await axios.default.get('https://raw.githubusercontent.com/dbgate/dbgate/master/CHANGELOG.md');
    return resp.data;
  },

  checkLicense_meta: true,
  async checkLicense({ licenseKey }) {
    const resp = await checkLicenseKey(licenseKey);
    return resp;
  },
};