X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=i3status.c;h=6491e1c6015371115de7382941fdd96d2820cd89;hb=562a879f7c40bb7586e2d4b8dc55cf3171e5d43d;hp=3c5e3ce06e2246316c5bd71dc0751669ed8937e6;hpb=47e2bc273d894402b00431e1ba6f1f927c3f2334;p=i3%2Fi3status diff --git a/i3status.c b/i3status.c index 3c5e3ce..6491e1c 100644 --- a/i3status.c +++ b/i3status.c @@ -11,6 +11,7 @@ * See file LICENSE for license information. * */ +#include #include #include #include @@ -35,19 +36,45 @@ #define exit_if_null(pointer, ...) { if (pointer == NULL) die(__VA_ARGS__); } +#define CFG_CUSTOM_ALIGN_OPT \ + CFG_STR_CB("align", NULL, CFGF_NONE, parse_align) + +#define CFG_COLOR_OPTS(good, degraded, bad) \ + CFG_STR("color_good", good, CFGF_NONE), \ + CFG_STR("color_degraded", degraded, CFGF_NONE), \ + CFG_STR("color_bad", bad, CFGF_NONE) + +#define CFG_CUSTOM_COLOR_OPTS CFG_COLOR_OPTS(NULL, NULL, NULL) + +#define CFG_CUSTOM_MIN_WIDTH_OPT \ + CFG_PTR_CB("min_width", NULL, CFGF_NONE, parse_min_width, free) + /* socket file descriptor for general purposes */ int general_socket; -cfg_t *cfg, *cfg_general; +static bool exit_upon_signal = false; + +cfg_t *cfg, *cfg_general, *cfg_section; + +void **cur_instance; + +/* + * Set the exit_upon_signal flag, because one cannot do anything in a safe + * manner in a signal handler (e.g. fprintf, which we really want to do for + * debugging purposes), see + * https://www.securecoding.cert.org/confluence/display/seccode/SIG30-C.+Call+only+asynchronous-safe+functions+within+signal+handlers + * + */ +void fatalsig(int signum) { + exit_upon_signal = true; +} /* - * Exit upon SIGPIPE because when we have nowhere to write to, gathering - * system information is pointless. + * Do nothing upon SIGUSR1. Running this signal handler will nevertheless + * interrupt nanosleep() so that i3status immediately generates new output. * */ -void sigpipe(int signum) { - fprintf(stderr, "Received SIGPIPE, exiting\n"); - exit(1); +void sigusr1(int signum) { } /* @@ -71,6 +98,54 @@ static char *sstrdup(const char *str) { return result; } +/* + * Parses the "align" module option (to validate input). + */ +static int parse_align(cfg_t *context, cfg_opt_t *option, const char *value, void *result) { + if (strcasecmp(value, "left") != 0 && strcasecmp(value,"right") != 0 && strcasecmp(value, "center") != 0) + die("Invalid alignment attribute found in section %s, line %d: \"%s\"\n" + "Valid attributes are: left, center, right\n", context->name, context->line, value); + + const char **cresult = result; + *cresult = value; + + return 0; +} + +/* + * Parses the "min_width" module option whose value can either be a string or an integer. + */ +static int parse_min_width(cfg_t *context, cfg_opt_t *option, const char *value, void *result) { + char *end; + long num = strtol(value, &end, 10); + + if (num < 0) + die("Invalid min_width attribute found in section %s, line %d: %d\n" + "Expected positive integer or string\n", context->name, context->line, num); + else if (num == LONG_MIN || num == LONG_MAX || (end && *end != '\0')) + num = 0; + + if (strlen(value) == 0) + die("Empty min_width attribute found in section %s, line %d\n" + "Expected positive integer or non-empty string\n", context->name, context->line); + + if (strcmp(value, "0") == 0) + die("Invalid min_width attribute found in section %s, line %d: \"%s\"\n" + "Expected positive integer or string\n", context->name, context->line, value); + + struct min_width *parsed = scalloc(sizeof(struct min_width)); + parsed->num = num; + + /* num is preferred, but if it’s 0 (i.e. not valid), store and use + * the raw string value */ + if (num == 0) + parsed->str = sstrdup(value); + + struct min_width **cresult = result; + *cresult = parsed; + + return 0; +} /* * Validates a color in "#RRGGBB" format @@ -121,7 +196,7 @@ static char *resolve_tilde(const char *path) { return result; } -static char *get_config_path() { +static char *get_config_path(void) { char *xdg_config_home, *xdg_config_dirs, *config_path; /* 1: check the traditional path under the home directory */ @@ -173,87 +248,163 @@ static char *get_config_path() { return NULL; } +/* + * Returns the default separator to use if no custom separator has been specified. + */ +static char *get_default_separator() { + if (output_format == O_DZEN2) + return "^p(5;-2)^ro(2)^p()^p(5)"; + if (output_format == O_I3BAR) + // anything besides the empty string indicates that the default separator should be used + return "default"; + return " | "; +} + int main(int argc, char *argv[]) { unsigned int j; cfg_opt_t general_opts[] = { CFG_STR("output_format", "auto", CFGF_NONE), CFG_BOOL("colors", 1, CFGF_NONE), - CFG_STR("color_good", "#00FF00", CFGF_NONE), - CFG_STR("color_degraded", "#FFFF00", CFGF_NONE), - CFG_STR("color_bad", "#FF0000", CFGF_NONE), + CFG_STR("separator", "default", CFGF_NONE), CFG_STR("color_separator", "#333333", CFGF_NONE), CFG_INT("interval", 1, CFGF_NONE), + CFG_COLOR_OPTS("#00FF00", "#FFFF00", "#FF0000"), CFG_END() }; cfg_opt_t run_watch_opts[] = { CFG_STR("pidfile", NULL, CFGF_NONE), CFG_STR("format", "%title: %status", CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_COLOR_OPTS, + CFG_CUSTOM_MIN_WIDTH_OPT, + CFG_END() + }; + + cfg_opt_t path_exists_opts[] = { + CFG_STR("path", NULL, CFGF_NONE), + CFG_STR("format", "%title: %status", CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_COLOR_OPTS, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t wireless_opts[] = { CFG_STR("format_up", "W: (%quality at %essid, %bitrate) %ip", CFGF_NONE), CFG_STR("format_down", "W: down", CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_COLOR_OPTS, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t ethernet_opts[] = { CFG_STR("format_up", "E: %ip (%speed)", CFGF_NONE), CFG_STR("format_down", "E: down", CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_COLOR_OPTS, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t ipv6_opts[] = { CFG_STR("format_up", "%ip", CFGF_NONE), CFG_STR("format_down", "no IPv6", CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_COLOR_OPTS, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t battery_opts[] = { CFG_STR("format", "%status %percentage %remaining", CFGF_NONE), + CFG_STR("format_down", "No battery", CFGF_NONE), + CFG_STR("status_chr", "CHR", CFGF_NONE), + CFG_STR("status_bat", "BAT", CFGF_NONE), + CFG_STR("status_full", "FULL", CFGF_NONE), CFG_STR("path", "/sys/class/power_supply/BAT%d/uevent", CFGF_NONE), + CFG_INT("low_threshold", 30, CFGF_NONE), + CFG_STR("threshold_type", "time", CFGF_NONE), CFG_BOOL("last_full_capacity", false, CFGF_NONE), + CFG_BOOL("integer_battery_capacity", false, CFGF_NONE), + CFG_BOOL("hide_seconds", false, CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_COLOR_OPTS, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t time_opts[] = { - CFG_STR("format", "%d.%m.%Y %H:%M:%S", CFGF_NONE), + CFG_STR("format", "%Y-%m-%d %H:%M:%S", CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_MIN_WIDTH_OPT, + CFG_END() + }; + + cfg_opt_t tztime_opts[] = { + CFG_STR("format", "%Y-%m-%d %H:%M:%S %Z", CFGF_NONE), + CFG_STR("timezone", "", CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t ddate_opts[] = { CFG_STR("format", "%{%a, %b %d%}, %Y%N - %H", CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t load_opts[] = { CFG_STR("format", "%1min %5min %15min", CFGF_NONE), + CFG_FLOAT("max_threshold", 5, CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_COLOR_OPTS, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t usage_opts[] = { CFG_STR("format", "%usage", CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t temp_opts[] = { CFG_STR("format", "%degrees C", CFGF_NONE), CFG_STR("path", NULL, CFGF_NONE), + CFG_INT("max_threshold", 75, CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_COLOR_OPTS, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t disk_opts[] = { CFG_STR("format", "%free", CFGF_NONE), + CFG_STR("format_not_mounted", NULL, CFGF_NONE), + CFG_STR("prefix_type", "binary", CFGF_NONE), + CFG_STR("threshold_type", "percentage_avail", CFGF_NONE), + CFG_FLOAT("low_threshold", 0, CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_COLOR_OPTS, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; cfg_opt_t volume_opts[] = { CFG_STR("format", "♪: %volume", CFGF_NONE), + CFG_STR("format_muted", "♪: 0%%", CFGF_NONE), CFG_STR("device", "default", CFGF_NONE), CFG_STR("mixer", "Master", CFGF_NONE), CFG_INT("mixer_idx", 0, CFGF_NONE), + CFG_CUSTOM_ALIGN_OPT, + CFG_CUSTOM_COLOR_OPTS, + CFG_CUSTOM_MIN_WIDTH_OPT, CFG_END() }; @@ -261,6 +412,7 @@ int main(int argc, char *argv[]) { CFG_STR_LIST("order", "{}", CFGF_NONE), CFG_SEC("general", general_opts, CFGF_NONE), CFG_SEC("run_watch", run_watch_opts, CFGF_TITLE | CFGF_MULTI), + CFG_SEC("path_exists", path_exists_opts, CFGF_TITLE | CFGF_MULTI), CFG_SEC("wireless", wireless_opts, CFGF_TITLE | CFGF_MULTI), CFG_SEC("ethernet", ethernet_opts, CFGF_TITLE | CFGF_MULTI), CFG_SEC("battery", battery_opts, CFGF_TITLE | CFGF_MULTI), @@ -269,6 +421,7 @@ int main(int argc, char *argv[]) { CFG_SEC("volume", volume_opts, CFGF_TITLE | CFGF_MULTI), CFG_SEC("ipv6", ipv6_opts, CFGF_NONE), CFG_SEC("time", time_opts, CFGF_NONE), + CFG_SEC("tztime", tztime_opts, CFGF_TITLE | CFGF_MULTI), CFG_SEC("ddate", ddate_opts, CFGF_NONE), CFG_SEC("load", load_opts, CFGF_NONE), CFG_SEC("cpu_usage", usage_opts, CFGF_NONE), @@ -286,8 +439,19 @@ int main(int argc, char *argv[]) { struct sigaction action; memset(&action, 0, sizeof(struct sigaction)); - action.sa_handler = sigpipe; + action.sa_handler = fatalsig; + + /* Exit upon SIGPIPE because when we have nowhere to write to, gathering system + * information is pointless. Also exit explicitly on SIGTERM and SIGINT because + * only this will trigger a reset of the cursor in the terminal output-format. + */ sigaction(SIGPIPE, &action, NULL); + sigaction(SIGTERM, &action, NULL); + sigaction(SIGINT, &action, NULL); + + memset(&action, 0, sizeof(struct sigaction)); + action.sa_handler = sigusr1; + sigaction(SIGUSR1, &action, NULL); if (setlocale(LC_ALL, "") == NULL) die("Could not set locale. Please make sure all your LC_* / LANG settings are correct."); @@ -337,10 +501,18 @@ int main(int argc, char *argv[]) { output_format = O_XMOBAR; else if (strcasecmp(output_str, "i3bar") == 0) output_format = O_I3BAR; + else if (strcasecmp(output_str, "term") == 0) + output_format = O_TERM; else if (strcasecmp(output_str, "none") == 0) output_format = O_NONE; else die("Unknown output format: \"%s\"\n", output_str); + const char *separator = cfg_getstr(cfg_general, "separator"); + + // if no custom separator has been provided, use the default one + if (strcasecmp(separator, "default") == 0) + separator = get_default_separator(); + if (!valid_color(cfg_getstr(cfg_general, "color_good")) || !valid_color(cfg_getstr(cfg_general, "color_degraded")) || !valid_color(cfg_getstr(cfg_general, "color_bad")) @@ -361,6 +533,12 @@ int main(int argc, char *argv[]) { yajl_gen_array_open(json_gen); yajl_gen_clear(json_gen); } + if (output_format == O_TERM) { + /* Save the cursor-position and hide the cursor */ + printf("\033[s\033[?25l"); + /* Undo at exit */ + atexit(&reset_cursor); + } if ((general_socket = socket(AF_INET, SOCK_DGRAM, 0)) == -1) die("Could not create socket\n"); @@ -375,21 +553,24 @@ int main(int argc, char *argv[]) { * (!), not individual plugins, seem very unlikely. */ char buffer[4096]; - struct tm tm; + void **per_instance = calloc(cfg_size(cfg, "order"), sizeof(*per_instance)); + while (1) { + if (exit_upon_signal) { + fprintf(stderr, "Exiting due to signal.\n"); + exit(1); + } struct timeval tv; gettimeofday(&tv, NULL); - time_t current_time = tv.tv_sec; - struct tm *current_tm = NULL; - if (current_time != (time_t) -1) { - localtime_r(¤t_time, &tm); - current_tm = &tm; - } if (output_format == O_I3BAR) yajl_gen_array_open(json_gen); + else if (output_format == O_TERM) + /* Restore the cursor-position, clear line */ + printf("\033[u\033[K"); for (j = 0; j < cfg_size(cfg, "order"); j++) { + cur_instance = per_instance + j; if (j > 0) - print_seperator(); + print_separator(separator); const char *current = cfg_getnstr(cfg, "order", j); @@ -401,19 +582,29 @@ int main(int argc, char *argv[]) { CASE_SEC_TITLE("wireless") { SEC_OPEN_MAP("wireless"); - print_wireless_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down")); + const char *interface = NULL; + if (strcasecmp(title, "_first_") == 0) + interface = first_eth_interface(NET_TYPE_WIRELESS); + if (interface == NULL) + interface = title; + print_wireless_info(json_gen, buffer, interface, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down")); SEC_CLOSE_MAP; } CASE_SEC_TITLE("ethernet") { SEC_OPEN_MAP("ethernet"); - print_eth_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down")); + const char *interface = NULL; + if (strcasecmp(title, "_first_") == 0) + interface = first_eth_interface(NET_TYPE_ETHERNET); + if (interface == NULL) + interface = title; + print_eth_info(json_gen, buffer, interface, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down")); SEC_CLOSE_MAP; } CASE_SEC_TITLE("battery") { SEC_OPEN_MAP("battery"); - print_battery_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"), cfg_getbool(sec, "last_full_capacity")); + print_battery_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"), cfg_getstr(sec, "format_down"), cfg_getstr(sec, "status_chr"), cfg_getstr(sec, "status_bat"), cfg_getstr(sec, "status_full"), cfg_getint(sec, "low_threshold"), cfg_getstr(sec, "threshold_type"), cfg_getbool(sec, "last_full_capacity"), cfg_getbool(sec, "integer_battery_capacity"), cfg_getbool(sec, "hide_seconds")); SEC_CLOSE_MAP; } @@ -423,33 +614,46 @@ int main(int argc, char *argv[]) { SEC_CLOSE_MAP; } + CASE_SEC_TITLE("path_exists") { + SEC_OPEN_MAP("path_exists"); + print_path_exists(json_gen, buffer, title, cfg_getstr(sec, "path"), cfg_getstr(sec, "format")); + SEC_CLOSE_MAP; + } + CASE_SEC_TITLE("disk") { SEC_OPEN_MAP("disk_info"); - print_disk_info(json_gen, buffer, title, cfg_getstr(sec, "format")); + print_disk_info(json_gen, buffer, title, cfg_getstr(sec, "format"), cfg_getstr(sec, "format_not_mounted"), cfg_getstr(sec, "prefix_type"), cfg_getstr(sec, "threshold_type"), cfg_getfloat(sec, "low_threshold")); SEC_CLOSE_MAP; } CASE_SEC("load") { SEC_OPEN_MAP("load"); - print_load(json_gen, buffer, cfg_getstr(sec, "format")); + print_load(json_gen, buffer, cfg_getstr(sec, "format"), cfg_getfloat(sec, "max_threshold")); SEC_CLOSE_MAP; } CASE_SEC("time") { SEC_OPEN_MAP("time"); - print_time(json_gen, buffer, cfg_getstr(sec, "format"), current_tm); + print_time(json_gen, buffer, cfg_getstr(sec, "format"), NULL, tv.tv_sec); + SEC_CLOSE_MAP; + } + + CASE_SEC_TITLE("tztime") { + SEC_OPEN_MAP("tztime"); + print_time(json_gen, buffer, cfg_getstr(sec, "format"), cfg_getstr(sec, "timezone"), tv.tv_sec); SEC_CLOSE_MAP; } CASE_SEC("ddate") { SEC_OPEN_MAP("ddate"); - print_ddate(json_gen, buffer, cfg_getstr(sec, "format"), current_tm); + print_ddate(json_gen, buffer, cfg_getstr(sec, "format"), tv.tv_sec); SEC_CLOSE_MAP; } CASE_SEC_TITLE("volume") { SEC_OPEN_MAP("volume"); print_volume(json_gen, buffer, cfg_getstr(sec, "format"), + cfg_getstr(sec, "format_muted"), cfg_getstr(sec, "device"), cfg_getstr(sec, "mixer"), cfg_getint(sec, "mixer_idx")); @@ -458,7 +662,7 @@ int main(int argc, char *argv[]) { CASE_SEC_TITLE("cpu_temperature") { SEC_OPEN_MAP("cpu_temperature"); - print_cpu_temperature_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format")); + print_cpu_temperature_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"), cfg_getint(sec, "max_threshold")); SEC_CLOSE_MAP; } @@ -487,10 +691,11 @@ int main(int argc, char *argv[]) { /* To provide updates on every full second (as good as possible) * we don’t use sleep(interval) but we sleep until the next * second (with microsecond precision) plus (interval-1) - * seconds. */ + * seconds. We also align to 60 seconds modulo interval such + * that we start with :00 on every new minute. */ struct timeval current_timeval; gettimeofday(¤t_timeval, NULL); - struct timespec ts = {interval - 1, (10e5 - current_timeval.tv_usec) * 1000}; + struct timespec ts = {interval - 1 - (current_timeval.tv_sec % interval), (10e5 - current_timeval.tv_usec) * 1000}; nanosleep(&ts, NULL); } }