HALF ECHO LEARN / REFERENCE COLLECTION

v262.2

src/core/show-status.c

4,644 bytesGit mode 100644Download original fileLGPL-2.1-or-later

Git blob: 0407675aaf3f34cd194b6d414f691cba37b6b6f2

Lines 1–141 of 141

/* SPDX-License-Identifier: LGPL-2.1-or-later */
 
#include <fcntl.h>
 
#include "alloc-util.h"
#include "fd-util.h"
#include "iovec-util.h"
#include "log.h"
#include "parse-util.h"
#include "show-status.h"
#include "string-table.h"
#include "string-util.h"
#include "terminal-util.h"
 
static const char* const show_status_table[_SHOW_STATUS_MAX] = {
        [SHOW_STATUS_NO]        = "no",
        [SHOW_STATUS_ERROR]     = "error",
        [SHOW_STATUS_AUTO]      = "auto",
        [SHOW_STATUS_TEMPORARY] = "temporary",
        [SHOW_STATUS_YES]       = "yes",
};
 
DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(show_status, ShowStatus, SHOW_STATUS_YES);
 
int parse_show_status(const char *s, ShowStatus *ret) {
        ShowStatus status;
 
        assert(ret);
 
        status = show_status_from_string(s);
        if (status < 0 || status == SHOW_STATUS_TEMPORARY)
                return -EINVAL;
 
        *ret = status;
        return 0;
}
 
int status_vprintf(const char *status, ShowStatusFlags flags, const char *format, va_list ap) {
        static const char status_indent[] = "         "; /* "[" STATUS "] " */
        static bool prev_ephemeral = false;
        static int dumb = -1;
 
        _cleanup_free_ char *s = NULL;
        _cleanup_close_ int fd = -EBADF;
        struct iovec iovec[7] = {};
        int n = 0;
 
        assert(format);
 
        if (dumb < 0)
                dumb = getenv_terminal_is_dumb();
 
        /* This is independent of logging, as status messages are
         * optional and go exclusively to the console. */
 
        if (vasprintf(&s, format, ap) < 0)
                return log_oom();
 
        /* Before you ask: yes, on purpose we open/close the console for each status line we write individually. This
         * is a good strategy to avoid PID 1 getting killed by the kernel's SAK concept (it doesn't fix this entirely,
         * but minimizes the time window the kernel might end up killing PID 1 due to SAK). It also makes things easier
         * for us so that we don't have to recover from hangups and suchlike triggered on the console. */
 
        fd = open_terminal("/dev/console", O_WRONLY|O_NOCTTY|O_CLOEXEC);
        if (fd < 0)
                return fd;
 
        if (FLAGS_SET(flags, SHOW_STATUS_ELLIPSIZE) && !dumb) {
                char *e;
                size_t emax, sl;
                int c;
 
                c = fd_columns(fd);
                if (c <= 0) {
                        const char *env = getenv("COLUMNS");
                        if (env)
                                (void) safe_atoi(env, &c);
 
                        if (c <= 0)
                                c = 80;
                }
 
                sl = status ? strlen(status_indent) : 0;
 
                emax = c - sl - 1;
                if (emax < 3)
                        emax = 3;
 
                e = ellipsize(s, emax, 50);
                if (e)
                        free_and_replace(s, e);
        }
 
        if (prev_ephemeral && !dumb)
                iovec[n++] = IOVEC_MAKE_STRING(ANSI_REVERSE_LINEFEED "\r" ANSI_ERASE_TO_END_OF_LINE);
 
        if (status) {
                if (!isempty(status)) {
                        iovec[n++] = IOVEC_MAKE_STRING("[");
                        iovec[n++] = IOVEC_MAKE_STRING(status);
                        iovec[n++] = IOVEC_MAKE_STRING("] ");
                } else
                        iovec[n++] = IOVEC_MAKE_STRING(status_indent);
        }
 
        iovec[n++] = IOVEC_MAKE_STRING(s);
        /* use CRNL instead of just NL, to be robust towards TTYs in raw mode. If we're writing to a dumb
         * terminal, use NL as CRNL might be interpreted as a double newline. */
        iovec[n++] = IOVEC_MAKE_STRING(dumb ? "\n" : "\r\n");
 
        if (prev_ephemeral && !FLAGS_SET(flags, SHOW_STATUS_EPHEMERAL) && !dumb)
                iovec[n++] = IOVEC_MAKE_STRING(ANSI_ERASE_TO_END_OF_LINE);
        prev_ephemeral = FLAGS_SET(flags, SHOW_STATUS_EPHEMERAL);
 
        if (writev(fd, iovec, n) < 0)
                return -errno;
 
        return 0;
}
 
int status_printf(const char *status, ShowStatusFlags flags, const char *format, ...) {
        va_list ap;
        int r;
 
        assert(format);
 
        va_start(ap, format);
        r = status_vprintf(status, flags, format, ap);
        va_end(ap);
 
        return r;
}
 
static const char* const status_unit_format_table[_STATUS_UNIT_FORMAT_MAX] = {
        [STATUS_UNIT_FORMAT_NAME]        = "name",
        [STATUS_UNIT_FORMAT_DESCRIPTION] = "description",
        [STATUS_UNIT_FORMAT_COMBINED]    = "combined",
};
 
DEFINE_STRING_TABLE_LOOKUP(status_unit_format, StatusUnitFormat);