gsender

/*
 * Copyright (C) 2021 Sienci Labs Inc.
 *
 * This file is part of gSender.
 *
 * gSender is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, under version 3 of the License.
 *
 * gSender is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with gSender.  If not, see <https://www.gnu.org/licenses/>.
 *
 * Contact for information regarding this program and its license
 * can be sent through gSender@sienci.com or mailed to the main office
 * of Sienci Labs Inc. in Waterloo, Ontario, Canada.
 *
 */

import castArray from "lodash/castArray";
import find from "lodash/find";
import isPlainObject from "lodash/isPlainObject";
import uuid from "uuid";
import settings from "../config/settings";
import {
	ERR_BAD_REQUEST,
	ERR_INTERNAL_SERVER_ERROR,
	ERR_NOT_FOUND,
} from "../constants";
import logger from "../lib/logger";
import config from "../services/configstore";
import taskRunner from "../services/taskrunner";
import { getPagingRange } from "./paging";

const log = logger("api:commands");
const CONFIG_KEY = "commands";

const getSanitizedRecords = () => {
	const records = castArray(config.get(CONFIG_KEY, []));

	let shouldUpdate = false;
	for (let i = 0; i < records.length; ++i) {
		if (!isPlainObject(records[i])) {
			records[i] = {};
		}

		const record = records[i];

		if (!record.id) {
			record.id = uuid.v4();
			shouldUpdate = true;
		}

		// Defaults to true
		if (record.enabled === undefined) {
			record.enabled = true;
		}

		// Alias command
		if (!record.commands) {
			record.commands = record.command || "";
			delete record.command;
		}
	}

	if (shouldUpdate) {
		log.debug(`update sanitized records: ${JSON.stringify(records)}`);

		// Pass `{ silent changes }` will suppress the change event
		config.set(CONFIG_KEY, records, { silent: true });
	}

	return records;
};

export const fetch = (req, res) => {
	const records = getSanitizedRecords();
	const paging = !!req.query.paging;

	if (paging) {
		const { page = 1, pageLength = 10 } = req.query;
		const totalRecords = records.length;
		const [begin, end] = getPagingRange({ page, pageLength, totalRecords });
		const pagedRecords = records.slice(begin, end);

		res.send({
			pagination: {
				page: Number(page),
				pageLength: Number(pageLength),
				totalRecords: Number(totalRecords),
			},
			records: pagedRecords.map((record) => {
				const { id, mtime, enabled, title, commands } = { ...record };
				return { id, mtime, enabled, title, commands };
			}),
		});
	} else {
		res.send({
			records: records.map((record) => {
				const { id, mtime, enabled, title, commands } = { ...record };
				return { id, mtime, enabled, title, commands };
			}),
		});
	}
};

export const create = (req, res) => {
	const { enabled = true, title = "", commands = "" } = { ...req.body };

	if (!title) {
		res.status(ERR_BAD_REQUEST).send({
			msg: 'The "title" parameter must not be empty',
		});
		return;
	}

	if (!commands) {
		res.status(ERR_BAD_REQUEST).send({
			msg: 'The "commands" parameter must not be empty',
		});
		return;
	}

	try {
		const records = getSanitizedRecords();
		const record = {
			id: uuid.v4(),
			mtime: new Date().getTime(),
			enabled: !!enabled,
			title: title,
			commands: commands,
		};

		records.push(record);
		config.set(CONFIG_KEY, records);

		res.send({ id: record.id, mtime: record.mtime });
	} catch (err) {
		res.status(ERR_INTERNAL_SERVER_ERROR).send({
			msg: "Failed to save " + JSON.stringify(settings.rcfile),
		});
	}
};

export const read = (req, res) => {
	const id = req.params.id;
	const records = getSanitizedRecords();
	const record = find(records, { id: id });

	if (!record) {
		res.status(ERR_NOT_FOUND).send({
			msg: "Not found",
		});
		return;
	}

	const { mtime, enabled, title, commands } = { ...record };
	res.send({ id, mtime, enabled, title, commands });
};

export const update = (req, res) => {
	const id = req.params.id;
	const records = getSanitizedRecords();
	const record = find(records, { id: id });

	if (!record) {
		res.status(ERR_NOT_FOUND).send({
			msg: "Not found",
		});
		return;
	}

	const {
		enabled = record.enabled,
		title = record.title,
		commands = record.commands,
	} = { ...req.body };

	// Skip validation for "enabled", "title", and "commands"

	try {
		record.mtime = new Date().getTime();
		record.enabled = Boolean(enabled);
		record.title = String(title || "");
		record.commands = String(commands || "");

		// Remove deprecated parameter
		if (record.command !== undefined) {
			delete record.command;
		}

		config.set(CONFIG_KEY, records);

		res.send({ id: record.id, mtime: record.mtime });
	} catch (err) {
		res.status(ERR_INTERNAL_SERVER_ERROR).send({
			msg: "Failed to save " + JSON.stringify(settings.rcfile),
		});
	}
};

export const __delete = (req, res) => {
	const id = req.params.id;
	const records = getSanitizedRecords();
	const record = find(records, { id: id });

	if (!record) {
		res.status(ERR_NOT_FOUND).send({
			msg: "Not found",
		});
		return;
	}

	try {
		const filteredRecords = records.filter((record) => {
			return record.id !== id;
		});
		config.set(CONFIG_KEY, filteredRecords);

		res.send({ id: record.id });
	} catch (err) {
		res.status(ERR_INTERNAL_SERVER_ERROR).send({
			msg: "Failed to save " + JSON.stringify(settings.rcfile),
		});
	}
};

export const run = (req, res) => {
	const id = req.params.id;
	const records = getSanitizedRecords();
	const record = find(records, { id: id });

	if (!record) {
		res.status(ERR_NOT_FOUND).send({
			msg: "Not found",
		});
		return;
	}

	const title = record.title;
	const commands = record.commands;

	log.info(`run: title="${title}", commands="${commands}"`);

	const taskId = taskRunner.run(commands, title);

	res.send({ taskId: taskId });
};