lib/configs.c - master - niceSOFT/util-linux

lib/configs.c
403 строки9 KB
Karel Zak
lib/configs: simplify merge error checking
15 окт 2025, 16:18
15 окт 2025, 16:187609cb2
/*
 * configs_file.c instantiates functions defined and described in configs_file.h
 */
#include <err.h>
#include <errno.h>
#include <sys/syslog.h>
#include <sys/stat.h>
#include <stdarg.h>
#include <stdbool.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#if defined(HAVE_SCANDIRAT) && defined(HAVE_OPENAT)
#include <dirent.h>
#endif

#include "c.h"
#include "configs.h"
#include "strutils.h"
#include "list.h"
#include "fileutils.h"

struct file_element {
	struct list_head file_list;
	char *filename;
};

static __attribute__ ((__format__ (__printf__, 2, 0)))
	char *config_mk_path(int types, const char *fmt, ...)
{
	va_list ap;
	char *path = NULL;
	int rc;

	errno = 0;

	va_start(ap, fmt);
	rc = vasprintf(&path, fmt, ap);
	va_end(ap);

	if (rc > 0 && types) {
		struct stat st;

		if (stat(path, &st) != 0 ||
		    !((st.st_mode & S_IFMT) & types))
			goto fail;

	}

	return path;
fail:
	free(path);
	return NULL;
}

/* Checking for main configuration file
 *
 * Returning absolute path or NULL if not found The return value has to be
 * freed by the caller.
 */
static char *main_configs(const char *root,
			  const char *project,
			  const char *confname,
			  const char *suffix)
{
	char *path = NULL;

	if (suffix)
		path = config_mk_path(S_IFREG, "%s/%s/%s.%s",
				root, project, confname, suffix);
	if (!path)
		path = config_mk_path(S_IFREG, "%s/%s/%s",
				root, project, confname);
	return path;
}

static int configs_refer_filename(struct list_head *list, char *filename, int head)
{
	struct file_element *e;

	e = calloc(1, sizeof(*e));
	if (e == NULL)
		return -ENOMEM;

	INIT_LIST_HEAD(&e->file_list);
	e->filename = filename;
	if (head)
		list_add(&e->file_list, list);
	else
		list_add_tail(&e->file_list, list);
	return 0;
}

#if defined(HAVE_SCANDIRAT) && defined(HAVE_OPENAT)

static int filter(const struct dirent *d)
{
#ifdef _DIRENT_HAVE_D_TYPE
	if (d->d_type != DT_UNKNOWN && d->d_type != DT_REG &&
	    d->d_type != DT_LNK)
		return 0;
#endif
	if (is_dotdir_dirent(d))
		return 0;

	return 1;
}

static int read_dir(struct list_head *file_list,
		    const char *project,
		    const char *root,
		    const char *confname,
		    const char *suffix)
{
	char *dirname = NULL;
	char *filename = NULL;
	int dd = -1, nfiles = 0, i;
	int ret = 0;
	struct dirent **namelist = NULL;

	if (suffix)
		dirname = config_mk_path(S_IFDIR, "%s/%s/%s.%s.d",
				root, project, confname, suffix);
	if (!dirname)
		dirname = config_mk_path(S_IFDIR, "%s/%s/%s.d",
				root, project, confname);
	if (!dirname)
		return errno == ENOMEM ? -ENOMEM : 0;

	dd = open(dirname, O_RDONLY|O_CLOEXEC|O_DIRECTORY);
	if (dd < 0)
		goto finish;

	nfiles = scandirat(dd, ".", &namelist, filter, alphasort);
	if (nfiles <= 0)
		goto finish;

	for (i = 0; i < nfiles; i++) {
		struct dirent *d = namelist[i];

		if (suffix) {
			const char *p = ul_endswith(d->d_name, suffix);

			if (!p || p == d->d_name || *(p - 1) != '.')
				continue;
		}

		if (asprintf(&filename, "%s/%s", dirname, d->d_name) < 0) {
			ret = -ENOMEM;
			break;
		}

		ret = configs_refer_filename(file_list, filename, 0);
		if (ret < 0) {
			free(filename);
			break;
		}
	}

finish:
	for (i = 0; i < nfiles; i++)
		free(namelist[i]);
	free(namelist);
	free(dirname);
	if (dd >= 0)
		close(dd);
	return ret;
}

#endif /* HAVE_SCANDIRAT */

static int config_cmp(struct list_head *a, struct list_head *b,
		      void *data __attribute__((__unused__)))
{
	struct file_element *ea = list_entry(a, struct file_element, file_list);
	struct file_element *eb = list_entry(b, struct file_element, file_list);
	char *na = ul_basename(ea->filename);
	char *nb = ul_basename(eb->filename);

	return strcoll(na, nb);
}

static void free_list_entry(struct file_element *element)
{
	free(element->filename);
	free(element);
}

static int config_merge_list(struct list_head *main_list,
			      struct list_head *new_list)
{
	struct list_head *n, *m, *next;

	list_for_each_safe(n, next, new_list) {
		struct file_element *ne = list_entry(n, struct file_element, file_list);
		char *nn = ul_basename(ne->filename);
		int duplicate = 0;

		list_for_each(m, main_list) {
			struct file_element *me = list_entry(m, struct file_element, file_list);
			char *mn = ul_basename(me->filename);

			if (strcoll(mn, nn) == 0) {
				duplicate = 1;
				break;
			}
		}

		if (!duplicate) {
			list_del_init(n);
			list_add_tail(n, main_list);
		}
	}

	list_sort(main_list, config_cmp, NULL);
	return 0;
}

