Source: cli/cli.js

  1. /*global process */
  2. /**
  3.  * @file Command line interface for JSforce
  4.  * @author Shinichi Tomita <shinichi.tomita@gmail.com>
  5.  */
  7. 'use strict';
  9. var http = require('http'),
  10.     url = require('url'),
  11.     openUrl = require('open'),
  12.     commander = require('commander'),
  13.     coprompt = require('co-prompt'),
  14.     Repl = require('./repl'),
  15.     jsforce = require('../jsforce'),
  16.     registry = jsforce.registry,
  17.     Promise = require('../promise'),
  18.     pkg = require('../../package.json');
  20. var repl;
  21. var conn = null;
  22. var connName = null;
  23. var outputEnabled = true;
  24. var defaultLoginUrl = null;
  26. /**
  27.  * @private
  28.  */
  29. function start() {
  30.   var program = new commander.Command();
  31.   program.option('-u, --username [username]', 'Salesforce username')
  32.          .option('-p, --password [password]', 'Salesforce password (and security token, if available)')
  33.          .option('-c, --connection [connection]', 'Connection name stored in connection registry')
  34.          .option('-e, --evalScript [evalScript]', 'Script to evaluate')
  35.          .option('-l, --loginUrl [loginUrl]', 'Salesforce login url')
  36.          .option('--sandbox', 'Login to Salesforce sandbox')
  37.          .option('--coffee', 'Using CoffeeScript')
  38.          .version(pkg.version)
  39.          .parse(process.argv);
  40.   var replModule = program.coffee ? require('coffee-script/lib/coffee-script/repl') : require('repl');
  41.   repl = new Repl(cli, replModule);
  42.   outputEnabled = !program.evalScript;
  43.   var options = { username: program.username, password: program.password };
  44.   var loginUrl = program.loginUrl ? program.loginUrl :
  45.                  program.sandbox ? 'sandbox' :
  46.                  null;
  47.   setLoginServer(loginUrl);
  48.   connect(program.connection, options, function(err, res) {
  49.     if (err) {
  50.       console.error(err.message);
  51.       process.exit();
  52.     } else {
  53.       if (program.evalScript) {
  54.         repl.start({
  55.           interactive: false,
  56.           evalScript: program.evalScript
  57.         });
  58.       } else {
  59.         repl.start();
  60.       }
  61.     }
  62.   });
  63. }
  65. /**
  66.  * @private
  67.  */
  68. function getCurrentConnection() {
  69.   return conn;
  70. }
  72. function print(message) {
  73.   if (outputEnabled) { console.log(message); }
  74. }
  76. /**
  77.  * @private
  78.  */
  79. function saveCurrentConnection() {
  80.   if (conn && connName) {
  81.     var connConfig = {
  82.       oauth2: conn.oauth2 && {
  83.         clientId: conn.oauth2.clientId,
  84.         clientSecret: conn.oauth2.clientSecret,
  85.         redirectUri: conn.oauth2.redirectUri,
  86.         loginUrl: conn.oauth2.loginUrl
  87.       },
  88.       accessToken: conn.accessToken,
  89.       instanceUrl: conn.instanceUrl,
  90.       refreshToken: conn.refreshToken
  91.     };
  92.     registry.saveConnectionConfig(connName, connConfig);
  93.   }
  94. }
  96. /**
  97.  * @private
  98.  */
  99. function setLoginServer(loginServer) {
  100.   if (!loginServer) { return; }
  101.   if (loginServer === 'production') {
  102.     defaultLoginUrl = 'https://login.salesforce.com';
  103.   } else if (loginServer === 'sandbox') {
  104.     defaultLoginUrl = 'https://test.salesforce.com';
  105.   } else if (loginServer.indexOf('https://') !== 0) {
  106.     defaultLoginUrl = 'https://' + loginServer;
  107.   } else {
  108.     defaultLoginUrl = loginServer;
  109.   }
  110.   print('Using "' + defaultLoginUrl + '" as default login URL.');
  111. }
  113. /**
  114.  * @private
  115.  */
  116. function connect(name, options, callback) {
  117.   connName = name;
  118.   options = options || {};
  119.   var connConfig = registry.getConnectionConfig(name);
  120.   var username, password;
  121.   if (!connConfig) {
  122.     connConfig = {};
  123.     if (defaultLoginUrl) {
  124.       connConfig.loginUrl = defaultLoginUrl;
  125.     }
  126.     username = name;
  127.   }
  128.   conn = new jsforce.Connection(connConfig);
  129.   username = username || options.username;
  130.   password = options.password;
  131.   var handleLogin = function(err) {
  132.     if (err) { return callback(err); }
  133.     saveCurrentConnection();
  134.     callback();
  135.   };
  136.   if (username) {
  137.     loginByPassword(username, password, 2, handleLogin);
  138.   } else {
  139.     if (connName && conn.accessToken) {
  140.       conn.on('refresh', function(accessToken) {
  141.         print('Refreshing access token ... ');
  142.         saveCurrentConnection();
  143.       });
  144.       conn.identity(function(err, identity) {
  145.         if (err) {
  146.           print(err.message);
  147.           if (conn.oauth2) {
  148.             callback(new Error('Please re-authorize connection.'));
  149.           } else {
  150.             loginByPassword(connName, null, 2, handleLogin);
  151.           }
  152.         } else {
  153.           print('Logged in as : ' + identity.username);
  154.           callback();
  155.         }
  156.       });
  157.     } else {
  158.       callback();
  159.     }
  160.   }
  161. }
  163. /**
  164.  * @private
  165.  */
  166. function loginByPassword(username, password, retry, callback) {
  167.   if (!password) {
  168.     promptPassword('Password: ', function(err, pass) {
  169.       if (err) { return callback(err); }
  170.       loginByPassword(username, pass, retry, callback);
  171.     });
  172.     return;
  173.   }
  174.   conn.login(username, password, function(err, result) {
  175.     if (err) {
  176.       console.error(err.message);
  177.       if (retry > 0) {
  178.         loginByPassword(username, null, --retry, callback);
  179.       } else {
  180.         callback(new Error());
  181.       }
  182.     } else {
  183.       print("Logged in as : " + username);
  184.       callback(null, result);
  185.     }
  186.   });
  187. }
  189. /**
  190.  * @private
  191.  */
  192. function disconnect(name) {
  193.   name = name || connName;
  194.   if (registry.getConnectionConfig(name)) {
  195.     registry.removeConnectionConfig(name);
  196.     print("Disconnect connection '" + name + "'");
  197.   }
  198.   connName = null;
  199.   conn = new jsforce.Connection();
  200. }
  202. /**
  203.  * @private
  204.  */
  205. function authorize(clientName, callback) {
  206.   clientName = clientName || 'default';
  207.   var oauth2Config = registry.getClient(clientName);
  208.   if (!oauth2Config || !oauth2Config.clientId || !oauth2Config.clientSecret) {
  209.     return callback(new Error("No OAuth2 client information registered : '"+clientName+"'. Please register client info first."));
  210.   }
  211.   var oauth2 = new jsforce.OAuth2(oauth2Config);
  212.   var state = Math.random().toString(36).substring(2);
  213.   var authzUrl = oauth2.getAuthorizationUrl({ state: state });
  214.   print('Opening authorization page in browser...');
  215.   print('URL: ' + authzUrl);
  216.   openUrl(authzUrl);
  217.   waitCallback(oauth2Config.redirectUri, state, function(err, params) {
  218.     if (err) { return callback(err); }
  219.     conn = new jsforce.Connection({ oauth2: oauth2 });
  220.     if (!params.code) {
  221.       return callback(new Error('No authorization code returned.'));
  222.     }
  223.     if (params.state !== state) {
  224.       return callback(new Error('Invalid state parameter returned.'));
  225.     }
  226.     print('Received authorization code. Please close the opened browser window.');
  227.     conn.authorize(params.code).then(function(res) {
  228.       print('Authorized. Fetching user info...');
  229.       return conn.identity();
  230.     }).then(function(identity) {
  231.       print('Logged in as : ' + identity.username);
  232.       connName = identity.username;
  233.       saveCurrentConnection();
  234.     }).thenCall(callback);
  235.   });
  236. }
  239. /**
  240.  * @private
  241.  */
  242. function waitCallback(serverUrl, state, callback) {
  243.   if (serverUrl.indexOf('http://localhost:') === 0) {
  244.     var server = http.createServer(function(req, res) {
  245.       var qparams = url.parse(req.url, true).query;
  246.       res.writeHead(200, {'Content-Type': 'text/html'});
  247.       res.write('<html><script>location.href="about:blank";</script></html>');
  248.       res.end();
  249.       callback(null, qparams);
  250.       server.close();
  251.       req.connection.end();
  252.       req.connection.destroy();
  253.     });
  254.     var port = url.parse(serverUrl).port;
  255.     server.listen(port, "localhost");
  256.   } else {
  257.     var msg = 'Copy & paste authz code passed in redirected URL: ';
  258.     promptMessage(msg, function(err, code) {
  259.       if (err) {
  260.         callback(err);
  261.       } else {
  262.         callback(null, { code: decodeURIComponent(code), state: state });
  263.       }
  264.     });
  265.   }
  266. }
  268. /**
  269.  * @private
  270.  */
  271. function register(clientName, clientConfig, callback) {
  272.   if (!clientName) {
  273.     clientName = "default";
  274.   }
  276.   var prompts = {
  277.     "clientId": "Input client ID (consumer key) : ",
  278.     "clientSecret": "Input client secret (consumer secret) : ",
  279.     "redirectUri": "Input redirect URI : ",
  280.     "loginUrl": "Input login URL (default is https://login.salesforce.com) : "
  281.   };
  282.   Promise.resolve().then(function() {
  283.     var deferred = Promise.defer();
  284.     if (registry.getClient(clientName)) {
  285.       var msg = "Client '"+clientName+"' is already registered. Are you sure you want to override ? [yN] : ";
  286.       promptConfirm(msg, function(err, ok) {
  287.         if (ok) {
  288.           deferred.resolve();
  289.         } else {
  290.           deferred.reject(new Error('Registration canceled.'));
  291.         }
  292.       });
  293.     } else {
  294.       deferred.resolve();
  295.     }
  296.     return deferred.promise;
  297.   })
  298.   .then(function() {
  299.     return Object.keys(prompts).reduce(function(promise, name) {
  300.       return promise.then(function() {
  301.         var message = prompts[name];
  302.         var deferred = Promise.defer();
  303.         if (!clientConfig[name]) {
  304.           promptMessage(message, function(err, value) {
  305.             if (err) { return deferred.reject(err); }
  306.             if (value) { clientConfig[name] = value; }
  307.             deferred.resolve();
  308.           });
  309.         } else {
  310.           deferred.resolve();
  311.         }
  312.         return deferred.promise;
  313.       });
  314.     }, Promise.resolve());
  315.   }).then(function() {
  316.     registry.registerClient(clientName, clientConfig);
  317.     print("Client registered successfully.");
  318.   }).thenCall(callback);
  319. }
  321. /**
  322.  * @private
  323.  */
  324. function listConnections() {
  325.   var names = registry.getConnectionNames();
  326.   for (var i=0; i<names.length; i++) {
  327.     var name = names[i];
  328.     print((name === connName ? '* ' : '  ') + name);
  329.   }
  330. }
  332. /**
  333.  * @private
  334.  */
  335. function getConnectionNames() {
  336.   return registry.getConnectionNames();
  337. }
  339. /**
  340.  * @private
  341.  */
  342. function getClientNames() {
  343.   return registry.getClientNames();
  344. }
  346. /**
  347.  * @private
  348.  */
  349. function promptMessage(message, callback) {
  350.   repl.pause();
  351.   coprompt(message)(function(err, res) {
  352.     repl.resume();
  353.     callback(err, res);
  354.   });
  355. }
  357. /**
  358.  * @private
  359.  */
  360. function promptPassword(message, callback) {
  361.   repl.pause();
  362.   coprompt.password(message)(function(err, res) {
  363.     repl.resume();
  364.     callback(err, res);
  365.   });
  366. }
  368. /**
  369.  * @private
  370.  */
  371. function promptConfirm(message, callback) {
  372.   repl.pause();
  373.   coprompt.confirm(message)(function(err, res) {
  374.     repl.resume();
  375.     callback(err, res);
  376.   });
  377. }
  379. /**
  380.  * @private
  381.  */
  382. function openUrlUsingSession(url) {
  383.   var frontdoorUrl = conn.instanceUrl + '/secur/frontdoor.jsp?sid=' + conn.accessToken;
  384.   if (url) {
  385.     frontdoorUrl += "&retURL=" + encodeURIComponent(url);
  386.   }
  387.   openUrl(frontdoorUrl);
  388. }
  390. /* ------------------------------------------------------------------------- */
  392. var cli = {
  393.   start: start,
  394.   getCurrentConnection: getCurrentConnection,
  395.   saveCurrentConnection: saveCurrentConnection,
  396.   listConnections: listConnections,
  397.   setLoginServer: setLoginServer,
  398.   getConnectionNames: getConnectionNames,
  399.   getClientNames: getClientNames,
  400.   connect: connect,
  401.   disconnect: disconnect,
  402.   authorize: authorize,
  403.   register: register,
  404.   openUrl: openUrlUsingSession
  405. };
  407. module.exports = cli;