fresh/packages/i3blocks-gaps/src/block.c

/*
 * block.c - update of a single status line block
 * Copyright (C) 2014  Vivien Didelot
 *
 * This program 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, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <errno.h>
#include <signal.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/wait.h>
#include <time.h>
#include <unistd.h>

#include "block.h"
#include "click.h"
#include "io.h"
#include "json.h"
#include "log.h"

static void
child_setenv(struct block *block, const char *name, const char *value)
{
	if (setenv(name, value, 1) == -1) {
		berrorx(block, "setenv(%s=%s)", name, value);
		_exit(EXIT_ERR_INTERNAL);
	}
}

static void
child_setup_env(struct block *block, struct click *click)
{
	child_setenv(block, "BLOCK_NAME", NAME(block));
	child_setenv(block, "BLOCK_INSTANCE", INSTANCE(block));
	child_setenv(block, "BLOCK_INTERVAL", INTERVAL(block));
	child_setenv(block, "BLOCK_BUTTON", click ? click->button : "");
	child_setenv(block, "BLOCK_X", click ? click->x : "");
	child_setenv(block, "BLOCK_Y", click ? click->y : "");
}

static void
child_reset_signals(struct block *block)
{
	sigset_t set;

	if (sigfillset(&set) == -1) {
		berrorx(block, "sigfillset");
		_exit(EXIT_ERR_INTERNAL);
	}

	/* It should be safe to assume that all signals are unblocked by default */
	if (sigprocmask(SIG_UNBLOCK, &set, NULL) == -1) {
		berrorx(block, "sigprocmask");
		_exit(EXIT_ERR_INTERNAL);
	}
}

static void
child_redirect_write(struct block *block, int pipe[2], int fd)
{
	if (close(pipe[0]) == -1) {
		berrorx(block, "close pipe read end");
		_exit(EXIT_ERR_INTERNAL);
	}

	/* Defensive check */
	if (pipe[1] == fd)
		return;

	if (dup2(pipe[1], fd) == -1) {
		berrorx(block, "dup pipe write end");
		_exit(EXIT_ERR_INTERNAL);
	}

	if (close(pipe[1]) == -1) {
		berrorx(block, "close pipe write end");
		_exit(EXIT_ERR_INTERNAL);
	}
}

static void
child_exec(struct block *block)
{
	static const char * const shell = "/bin/sh";

	execl(shell, shell, "-c", COMMAND(block), (char *) NULL);
	/* Unlikely to reach this point */
	berrorx(block, "exec(%s -c %s)", shell, COMMAND(block));
	_exit(EXIT_ERR_INTERNAL);
}

static void
block_dump_stderr(struct block *block)
{
	char buf[2048] = { 0 };

	/* Note read(2) returns 0 for end-of-pipe */
	if (read(block->err, buf, sizeof(buf) - 1) == -1) {
		berrorx(block, "read stderr");
		return;
	}

	if (*buf)
		bdebug(block, "stderr:\n{\n%s\n}", buf);
}

static void
linecpy(char **lines, char *dest, size_t size)
{
	char *newline = strchr(*lines, '\n');

	/* split if there's a newline */
	if (newline)
		*newline = '\0';

	strncpy(dest, *lines, size);
	*lines += strlen(dest);

	/* increment if next char is non-null */
	if (*(*lines + 1))
		*lines += 1;
}

static void
mark_as_failed(struct block *block, const char *reason)
{
	if (log_level < LOG_WARN)
		return;

	struct properties *props = &block->updated_props;

	memset(props, 0, sizeof(struct properties));
	strcpy(props->name, NAME(block));
	strcpy(props->instance, INSTANCE(block));
	snprintf(props->full_text, sizeof(props->full_text), "[%s] %s", NAME(block), reason);
	snprintf(props->short_text, sizeof(props->short_text), "[%s] ERROR", NAME(block));
	strcpy(props->color, "#FF0000");
	strcpy(props->urgent, "true");
}

static void
block_update_plain_text(struct block *block, char *buf)
{
	struct properties *props = &block->updated_props;
	char *lines = buf;

	linecpy(&lines, props->full_text, sizeof(props->full_text) - 1);
        if (block->interval == INTER_PERSIST)
                return;

	linecpy(&lines, props->short_text, sizeof(props->short_text) - 1);
	if (*lines)
		linecpy(&lines, props->color, sizeof(props->color) - 1);
}