int ul_configs_file_list(struct list_head *file_list,
			 const char *project,
			 const char *etcdir,
			 const char *rundir,
			 const char *usrdir,
			 const char *confname,
			 const char *suffix)
{
	char *main_file = NULL;
	struct list_head etc_list;
	struct list_head run_list;
	struct list_head usr_list;
	int ret;

	INIT_LIST_HEAD(file_list);

	if (!confname)
		return -ENOTEMPTY;

	/* Default is /etc */
	if (!etcdir)
		etcdir = _PATH_SYSCONFDIR;
	if (!rundir)
		rundir = "";
	if (!usrdir)
		usrdir = "";

	if (!project)
		project = "";

	/* Find "main" config file (but don't add to list yet) */
	/* Search order: /etc /run /usr */
	main_file = main_configs(etcdir, project, confname, suffix);
	if (main_file == NULL)
		main_file = main_configs(rundir, project, confname, suffix);
	if (main_file == NULL)
		main_file = main_configs(usrdir, project, confname, suffix);

	INIT_LIST_HEAD(&etc_list);
	INIT_LIST_HEAD(&run_list);
	INIT_LIST_HEAD(&usr_list);

#if defined(HAVE_SCANDIRAT) && defined(HAVE_OPENAT)
	ret = read_dir(&etc_list, project, etcdir, confname, suffix);
	if (ret == -ENOMEM)
		goto finish;

	ret = read_dir(&run_list, project, rundir, confname, suffix);
	if (ret == -ENOMEM)
		goto finish;

	ret = read_dir(&usr_list, project, usrdir, confname, suffix);
	if (ret == -ENOMEM)
		goto finish;
#endif

	/* Merge drop-in directories in priority order (high to low) */
	if ((ret = config_merge_list(file_list, &etc_list)) < 0 ||
	    (ret = config_merge_list(file_list, &run_list)) < 0 ||
	    (ret = config_merge_list(file_list, &usr_list)) < 0)
		goto finish;

	/* Add main config file at the beginning (highest priority) */
	if (main_file != NULL) {
		ret = configs_refer_filename(file_list, main_file, 1);
		if (ret < 0) {
			free(main_file);
			goto finish;
		}
	}

finish:
	ul_configs_free_list(&etc_list);
	ul_configs_free_list(&run_list);
	ul_configs_free_list(&usr_list);

	return ret < 0 ? ret : (int) list_count_entries(file_list);
}

void ul_configs_free_list(struct list_head *file_list)
{
	list_free(file_list, struct file_element,  file_list, free_list_entry);
}

int ul_configs_next_filename(struct list_head *file_list,
			     struct list_head **current_entry,
			     char **name)
{
	struct file_element *element = NULL;

	if (list_empty(file_list) || *current_entry == file_list)
		return 1;

	if (*current_entry == NULL)
		*current_entry = file_list->next;

	element = list_entry(*current_entry, struct file_element, file_list);
	*name = element->filename;
	*current_entry = (*current_entry)->next;

	return 0;
}

#ifdef TEST_PROGRAM_CONFIGS
# include <getopt.h>

int main(int argc, char *argv[])
{
	struct list_head file_list;
	struct list_head *current = NULL;
	char *name = NULL;
	const char *etc_path = NULL;
	const char *run_path = NULL;
	const char *usr_path = NULL;
	const char *project = NULL;
	const char *config_name = NULL;
	const char *config_suffix = NULL;
	static const struct option longopts[] = {
		{ "etc", required_argument, NULL, 'e' },
		{ "run", required_argument, NULL, 'r' },
		{ "usr", required_argument, NULL, 'u' },
		{ "project", required_argument, NULL, 'p' },
		{ "name", required_argument, NULL, 'n' },
		{ "suffix", required_argument, NULL, 's' },
		{ "help", no_argument, NULL, 'h' },
		{ NULL, 0, NULL, 0 }
	};
	int ch, count;

	while ((ch = getopt_long(argc, argv, "e:r:u:p:n:s:h", longopts, NULL)) != -1) {
		switch (ch) {
		case 'e':
			etc_path = optarg;
			break;
		case 'r':
			run_path = optarg;
			break;
		case 'u':
			usr_path = optarg;
			break;
		case 'p':
			project = optarg;
			break;
		case 'n':
			config_name = optarg;
			break;
		case 's':
			config_suffix = optarg;
			break;
		case 'h':
			printf("usage: %s [options]\n"
				" -e, --etc <path>      path to /etc directory\n"
				" -r, --run <path>      path to /run directory\n"
				" -u, --usr <path>      path to /usr directory\n"
				" -p, --project <name>  project name subdirectory\n"
				" -n, --name <name>     config file base name\n"
				" -s, --suffix <suffix> config file suffix\n"
				" -h, --help            display this help\n",
				program_invocation_short_name);
			return EXIT_SUCCESS;
		default:
			return EXIT_FAILURE;
		}
	}

	if (!config_name) {
		fprintf(stderr, "config name is required (use --name)\n");
		return EXIT_FAILURE;
	}

	count = ul_configs_file_list(&file_list, project, etc_path, run_path, usr_path,
				     config_name, config_suffix);
	if (count < 0) {
		fprintf(stderr, "failed to get config file list: %d\n", count);
		return EXIT_FAILURE;
	}

	printf("Found %d configuration file(s):\n", count);
	while (ul_configs_next_filename(&file_list, &current, &name) == 0)
		printf("  %s\n", name);

	ul_configs_free_list(&file_list);
	return EXIT_SUCCESS;
}
#endif /* TEST_PROGRAM_CONFIGS */