main.js

#!/usr/bin/env node
const chalk = require('chalk');

const cli = require('./cli')
const s3api = require('./s3api');

const VERSION = '0.1.10606';

// read .env and .env.defaults
require('dotenv-defaults/config');

const logger = console; // for now
let args;
let bucket;

let Prefix = '';

let cmd0 = 's3sh';      // the name of this command
let commandLineOptions = {
  // Types
  '--access': String,   // --access  <string> or --access=<string>
  '--secret': String,   // --access  <string> or --access=<string>
  '--profile': String,  // --profile <string> or --profile=<string>
  '--region': String,   // --region  <string> or --region=<string>
  '--bucket': String,   // --bucket  <string> or --bucket=<string>

  '--quiet': Boolean,
  '--verbose': Boolean,
  '--version': Boolean,
  '--help': Boolean,

  // Aliases
  '-a': '--access',
  '-s': '--secret',
  '-b': '--bucket',
  '-r': '--region',
  '-p': '--profile',

  '-q': '--quiet',
  '-V': '--verbose',
  '-v': '--version',
  '-h': '--help',
  '-?': '--help'
};

cli.setCommandLineHelp('--access',  'specifies AWS IAM access key, e.g. AKIAIOSFODNN7EXAMPLE');
cli.setCommandLineHelp('--secret',  'specifies AWS IAM secret key, e.g. wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY');
cli.setCommandLineHelp('--profile', 'specifies AWS user credentials profile to use (from the ~/.aws folder)');
cli.setCommandLineHelp('--bucket',  'specifies AWS S3 bucket to use');
cli.setCommandLineHelp('--region',  'specifies AWS region to use, e.g. ca-central-1');
cli.setCommandLineHelp('--verbose', 'enables verbose mode, showing more output');
cli.setCommandLineHelp('--version', 'displays the version number of this utility');
cli.setCommandLineHelp('--help',    'shows this command-line syntax help');

function handleShutdown(rc) {
  process.exit(rc);
}

process.on('SIGTERM', () => {
  logger.info('Terminate (SIGTERM) signal received.');
  handleShutdown(0);
});
process.on('SIGINT', () => {
  logger.info('Interrupt (SIGINT) signal received.');
  handleShutdown(0);
});

function onError(err) {
  logger.error("Server error:", err.message);
  handleShutdown(1);  //mandatory return code (as per the Node.js docs)
}
process.on('uncaughtException', onError);

function onAccessKey(tokens) {
  if ((tokens.length !== 2) || (tokens[1]==='?') || (tokens[1]==='help')) {
    console.log('Syntax: access <accessKey>');
    return;
  }
  s3api.setAccessKey(tokens[1]);
  console.log("Access key set to:", tokens[1]);
}

function onSecretKey(tokens) {
  if ((tokens.length !== 2) || (tokens[1]==='?') || (tokens[1]==='help')) {
    console.log('Syntax: secret <secretKey>');
    return;
  }
  s3api.setSecretAccessKey(tokens[1]);
  console.log("Secret key set to:", tokens[1]);
}

function onBucket(tokens) {
  if ((tokens.length !== 2) || (tokens[1]==='?') || (tokens[1]==='help')) {
    console.log('Syntax: bucket <bucketName>');
    return;
  }
  s3api.setBucket(tokens[1]);
  console.log("Bucket ID set to:", tokens[1]);
}

function onRegion(tokens) {
  if ((tokens.length !== 2) || (tokens[1]==='?') || (tokens[1]==='help')) {
    console.log('Syntax: region <regionId>');
    return;
  }
  s3api.setRegion(tokens[1]);
  console.log("Region ID set to:", tokens[1]);
}

function onProfile(tokens) {
  if ((tokens.length !== 2) || (tokens[1]==='?') || (tokens[1]==='help')) {
    console.log('Syntax: region <regionId>');
    return;
  }
  s3api.setProfile(tokens[1]);
  console.log("Profile ID set to:", tokens[1]);
}

function onPWD(tokens) {
  Prefix = s3api.normalizePrefix(Prefix);

  console.log(`Context is now: /${Prefix || ''}`);
}

function onCD(tokens) {
  if (tokens.length < 2) {
    return onPWD(tokens);
  }

  let where = applyFolderToPath(Prefix, tokens[1]);
  Prefix = s3api.normalizePrefix(where);
  onPWD();
}

function isAbsolute(what) {
  if (!what) return false;
  return what.startsWith('/') || what.startsWith('~');
}

function applyFolderToPath(base, folder) {
  let where = base;
  if (folder) {
    if (isAbsolute(folder)) {
      where = folder;
    } else {
      where += folder;
    }
  }
  return where;
}

