dbgate-api/src/controllers/apps.js

Allows run DbGate data-manipulation scripts.

const fs = require('fs-extra');
const _ = require('lodash');
const path = require('path');
const { appdir } = require('../utility/directories');
const socket = require('../utility/socket');
const connections = require('./connections');

module.exports = {
  folders_meta: true,
  async folders() {
    const folders = await fs.readdir(appdir());
    return [
      ...folders.map(name => ({
        name,
      })),
    ];
  },

  createFolder_meta: true,
  async createFolder({ folder }) {
    const name = await this.getNewAppFolder({ name: folder });
    await fs.mkdir(path.join(appdir(), name));
    socket.emitChanged('app-folders-changed');
    this.emitChangedDbApp(folder);
    return name;
  },

  files_meta: true,
  async files({ folder }) {
    if (!folder) return [];
    const dir = path.join(appdir(), folder);
    if (!(await fs.exists(dir))) return [];
    const files = await fs.readdir(dir);

    function fileType(ext, type) {
      return files
        .filter(name => name.endsWith(ext))
        .map(name => ({
          name: name.slice(0, -ext.length),
          label: path.parse(name.slice(0, -ext.length)).base,
          type,
        }));
    }

    return [
      ...fileType('.command.sql', 'command.sql'),
      ...fileType('.query.sql', 'query.sql'),
      ...fileType('.config.json', 'config.json'),
    ];
  },

  async emitChangedDbApp(folder) {
    const used = await this.getUsedAppFolders();
    if (used.includes(folder)) {
      socket.emitChanged('used-apps-changed');
    }
  },

  refreshFiles_meta: true,
  async refreshFiles({ folder }) {
    socket.emitChanged('app-files-changed', { app: folder });
  },

  refreshFolders_meta: true,
  async refreshFolders() {
    socket.emitChanged(`app-folders-changed`);
  },

  deleteFile_meta: true,
  async deleteFile({ folder, file, fileType }) {
    await fs.unlink(path.join(appdir(), folder, `${file}.${fileType}`));
    socket.emitChanged('app-files-changed', { app: folder });
    this.emitChangedDbApp(folder);
  },

  renameFile_meta: true,
  async renameFile({ folder, file, newFile, fileType }) {
    await fs.rename(
      path.join(path.join(appdir(), folder), `${file}.${fileType}`),
      path.join(path.join(appdir(), folder), `${newFile}.${fileType}`)
    );
    socket.emitChanged('app-files-changed', { app: folder });
    this.emitChangedDbApp(folder);
  },

  renameFolder_meta: true,
  async renameFolder({ folder, newFolder }) {
    const uniqueName = await this.getNewAppFolder({ name: newFolder });
    await fs.rename(path.join(appdir(), folder), path.join(appdir(), uniqueName));
    socket.emitChanged(`app-folders-changed`);
  },

  deleteFolder_meta: true,
  async deleteFolder({ folder }) {
    if (!folder) throw new Error('Missing folder parameter');
    await fs.rmdir(path.join(appdir(), folder), { recursive: true });
    socket.emitChanged(`app-folders-changed`);
    socket.emitChanged('app-files-changed', { app: folder });
    socket.emitChanged('used-apps-changed');
  },

  async getNewAppFolder({ name }) {
    if (!(await fs.exists(path.join(appdir(), name)))) return name;
    let index = 2;
    while (await fs.exists(path.join(appdir(), `${name}${index}`))) {
      index += 1;
    }
    return `${name}${index}`;
  },

  getUsedAppFolders_meta: true,
  async getUsedAppFolders() {
    const list = await connections.list();
    const apps = [];

    for (const connection of list) {
      for (const db of connection.databases || []) {
        for (const key of _.keys(db || {})) {
          if (key.startsWith('useApp:') && db[key]) {
            apps.push(key.substring('useApp:'.length));
          }
        }
      }
    }

    return _.intersection(_.uniq(apps), await fs.readdir(appdir()));
  },

  getUsedApps_meta: true,
  async getUsedApps() {
    const apps = await this.getUsedAppFolders();
    const res = [];

    for (const folder of apps) {
      res.push(await this.loadApp({ folder }));
    }
    return res;
  },

  // getAppsForDb_meta: true,
  // async getAppsForDb({ conid, database }) {
  //   const connection = await connections.get({ conid });
  //   if (!connection) return [];
  //   const db = (connection.databases || []).find(x => x.name == database);
  //   const apps = [];
  //   const res = [];
  //   if (db) {
  //     for (const key of _.keys(db || {})) {
  //       if (key.startsWith('useApp:') && db[key]) {
  //         apps.push(key.substring('useApp:'.length));
  //       }
  //     }
  //   }
  //   for (const folder of apps) {
  //     res.push(await this.loadApp({ folder }));
  //   }
  //   return res;
  // },

  loadApp_meta: true,
  async loadApp({ folder }) {
    const res = {
      queries: [],
      commands: [],
      name: folder,
    };
    const dir = path.join(appdir(), folder);
    if (await fs.exists(dir)) {
      const files = await fs.readdir(dir);

      async function processType(ext, field) {
        for (const file of files) {
          if (file.endsWith(ext)) {
            res[field].push({
              name: file.slice(0, -ext.length),
              sql: await fs.readFile(path.join(dir, file), { encoding: 'utf-8' }),
            });
          }
        }
      }

      await processType('.command.sql', 'commands');
      await processType('.query.sql', 'queries');
    }

    try {
      res.virtualReferences = JSON.parse(
        await fs.readFile(path.join(dir, 'virtual-references.config.json'), { encoding: 'utf-8' })
      );
    } catch (err) {
      res.virtualReferences = [];
    }
    try {
      res.dictionaryDescriptions = JSON.parse(
        await fs.readFile(path.join(dir, 'dictionary-descriptions.config.json'), { encoding: 'utf-8' })
      );
    } catch (err) {
      res.dictionaryDescriptions = [];
    }

    return res;
  },

  async saveConfigFile(appFolder, filename, filterFunc, newItem) {
    const file = path.join(appdir(), appFolder, filename);

    let json;
    try {
      json = JSON.parse(await fs.readFile(file, { encoding: 'utf-8' }));
    } catch (err) {
      json = [];
    }

    if (filterFunc) {
      json = json.filter(filterFunc);
    }

    json = [...json, newItem];

    await fs.writeFile(file, JSON.stringify(json, undefined, 2));

    socket.emitChanged('app-files-changed', { app: appFolder });
    socket.emitChanged('used-apps-changed');
  },

  saveVirtualReference_meta: true,
  async saveVirtualReference({ appFolder, schemaName, pureName, refSchemaName, refTableName, columns }) {
    await this.saveConfigFile(
      appFolder,
      'virtual-references.config.json',
      columns.length == 1
        ? x =>
            !(
              x.schemaName == schemaName &&
              x.pureName == pureName &&
              x.columns.length == 1 &&
              x.columns[0].columnName == columns[0].columnName
            )
        : null,
      {
        schemaName,
        pureName,
        refSchemaName,
        refTableName,
        columns,
      }
    );
    return true;
  },

  saveDictionaryDescription_meta: true,
  async saveDictionaryDescription({ appFolder, pureName, schemaName, expression, columns, delimiter }) {
    await this.saveConfigFile(
      appFolder,
      'dictionary-descriptions.config.json',
      x => !(x.schemaName == schemaName && x.pureName == pureName),
      {
        schemaName,
        pureName,
        expression,
        columns,
        delimiter,
      }
    );

    return true;
  },

  createConfigFile_meta: true,
  async createConfigFile({ appFolder, fileName, content }) {
    const file = path.join(appdir(), appFolder, fileName);
    if (!(await fs.exists(file))) {
      await fs.writeFile(file, JSON.stringify(content, undefined, 2));
      socket.emitChanged('app-files-changed', { app: appFolder });
      socket.emitChanged('used-apps-changed');
      return true;
    }
    return false;
  },
};