static void
block_update_json(struct block *block, char *buf)
{
	struct properties *props = &block->updated_props;
	int start, length, size;

#define PARSE(_name, _size, _flags) \
	if ((_flags) & PROP_I3BAR) { \
		json_parse(buf, #_name, &start, &length); \
		if (start > 0) { \
			size = _size - 1 < length ? _size - 1 : length; \
			strncpy(props->_name, buf + start, size); \
			props->_name[size] = '\0'; \
		} \
	}

	PROPERTIES(PARSE);

#undef PARSE
}

void
block_update(struct block *block)
{
	struct properties *props = &block->updated_props;
	char buf[2048] = { 0 };
	int nr;

	/* Read a single line for persistent block, everything otherwise */
	if (block->interval == INTER_PERSIST) {
		nr = io_readline(block->out, buf, sizeof(buf));
		if (nr < 0) {
			berror(block, "failed to read a line");
			return mark_as_failed(block, "failed to read");
		} else if (nr == 0) {
			berror(block, "pipe closed");
			return mark_as_failed(block, "pipe closed");
		}
	} else {
		/* Note: read(2) returns 0 for end-of-pipe */
		if (read(block->out, buf, sizeof(buf) - 1) == -1) {
			berrorx(block, "read stdout");
			return mark_as_failed(block, strerror(errno));
		}
	}

	/* Reset the defaults and merge the output */
	memcpy(props, &block->default_props, sizeof(struct properties));

	if (block->format == FORMAT_JSON)
		block_update_json(block, buf);
	else
		block_update_plain_text(block, buf);

	if (*FULL_TEXT(block) && *LABEL(block)) {
		static const size_t size = sizeof(props->full_text);
		char concat[size];
		snprintf(concat, size, "%s %s", LABEL(block), FULL_TEXT(block));
		strcpy(props->full_text, concat);
	}

	bdebug(block, "updated successfully");
}

void
block_spawn(struct block *block, struct click *click)
{
	const unsigned long now = time(NULL);
	int out[2], err[2];

	if (!*COMMAND(block)) {
		bdebug(block, "no command, skipping");
		return;
	}

	if (block->pid > 0) {
		bdebug(block, "process already spawned");
		return;
	}

	if (pipe(out) == -1 || pipe(err) == -1) {
		berrorx(block, "pipe");
		return mark_as_failed(block, strerror(errno));
	}

	if (block->interval == INTER_PERSIST) {
		if (io_signal(out[0], SIGRTMIN))
			return mark_as_failed(block, "event I/O impossible");
	}

	block->pid = fork();
	if (block->pid == -1) {
		berrorx(block, "fork");
		return mark_as_failed(block, strerror(errno));
	}

	/* Child? */
	if (block->pid == 0) {
		/* Error messages are merged into the parent's stderr... */
		child_setup_env(block, click);
		child_reset_signals(block);
		child_redirect_write(block, out, STDOUT_FILENO);
		child_redirect_write(block, err, STDERR_FILENO);
		/* ... until here */
		child_exec(block);
	}

	/*
	 * Note: for non-persistent blocks, no need to set the pipe read end as
	 * non-blocking, since it is meant to be read once the child has exited
	 * (and thus the write end is closed and read is available).
	 */

	/* Parent */
	if (close(out[1]) == -1)
		berrorx(block, "close stdout");
	if (close(err[1]) == -1)
		berrorx(block, "close stderr");

	block->out = out[0];
	block->err = err[0];

	if (!click)
		block->timestamp = now;

	bdebug(block, "forked child %d at %ld", block->pid, now);
}

void
block_reap(struct block *block)
{
	int status, code;

	if (block->pid <= 0) {
		bdebug(block, "not spawned yet");
		return;
	}

	if (waitpid(block->pid, &status, 0) == -1) {
		berrorx(block, "waitpid(%d)", block->pid);
		mark_as_failed(block, strerror(errno));
		goto close;
	}

	code = WEXITSTATUS(status);
	bdebug(block, "process %d exited with %d", block->pid, code);

	/* Process successfully reaped, reset the block PID */
	block->pid = 0;

	block_dump_stderr(block);

	if (code != 0 && code != EXIT_URGENT) {
		char reason[32];

		if (code == EXIT_ERR_INTERNAL)
			sprintf(reason, "internal error");
		else
			sprintf(reason, "bad exit code %d", code);

		berror(block, "%s", reason);
		mark_as_failed(block, reason);
		goto close;
	}

	/* Do not update unless it was meant to terminate */
	if (block->interval == INTER_PERSIST)
		goto close;

	block_update(block);

	/* Exit code takes precedence over the output */
	if (code == EXIT_URGENT)
		strcpy(block->updated_props.urgent, "true");
close:
	if (close(block->out) == -1)
		berrorx(block, "close stdout");
	if (close(block->err) == -1)
		berrorx(block, "close stderr");

	/* Invalidate descriptors to avoid misdetection after reassignment */
	block->out = block->err = -1;
}

void block_setup(struct block *block)
{
	struct properties *defaults = &block->default_props;
	struct properties *updated = &block->updated_props;

	/* Convenient shortcuts */
	if (strcmp(defaults->interval, "once") == 0)
		block->interval = INTER_ONCE;
	else if (strcmp(defaults->interval, "repeat") == 0)
		block->interval = INTER_REPEAT;
	else if (strcmp(defaults->interval, "persist") == 0)
		block->interval = INTER_PERSIST;
	else
		block->interval = atoi(defaults->interval);

	if (strcmp(defaults->format, "json") == 0)
		block->format = FORMAT_JSON;
	else
		block->format = FORMAT_PLAIN;

	block->signal = atoi(defaults->signal);

	/* First update (for static blocks and loading labels) */
	memcpy(updated, defaults, sizeof(struct properties));

#define PLACEHOLDERS(_name, _size, _flags) "    %s: \"%s\"\n"
#define ARGS(_name, _size, _flags) #_name, updated->_name,

	debug("\n{\n" PROPERTIES(PLACEHOLDERS) "%s", PROPERTIES(ARGS) "}");

#undef ARGS
#undef PLACEHOLDERS
}