jsforce/lib/cli/registry.js

Salesforce API Library for JavaScript

/*global process */
/**
 * @file Registry for connection information, cached in local file system
 * @author Shinichi Tomita <shinichi.tomita@gmail.com>
 */
var fs = require('fs'),
    _  = require('underscore');

var homeDir = process.env[(process.platform === 'win32') ? 'USERPROFILE' : 'HOME'];
var configDir = homeDir + "/.jsforce";
var configFile = configDir + "/config.json";

/*  */
var registryConfig = {};
try {
  var data = fs.readFileSync(configFile, 'utf-8');
  registryConfig = JSON.parse(data);
} catch(e) {}

/**
 * @private
 */
function saveConfig() {
  var data = JSON.stringify(registryConfig, null, 4);
  try {
    fs.writeFileSync(configFile, data);
    fs.chmodSync(configFile, "600");
  } catch(e) {
    fs.mkdirSync(configDir);
    fs.chmodSync(configDir, "700");
    fs.writeFileSync(configFile, data);
    fs.chmodSync(configFile, "600");
  }
}

function getClients() {
  return registryConfig.clients || (registryConfig.clients = {});
}

function getConnections() {
  return registryConfig.connections || (registryConfig.connections = {});
}

function getConnectionNames() {
  return Object.keys(getConnections());
}

function getConnection(name) {
  if (!name) { name = registryConfig["default"]; }
  var connections = getConnections();
  var connConfig = connections[name];
  if (connConfig) { 
    connConfig = _.clone(connConfig);
    if (connConfig.client) {
      connConfig.oauth2 = _.clone(getClient(connConfig.client));
    }
    delete connConfig.client;
  }
  return connConfig;
}

function saveConnection(name, connConfig) {
  var connections = getConnections();
  connConfig = _.clone(connConfig);
  if (connConfig.oauth2) {
    var clientName = findClientName(connConfig.oauth2);
    if (clientName) {
      connConfig.client = clientName;
    }
    delete connConfig.oauth2;
  }
  connections[name] = connConfig;
  saveConfig();
}

function setDefaultConnection(name) {
  registryConfig["default"] = name;
  saveConfig();
}

function removeConnection(name) {
  var connections = getConnections();
  delete connections[name];
  saveConfig();
}

function findClientName(clientConfig) {
  var clients = getClients();
  for (var name in clients) {
    var client = clients[name];
    if (client.clientId === clientConfig.clientId &&
        (client.loginUrl || 'https://login.salesforce.com') === clientConfig.loginUrl) {
      return name;
    }
  }
  return null;
}

function getClient(name) {
  var clientConfig = getClients()[name];
  return clientConfig && _.clone(clientConfig);
}

function getClientNames() {
  return Object.keys(getClients());
}

function registerClient(name, clientConfig) {
  var clients = getClients();
  clients[name] = clientConfig;
  saveConfig();
}


/* ------------------------------------------------------------------------- */

module.exports = {
  getConnection: getConnection,
  getConnectionNames: getConnectionNames,
  saveConnection: saveConnection,
  removeConnection: removeConnection,
  setDefaultConnection: setDefaultConnection,
  getClient: getClient,
  getClientNames: getClientNames,
  registerClient: registerClient
};