From b55234a74d17503ca2fecb273cfcc44549f9e43e Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 16 Mar 2025 14:45:03 +0100 Subject: Major refactoring and some fixes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- src/hooks.c | 214 +++++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 146 insertions(+), 68 deletions(-) (limited to 'src/hooks.c') diff --git a/src/hooks.c b/src/hooks.c index a19c60d..aaddd4f 100644 --- a/src/hooks.c +++ b/src/hooks.c @@ -1,5 +1,7 @@ -/* hooks.c -- Hooks triggered by events - * This file is part of redshift-ng. +/* redshift-ng - Automatically adjust display colour temperature according the Sun + * + * Copyright (c) 2009-2018 Jon Lund Steffensen + * Copyright (c) 2014-2016, 2025 Mattias Andrée * * redshift-ng is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -13,103 +15,179 @@ * * You should have received a copy of the GNU General Public License * along with redshift-ng. If not, see . - * - * Copyright (c) 2014 Jon Lund Steffensen */ #include "common.h" -#define MAX_HOOK_PATH 4096 - -/* Names of periods supplied to scripts. */ +/** + * Names of periods supplied to scripts + */ static const char *period_names[] = { - "none", - "daytime", - "night", - "transition" + [PERIOD_NONE] = "none", + [PERIOD_DAYTIME] = "daytime", + [PERIOD_NIGHT] = "night", + [PERIOD_TRANSITION] = "transition" }; -/* Try to open the directory containing hooks. HP is a string - of MAX_HOOK_PATH length that will be filled with the path - of the returned directory. */ -static DIR * -open_hooks_dir(char *hp) -{ - char *env; +/** + * Path name of the hook directory, `NULL` if not found + */ +static char *dirpath = NULL; -#ifndef WINDOWS - struct passwd *pwd; -#endif +/** + * The allocation size of `dirpath` + */ +static size_t dirpathsize; - env = getenv("XDG_CONFIG_HOME"); - if (env && *env) { - snprintf(hp, MAX_HOOK_PATH, "%s/redshift/hooks", env); - return opendir(hp); - } +/** + * The length of the string in `dirpath` + */ +static size_t dirpathlen; - env = getenv("HOME"); - if (env && *env) { - snprintf(hp, MAX_HOOK_PATH, "%s/.config/redshift/hooks", env); - return opendir(hp); - } -#ifndef WINDOWS - pwd = getpwuid(getuid()); /* TODO check failure */ - snprintf(hp, MAX_HOOK_PATH, "%s/.config/redshift/hooks", pwd->pw_dir); - return opendir(hp); -#else - return NULL; +/** + * Paths, in order of priority, to test when looking for + * the hooks directory for redshift + */ +static const struct env_path paths[] = { + {0, "XDG_CONFIG_HOME", "/redshift-ng/hooks"}, + {0, "XDG_CONFIG_HOME", "/redshift/hooks"}, +#ifdef WINDOWS + {0, "localappdata", "/redshift-ng/hooks"}, + {0, "localappdata", "/redshift/hooks"}, #endif + {0, "HOME", "/.config/redshift-ng/hooks"}, + {0, "HOME", "/.config/redshift/hooks"}, + {0, NULL, "/.config/redshift-ng/hooks"}, + {0, NULL, "/.config/redshift/hooks"}, + {1, "XDG_CONFIG_DIRS", "/redshift-ng/hooks"}, + {1, "XDG_CONFIG_DIRS", "/redshift/hooks"}, + {0, "", "/etc/redshift-ng/hooks"}, + {0, "", "/etc/redshift/hooks"} +}; + + +/** + * Deallocates `dirpath` + */ +static void +cleanup(void) +{ + free(dirpath); + dirpath = NULL; } -/* Run hooks with a signal that the period changed. */ -void -hooks_signal_period_change(enum period prev_period, enum period period) + +/** + * Search for and open the hook directory for reading + * + * @param path_out Output parameter for the hook directroy path + * @param pathbuf_out Output parameter for the memory allocation for `*path_out`; + * will be set to `NULL`; shall be free(3)d by the caller + * @return `DIR` object for the reading the directory; `NULL` if not found + */ +static DIR * +open_hooks_dir(const char **path_out, char **pathbuf_out) +{ + DIR *dir = NULL; + size_t i; + + *path_out = NULL; + *pathbuf_out = NULL; + + for (i = 0; !dir && i < ELEMSOF(paths); i++) + dir = try_path_opendir(&paths[i], path_out, pathbuf_out); + if (dir) + weprintf(_("Found hook directory `%s'."), *path_out); + else + weprintf(_("No hook directory found.")); + + return dir; +} + + +/** + * Run hooks + * + * @param argv `NULL` terminated list of command line arguments + * for the hooks; must contain an unused initial slot, + * which the function will use to provide the zeroth + * argument + */ +static void +run_hooks(const char *argv[]) { - char hooksdir_path[MAX_HOOK_PATH]; - DIR *hooks_dir; - struct dirent *ent; - char *hook_name; - char hook_path[MAX_HOOK_PATH]; - int r; - - hooks_dir = open_hooks_dir(hooksdir_path); - if (!hooks_dir) + static int looked_up_dir = 0; + + DIR *dir; + struct dirent *f; + size_t required; + const char *dirpath_static; + + if (!looked_up_dir) { + looked_up_dir = 1; + dir = open_hooks_dir(&dirpath_static, &dirpath); + if (!dir) + return; + if (!dirpath) + dirpath = estrdup(dirpath_static); + dirpathsize = dirpathlen = strlen(dirpath); + atexit(&cleanup); + } else if (dirpath) { + dir = opendir(dirpath); + if (!dir) { + weprintf("opendir %s:", dirpath); + cleanup(); + return; + } + } else { return; + } - while ((ent = readdir(hooks_dir))) { - /* Skip hidden and special files (., ..) */ - if (ent->d_name[0] == '\0' || ent->d_name[0] == '.') + while ((errno = 0, f = readdir(dir))) { + if (f->d_name[0] == '.' || !f->d_name[0] || strchr(f->d_name, '\0')[-1] == '~') continue; - hook_name = ent->d_name; - snprintf(hook_path, sizeof(hook_path), "%s/%s", hooksdir_path, hook_name); + required = dirpathlen + sizeof("/") + strlen(f->d_name); + if (required > dirpathsize) + dirpath = erealloc(dirpath, dirpathsize = required); -#ifndef WINDOWS - /* Fork and exec the hook. We close stdout - so the hook cannot interfere with the normal - output. */ +#ifdef WINDOWS + /* TODO [Windows] hooks are not support on Windows */ +#else switch (fork()) { case -1: weprintf("fork:"); break; - case 0: - close(STDOUT_FILENO); - - r = execl(hook_path, hook_name, - "period-changed", - period_names[prev_period], - period_names[period], NULL); - if (r < 0 && errno != EACCES) - weprintf("execl %s:", hook_path); - /* Only reached on error */ + case 0: + if (dup2(STDOUT_FILENO, STDERR_FILENO) != STDERR_FILENO) + _eprintf("dup2 :"); + stpcpy(stpcpy(&dirpath[dirpathlen], "/"), f->d_name); + argv[0] = dirpath; + execv(dirpath, (const void *)argv); + if (errno != EACCES) + weprintf("execv %s:", dirpath); _exit(1); + default: /* SIGCHLD is ignored */ break; } #endif } + + if (errno) + weprintf("readdir %s:", dirpath); + + closedir(dir); +} + + +void +run_period_change_hooks(enum period prev_period, enum period period) +{ + const char *argv[] = {NULL, "period-changed", period_names[prev_period], period_names[period], NULL}; + run_hooks(argv); } -- cgit v1.2.3-70-g09d2