async function onList(tokens) {
  if ((tokens[1]==='?') || (tokens[1]==='help')) {
    console.log('Syntax: list [<what>]');
    return;
  }

  let where = (tokens.length >= 2) ? applyFolderToPath(Prefix, tokens[1]) : Prefix;
  let results = await s3api.docList(where);

  for (let item of results) {
    if (item.type === 'folder') {
      console.log(`  ${chalk.yellow(item.name)} [${chalk.magenta(item.type)}]`);
    } else {
      console.log(`  ${chalk.green(item.name)} ${chalk.magenta(item.size+' bytes')} [${chalk.grey(item.modified)}]`);
    }
  }
}

async function onGet(tokens) {
  if ((tokens.length !== 2) || (tokens[1]==='?') || (tokens[1]==='help')) {
    console.log('Syntax: read <what>');
    return;
  }
  let where = (tokens.length >= 2) ? applyFolderToPath(Prefix, tokens[1]) : Prefix;
  let doc = await s3api.docGet(where);
  if (doc) {
    // console.log(`${doc.path}:\n`+JSON.stringify(doc.data, null, 2));
    console.log(where+":\n"+JSON.stringify(doc, null, 2));
  }
}

async function onShow(tokens) {
  if ((tokens.length !== 2) || (tokens[1]==='?') || (tokens[1]==='help')) {
    console.log('Syntax: read <what>');
    return;
  }
  let where = (tokens.length >= 2) ? applyFolderToPath(Prefix, tokens[1]) : Prefix;
  let doc = await s3api.docGet(where);
  if (doc) {
    console.log(where+":\n"+doc);
  }
}

function onEnv(tokens) {
  let accessKey = process.env.AWS_ACCESS_KEY_ID;
  let secretAccessKey = process.env.AWS_SECRET_ACCESS_KEY
  console.log("AWS_ACCESS_KEY_ID:", accessKey ? accessKey.slice(0,4)+'...'+accessKey.slice(-2) : '(not set)');
  console.log("AWS_SECRET_ACCESS_KEY:", secretAccessKey ? secretAccessKey.slice(0,4)+'...'+secretAccessKey.slice(-2) : '(not set)');
  console.log("AWS_PROFILE:", process.env.AWS_PROFILE || '(not set)');
  console.log("AWS_REGION_ID:", process.env.AWS_REGION_ID || '(not set)');
  console.log("AWS_BUCKET:", process.env.AWS_BUCKET || '(not set)');
}

try {
  args = cli.initCommandLine(cmd0, commandLineOptions);
} catch (err) {
  console.error(err.message);
  handleShutdown(1);
}

// Mainline / top-level async function invocation.
(async () => {
  try {
    if (!args['--quiet']) {
      console.log(chalk.yellow("s3sh - S3 Shell ")+chalk.magenta(VERSION))
    }
    if (args['--help']) {
      cli.onCommandLineHelp();
      handleShutdown(0);
    }

    if (args['--access']) {
      s3api.setAccessKey(args['--access']);
    }
    if (args['--secret']) {
      s3api.setSecretAccessKey(args['--secret']);
    }
    if (args['--profile']) {
      s3api.setProfile(args['--profile']);
      if (!args['--verbose']) {
        console.log('Profile set to:', args['--profile']);
      }
    }
    if (args['--region']) {
      s3api.setRegion(args['--region']);
      if (!args['--verbose']) {
        console.log('Region set to:', args['--region']);
      }
    }
    if (args['--bucket']) {
      s3api.setBucket(args['--bucket']);
      if (!args['--verbose']) {
        console.log('Bucket set to:', args['--bucket']);
      }
    }
    
    await s3api.init();
    cli.init(process.stdin, process.stdout);
    cli.addCommand(onAccessKey, ['access']);
    cli.addCommand(onSecretKey, ['secret']);
    cli.addCommand(onProfile,   ['profile']);
    cli.addCommand(onRegion,    ['region']);
    cli.addCommand(onBucket,    ['bucket', 'proj', 'project']);
    cli.addCommand(onEnv,       ['env']);
    cli.addCommand(onPWD,       ['cwd', 'pwd']);
    cli.addCommand(onCD,        ['cd']);
    cli.addCommand(onList,      ['list', 'ls', 'dir']);
    cli.addCommand(onGet,       ['get', 'dump']);
    cli.addCommand(onShow,      ['read', 'type', 'cat', 'show', 'more']);
    await cli.run();
  } catch (e) {
    logger.error(e);
  }
})();