@webos-tools/cli/bin/ares-install.js

Command Line Interface for development webOS application and service

#!/usr/bin/env node

/*
 * Copyright (c) 2020-2024 LG Electronics Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

const async = require('async'),
    fs = require('fs'),
    nopt = require('nopt'),
    log = require('npmlog'),
    path = require('path'),
    installLib = require('./../lib/install'),
    commonTools = require('./../lib/base/common-tools'),
    convertJsonToList = require('./../lib/util/json').convertJsonToList,
    spinner = require('../lib/util/spinner');
    
const version = commonTools.version,
    cliControl = commonTools.cliControl,
    help = commonTools.help,
    setupDevice = commonTools.setupDevice,
    appdata = commonTools.appdata,
    errHndl = commonTools.errMsg;
    
const processName = path.basename(process.argv[1]).replace(/.js/, '');

process.on('uncaughtException', function(err) {
    spinner.stop();
    log.error('uncaughtException', err.toString());
    log.verbose('uncaughtException', err.stack);
    cliControl.end(-1);
});

if (process.argv.length === 2) {
    process.argv.splice(2, 0, '--help');
}

const knownOpts = {
    "device":   [String, null],
    "device-list":  Boolean,
    "list":     Boolean,
    "listfull": Boolean,
    "type":     [String, null],
    "install":  path,
    "remove":   String,
    "opkg": Boolean,
    "opkg-param":   [String, null],
    "version":  Boolean,
    "help":     Boolean,
    "hidden-help":      Boolean,
    "level":    ['silly', 'verbose', 'info', 'http', 'warn', 'error']
};

const shortHands = {
    "d": ["--device"],
    "i": ["--install"],
    "r": ["--remove"],
    "o": ["--opkg"],
    "op": ["--opkg-param"],
    "l": ["--list"],
    "F": ["--listfull"],
    "t": ["--type"],
    "D": ["--device-list"],
    "V": ["--version"],
    "h": ["--help"],
    "hh": ["--hidden-help"],
    "v": ["--level", "verbose"]
};
const argv = nopt(knownOpts, shortHands, process.argv, 2 /* drop 'node' & 'ares-*.js' */);

log.heading = processName;
log.level = argv.level || 'warn';
installLib.log.level = log.level;
log.verbose("argv", argv);

/**
 * For consistent of "$command -v", argv is used.
 * By nopt, argv is parsed and set key-value in argv object.
 * If -v or --level option is input with command, it is set key-value in argv.
 * After it is deleted, If remained key is only one in argv object
 * (If any other are remained, it's mean another options is input)
 * and there is no remaining after parsing the input command by nopt
 * (If any other are remained, it's mean another parameters ares input),
 * each command of webOS CLI print help message with log message.
 */
if (argv.level) {
    delete argv.level;
    if (argv.argv.remain.length === 0 && (Object.keys(argv)).length === 1) {
        argv.help = true;
    }
}

const options = {
        appId: 'com.ares.defaultName',
        device: argv.device,
        opkg: argv.opkg || false,
        opkg_param:  argv['opkg-param']
    };

let op;
if (argv.help || argv['hidden-help']) {
    showUsage(argv['hidden-help']);
    cliControl.end();
} else if (argv.list) {
    op = list;
} else if (argv.listfull) {
    op = listFull;
} else if (argv.install) {
    op = install;
} else if (argv.remove) {
    op = remove;
} else if (argv['device-list']) {
    op = deviceList;
} else if (argv.version) {
    version.showVersionAndExit();
} else {
    op = install;
}

if (op) {
    version.checkNodeVersion(function() {
        async.series([
            op.bind(this)
        ],finish);
    });
}

function showUsage(hiddenFlag) {
    if (hiddenFlag) {
        help.display(processName, appdata.getConfig(true).profile, hiddenFlag);
    } else {
        help.display(processName, appdata.getConfig(true).profile);
    }
}

function deviceList() {
    setupDevice.showDeviceList(finish);
}

function install() {
    const pkgPath = argv.install || argv.argv.remain[0];
    log.info("install()", "pkgPath:", pkgPath);
    if (!pkgPath) {
        return finish(errHndl.getErrMsg("EMPTY_VALUE", "PACKAGE_FILE"));
    } else {
        if (!fs.existsSync(path.normalize(pkgPath))) {
            return finish(errHndl.getErrMsg("NOT_EXIST_PATH", pkgPath));
        }
        installLib.install(options, pkgPath, finish, outputTxt);
    }
}

function list() {
    installLib.list(options, function(err, pkgs) {
        let strPkgs = "";
        if (Array.isArray(pkgs)) {
            pkgs.forEach(function(pkg) {
                if (argv.type) {
                    if (argv.type !== pkg.type) {
                        return;
                    }
                }
                strPkgs += pkg.id + '\n';
            });
        }
        finish(err, {msg: strPkgs.trim()});
    }, outputTxt);
}

function listFull() {
    installLib.list(options, function(err, pkgs) {
        let strPkgs = "";
        if (Array.isArray(pkgs)) {
            pkgs.forEach(function(pkg) {
                strPkgs += "id : "+ pkg.id + '\n';
                delete pkg.id;
                strPkgs += convertJsonToList(pkg, 0) + '\n';
            });
        }
        finish(err, {msg: strPkgs.trim()});
    }, outputTxt);
}

function remove() {
    const pkgId = (argv.remove === 'true') ? argv.argv.remain[0] : argv.remove;
    log.info("remove()", "pkgId:", pkgId);
    if (!pkgId) {
        return finish(errHndl.getErrMsg("EMPTY_VALUE", "APP_ID"));
    }
    installLib.remove(options, pkgId, finish, outputTxt);
}

function outputTxt(value) {
    log.info("outputTxt()", "value:", value);
    console.log(value);
}

function finish(err, value) {
    spinner.stop();

    log.info("finish()");
    if (err) {
        // handle err from getErrMsg()
        if (Array.isArray(err) && err.length > 0) {
            for (const index in err) {
                log.error(err[index].heading, err[index].message);
            }
            log.verbose(err[0].stack);
        } else {
            // handle general err (string & object)
            log.error(err.toString());
            log.verbose(err.stack);
        }
        cliControl.end(-1);
    } else {
        log.verbose("finish()", "value:", value);
        if (value && value.msg) {
            console.log(value.msg);
        }
        cliControl.end();
    }
}