finit/src/util.h

/* Misc. shared utility functions for initctl, reboot and finit
 *
 * Copyright (c) 2016-2025  Joachim Wiberg <troglobit@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef FINIT_UTIL_H_
#define FINIT_UTIL_H_

#include "config.h"

#include <ctype.h>
#ifdef HAVE_TERMIOS_H
#include <poll.h>
#include <stdio.h>
#include <sys/reboot.h>
#include <termios.h>
#endif

#ifndef RB_SW_SUSPEND /* Since Linux 2.5.18, but not in GLIBC until 2.19 */
#define RB_SW_SUSPEND	0xd000fce2
#endif

extern int   debug;			/* defined in finit or initctl */
extern int   ttrows;
extern int   ttcols;
extern char *prognm;

/* Define for printheader() from conio.h, used in initctl */
#ifndef SCREEN_WIDTH
#define SCREEN_WIDTH ttcols
#endif

#ifdef _LIBITE_LITE
# include <libite/conio.h>
# include <libite/lite.h>
#else
# include <lite/conio.h>
# include <lite/lite.h>
#endif
#include "log.h"

char *progname     (char *arg0);
const char *basenm (const char *path);

char *str          (char *fmt, ...)                        __attribute__ ((format (printf, 1, 2)));

int   getuser      (const char *username, char **home);
int   getgroup     (const char *group);

int   getcuser     (char *buf, size_t len);
int   getcgroup    (char *buf, size_t len);

int   dirperm      (const char *path, mode_t mode, uid_t uid, gid_t gid);
int   mksubsys     (const char *dir, mode_t mode, char *user, char *group);

int   fnread       (char *buf, size_t len, char *fmt, ...) __attribute__ ((format (printf, 3, 4)));
int   fnwrite      (char *value, char *fmt, ...)           __attribute__ ((format (printf, 2, 3)));
int   fngetint     (char *path, int *val);

int   suspend      (void);

int   strtobytes   (char *arg);
char *sig2str      (int sig);
int   str2sig      (char *sig);
char *code2str     (int code);

void  do_sleep     (unsigned int sec);
void  do_usleep    (unsigned int usec);
long  jiffies      (void);
char *uptime       (long secs, char *buf, size_t len);
char *memsz        (uint64_t sz, char *buf, size_t len);

char *sanitize     (char *arg, size_t len);
void  de_dotdot    (char *file);

int   ismnt        (char *file, char *dir, char *mode);
int   fismnt       (char *dir);
int   fistmpfs     (char *dir);

#ifdef HAVE_TERMIOS_H
int     ttinit     (int probe_size);
int     ttraw      (void);
int     ttcooked   (void);
#else
#define ttinit(v)  ttcols
#define ttraw()    0
#define ttcooked() 0
#endif

/*
 * Defaults to user "root" and group "wheel" (root) if:
 *   1) the user is missing
 *   2) the group or the file /etc/group is missing
 */
static inline int create(char *path, mode_t mode, char *user, char *group)
{
	int fd, uid, gid;

	if (!path) {
		errno = EINVAL;
		return -1;
	}

	uid = getuser(user, NULL);
	if (uid < 0)
		uid = 0;
	gid = getgroup(group);
	if (gid < 0)
		gid = 0;

	fd = creat(path, mode);
	if (fd == -1) {
		warn("Failed creating %s properly", path);
		return -1;
	}
	close(fd);
	if (chown(path, uid, gid)) {
		warn("Failed chowning %s properly", path);
		return -1;
	}

	return 0;
}

static inline int ln(const char *target, const char *linkpath)
{
	if (!target || !linkpath) {
		errno = EINVAL;
		return -1;
	}

	if (symlink(target, linkpath)) {
		if (errno != EEXIST)
			warn("Failed creating %s -> %s symlink", target, linkpath);
		return -1;
	}

	return 0;
}

static inline char *strterm(char *str, size_t len)
{
	str[len - 1] = 0;
	return str;
}

/* paste dir/file into buf */
static inline int paste(char *buf, size_t len, const char *dir, const char *file)
{
	if (!dir)
		dir = "";
	if (!file)
		file = "";

	return snprintf(buf, len, "%s%s%s", dir,
			fisslashdir(dir) ? "" : file[0] == '/' ? "" : "/", file);
}

/* ensure path has suffix */
static inline int suffix(char *path, size_t len, const char *sfx)
{
	size_t slen = strlen(sfx);
	size_t plen = strlen(path);

	if (plen < slen)
		slen = strlcat(path, sfx, len);
	else {
		plen -= slen;
		if (strcmp(&path[plen], sfx))
			slen = strlcat(path, sfx, len);
	}

	if (slen >= len)
		return -1;

	return 0;
}

static inline void hexdump(const char *buf, size_t len)
{
    size_t i, j;

    for (i = 0; i < len; i += 16) {
        printf("%08zx  ", i);

        for (j = 0; j < 8 && i + j < len; j++)
            printf("%02x ", buf[i + j]);

        if (j == 8) {
            printf(" ");
        } else {
            for (; j < 8; j++)
                printf("   ");
            printf(" ");
        }

        for (j = 8; j < 16 && i + j < len; j++)
            printf("%02x ", buf[i + j]);

        for (; j < 16; j++)
            printf("   ");

        printf(" |");
        for (j = 0; j < 16 && i + j < len; j++) {
            char c = buf[i + j];
            printf("%c", isprint(c) ? c : '.');
        }
        printf("|\n");
    }
}

/* drop quotes from a string at point, if any */
static inline int unquote(char **str, char *end)
{
	char *ptr = *str;

	/* unquote value, if quoted */
	if (ptr[0] == '"' || ptr[0] == '\'') {
		char q = ptr[0];

		if (!end && !(end = strchr(&ptr[1], q)))
			return -1;

		if (*end == q) {
			*str = &ptr[1];
			*end = 0;
		}
	}

	return 0;
}

#endif /* FINIT_UTIL_H_ */

/**
 * Local Variables:
 *  indent-tabs-mode: t
 *  c-file-style: "linux"
 * End:
 */