ipcamsd/src/cli.mjs

Command line tool and library for downloading, merging and converting record files of IP cameras

#!/usr/bin/env node

// Copyright (c) 2022, Thorsten A. Weintz. All rights reserved.
// Licensed under the MIT license. See LICENSE in the project root for license information.

import { readFileSync } from 'fs';
import path from 'path';
import { fileURLToPath } from 'url';
import axios from 'axios';
import { Command } from 'commander';
import Ipcamsd from './ipcamsd.mjs';
import { initStdout, logMessage } from './log.mjs';

/**
 * Initializes standard output (stdout).
 */
initStdout();

/**
 * Contains absolute path of the code file.
 */
const __filename = fileURLToPath(import.meta.url);

/**
 * Contains absolute path of the directory.
 */
const __dirname = path.dirname(__filename);

/**
 * Contains metadata values of destructed package.json.
 */
const { name, version } = JSON.parse(
    readFileSync(path.resolve(__dirname, '../package.json'), 'utf8')
);

/**
 * Contains @see Command instance of Commander.js.
 */
const program = new Command();

/**
 * Validates whether NPM package is outdated.
 */
const validateNpmVersion = async () => {
    try {
        const { status, data } =
            await axios.get(`https://registry.npmjs.org/${name}/latest`);

        if (status === 200) {
            const npmVersion = data.version;

            if (npmVersion && npmVersion > version) {
                const cmd = `npm i -g ipcamsd@${npmVersion}`

                logMessage(`Use '${cmd}' to install latest version`);
            }
        }
    } catch { }
};

/**
 * Concatenates value and previous array.
 * 
 * @param {*} value The value to concatenate.
 * @param {Array} previous Array with previous values to concatenate.
 * @returns Array with concatenated values.
 */
function collect(value, previous) {
    return previous.concat([value]);
}

/**
 * Concatenates boolean value and previous array.
 * 
 * @param {boolean} value The value to concatenate.
 * @param {Array} previous Array with previous values to concatenate.
 * @returns Array with concatenated values.
 */
function collectBoolean(value, previous) {
    return collect(value?.toLowerCase() === 'true', previous);
}

/**
 * Adds @see Command and related @see object with options to Commander.js.
 * 
 * @param {string} name The name of the command.
 * @param {boolean} isDefault Contains whether the command is default.
 * @param {function} cbAddOptions Function to attach options to instance.
 */
function addCommand(name, isDefault, cbAddOptions) {
    const cmd = program.command(name, { isDefault });

    if (cbAddOptions) {
        cbAddOptions(cmd);
    }

    cmd.action((options) => {
        const ipcamsd = new Ipcamsd();

        let opts = program.opts();
        let auth = {
            hosts: opts.host,
            usernames: opts.username,
            passwords: opts.password,
            ssls: opts.ssl
        };

        ipcamsd.process(name, opts.firmware, auth, options)
            .then(null, (err) => console.error(err || 'An error occurred'));
    });
}

/**
 * Sets the program version to @see Command instance.
 */
program
    .version(version, '-v, --version');

/**
 * Adds command and related options to fetch records to @see Command instance.
 */
addCommand('fetch', true, (command) => {
    command
        .option('--start-date <yyyymmdd|today|yesterday>', 'start date of records')
        .option('--end-date <yyyymmdd|today|yesterday>', 'end date of records')
        .option('--start-time <hhmmss>', 'start time of records')
        .option('--end-time <hhmmss>', 'end time of records')
        .option('--separate-by-date', 'separate by date', false)
        .option('--last-minutes <number>', 'last minutes of records till now (start time skipped)', parseInt)
        .option('--start-delay <number>', 'start delay in minutes', parseInt)
        .option('--target-directory <dir>', 'target directory for converted files')
        .option('--target-file-type <type>', 'target file type used by ffmpeg for conversion')
        .option('--filename-prefix <prefix>', 'output filename prefix')
        .option('--filename <filename...>', 'output filename (ignored on separations)', [])
        .option('--video-filter <filter>', 'video filter in ffmpeg required format', collect, []);
});

/**
 * Adds command to list records to @see Command instance.
 */
addCommand('list');

/**
 * Adds default options to @see Command instance.
 */
program
    .requiredOption('--host <host...>', 'host of ip camera')
    .option('--firmware <firmware...>', 'firmware of ip camera', ['hi3510'])
    .option('--username <username...>', 'username of ip camera', [])
    .option('--password <password...>', 'password of ip camera', [])
    .option('--ssl <ssl...>', 'use secure socket layer', collectBoolean, []);

/**
 * Validates whether NPM package is outdated.
 */
await validateNpmVersion();

/**
 * Instance of @see Command parses command-line arguments.
 */
program.parse(process.argv);