tellki-node-windows/lib/binaries.js

Support for Tellki Agent Windows service.

var path = require('path'),
    bin = path.join(__dirname,'..','bin'),
    fs = require('fs'),
    exec = require('child_process').exec;

var params = function(options,callback) {
  callback = callback || function(){};
  options = options || {};
  if (typeof options === 'function'){
    callback = options;
    options = {};
  }
  if (typeof options !== 'object'){
    throw 'Invalid options parameter.';
  }
  return {options:options,callback:callback};
}

module.exports = {
  /**
   * @method elevate
   * @member nodewindows
   * Elevate is similar to `sudo` on Linux/Mac. It attempts to elevate the privileges of the
   * current user to a local administrator. Using this does not require a password, but it
   * does require that the current user have administrative privileges. Without these
   * privileges, the command will fail with a `access denied` error.
   *
   * On systems with UAC enabled, this may prompt the user for permission to proceed:
   *
   * ![UAC Prompt](http://upload.wikimedia.org/wikipedia/en/5/51/Windows_7_UAC.png)
   *
   * **Syntax**:
   *
   * `elevate(cmd[,options,callback])`
   *
   * @param {String} cmd
   * The command to execute with elevated privileges. This can be any string that would be typed at the command line.
   * @param {Object} [options]
   * Any options that will be passed to `require('child_process').exec(cmd,<OPTIONS>,callback)`.
   * @param {Function} callback
   * The callback function passed to `require('child_process').exec(cmd,options,<CALLBACK>)`.
   */
  elevate: function(cmd,options,callback) {
    var p = params(options,callback);
    exec('"'+path.join(bin,'elevate','elevate.cmd')+'" '+cmd,p.options,p.callback);
  },

  /**
   * @method sudo
   * @member nodewindows
   * Sudo acts similarly to `sudo` on Linux/Mac. Unlike _elevate_, it requires a password, but it
   * will not prompt the user for permission to proceed. Like _elevate_, this
   * _still requires administrative privileges_ for the user, otherwise the command will fail.
   * The primary difference between this and _elevate()_ is the prompt.
   *
   * **Syntax**:
   *
   * `sudo(cmd,password[,options,callback])`
   *
   * @param {String} cmd
   * The command to execute with elevated privileges. This can be any string that would be typed at the command line.
   * @param {String} password
   * The password of the user
   * @param {Object} [options]
   * Any options that will be passed to `require('child_process').exec(cmd,<OPTIONS>,callback)`.
   * @param {Function} [callback]
   * The callback function passed to `require('child_process').exec(cmd,options,<CALLBACK>)`.
   */
  sudo: function(cmd,password,options,callback){
    password = password || '';
    if (typeof password !== 'string'){
      callback = options;
      options = password;
      password = '';
    }
    var p = params(options,callback);
    exec(path.join(bin,'sudowin','sudo.exe')+' '+(password !== '' ? '-p '+password:'')+cmd,p.options,p.callback);
  },

  /**
   * @method addExeConfig
   * @member nodewindows
   * On some configurations, installing .NET 3 is impractical, so appending a .config to the bin directory will
   * make life easier for some deployments. Appends to sudowin.
   * **Syntax**:
   *
   * `addExeConfig('xmlconfig')`
   * @param {String} config
   * This will be appended to the .config file.
   */
   addExeConfig: function(config) {
     fs.writeFile(path.join(bin,'sudowin','sudo.exe') + '.config', config, function() { });
     fs.writeFile(path.join(bin,'winsw','x'+(require('os').arch().indexOf('64')>0 ? '64':'86'),'winsw.exe') + '.config', config, function() { });
   },
   /**
    * @method removeExeConfig
    * @member nodewindows
    * Deletes config file.
    * **Syntax**:
    *
    * `removeExeConfig()`
    */
   removeExeConfig: function() {
     if (fs.existsSync(path.join(bin,'sudowin','sudo.exe') + '.config')){
       fs.unlinkSync(path.join(bin,'sudowin','sudo.exe') + '.config');
     }
     if (fs.existsSync(path.join(bin,'winsw','x'+(require('os').arch().indexOf('64')>0 ? '64':'86'),'winsw.exe') + '.config')){
       fs.unlinkSync(path.join(bin,'winsw','x'+(require('os').arch().indexOf('64')>0 ? '64':'86'),'winsw.exe') + '.config');
     }
   }
}