4 * i3status – Generates a status line for dzen2 or xmobar
6 * Copyright © 2008-2012 Michael Stapelberg and contributors
7 * Copyright © 2009 Thorsten Toepper <atsutane at freethoughts dot de>
8 * Copyright © 2010 Axel Wagner <mail at merovius dot de>
9 * Copyright © 2010 Fernando Tarlá Cardoso Lemos <fernandotcl at gmail dot com>
11 * See file LICENSE for license information.
20 #include <sys/socket.h>
21 #include <netinet/in.h>
27 #include <sys/types.h>
32 #include <yajl/yajl_gen.h>
33 #include <yajl/yajl_version.h>
37 #define exit_if_null(pointer, ...) { if (pointer == NULL) die(__VA_ARGS__); }
39 #define CFG_CUSTOM_ALIGN_OPT \
40 CFG_STR_CB("align", NULL, CFGF_NONE, parse_align)
42 #define CFG_COLOR_OPTS(good, degraded, bad) \
43 CFG_STR("color_good", good, CFGF_NONE), \
44 CFG_STR("color_degraded", degraded, CFGF_NONE), \
45 CFG_STR("color_bad", bad, CFGF_NONE)
47 #define CFG_CUSTOM_COLOR_OPTS CFG_COLOR_OPTS(NULL, NULL, NULL)
49 #define CFG_CUSTOM_MIN_WIDTH_OPT \
50 CFG_PTR_CB("min_width", NULL, CFGF_NONE, parse_min_width, free)
52 /* socket file descriptor for general purposes */
55 static bool exit_upon_signal = false;
57 cfg_t *cfg, *cfg_general, *cfg_section;
60 * Set the exit_upon_signal flag, because one cannot do anything in a safe
61 * manner in a signal handler (e.g. fprintf, which we really want to do for
62 * debugging purposes), see
63 * https://www.securecoding.cert.org/confluence/display/seccode/SIG30-C.+Call+only+asynchronous-safe+functions+within+signal+handlers
66 void fatalsig(int signum) {
67 exit_upon_signal = true;
71 * Do nothing upon SIGUSR1. Running this signal handler will nevertheless
72 * interrupt nanosleep() so that i3status immediately generates new output.
75 void sigusr1(int signum) {
79 * Checks if the given path exists by calling stat().
82 static bool path_exists(const char *path) {
84 return (stat(path, &buf) == 0);
87 static void *scalloc(size_t size) {
88 void *result = calloc(size, 1);
89 exit_if_null(result, "Error: out of memory (calloc(%zd))\n", size);
93 static char *sstrdup(const char *str) {
94 char *result = strdup(str);
95 exit_if_null(result, "Error: out of memory (strdup())\n");
100 * Parses the "align" module option (to validate input).
102 static int parse_align(cfg_t *context, cfg_opt_t *option, const char *value, void *result) {
103 if (strcasecmp(value, "left") != 0 && strcasecmp(value,"right") != 0 && strcasecmp(value, "center") != 0)
104 die("Invalid alignment attribute found in section %s, line %d: \"%s\"\n"
105 "Valid attributes are: left, center, right\n", context->name, context->line, value);
107 const char **cresult = result;
114 * Parses the "min_width" module option whose value can either be a string or an integer.
116 static int parse_min_width(cfg_t *context, cfg_opt_t *option, const char *value, void *result) {
118 long num = strtol(value, &end, 10);
121 die("Invalid min_width attribute found in section %s, line %d: %d\n"
122 "Expected positive integer or string\n", context->name, context->line, num);
123 else if (num == LONG_MIN || num == LONG_MAX || (end && *end != '\0'))
126 if (strlen(value) == 0)
127 die("Empty min_width attribute found in section %s, line %d\n"
128 "Expected positive integer or non-empty string\n", context->name, context->line);
130 if (strcmp(value, "0") == 0)
131 die("Invalid min_width attribute found in section %s, line %d: \"%s\"\n"
132 "Expected positive integer or string\n", context->name, context->line, value);
134 struct min_width *parsed = scalloc(sizeof(struct min_width));
137 /* num is preferred, but if it’s 0 (i.e. not valid), store and use
138 * the raw string value */
140 parsed->str = sstrdup(value);
142 struct min_width **cresult = result;
149 * Validates a color in "#RRGGBB" format
152 static int valid_color(const char *value)
154 if (strlen(value) != 7) return 0;
155 if (value[0] != '#') return 0;
156 for (int i = 1; i < 7; ++i) {
157 if (value[i] >= '0' && value[i] <= '9') continue;
158 if (value[i] >= 'a' && value[i] <= 'f') continue;
159 if (value[i] >= 'A' && value[i] <= 'F') continue;
166 * This function resolves ~ in pathnames.
167 * It may resolve wildcards in the first part of the path, but if no match
168 * or multiple matches are found, it just returns a copy of path as given.
171 static char *resolve_tilde(const char *path) {
172 static glob_t globbuf;
173 char *head, *tail, *result = NULL;
175 tail = strchr(path, '/');
176 head = strndup(path, tail ? (size_t)(tail - path) : strlen(path));
178 int res = glob(head, GLOB_TILDE, NULL, &globbuf);
180 /* no match, or many wildcard matches are bad */
181 if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
182 result = sstrdup(path);
184 die("glob() failed");
186 head = globbuf.gl_pathv[0];
187 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
188 strncpy(result, head, strlen(head));
190 strncat(result, tail, strlen(tail));
197 static char *get_config_path(void) {
198 char *xdg_config_home, *xdg_config_dirs, *config_path;
200 /* 1: check the traditional path under the home directory */
201 config_path = resolve_tilde("~/.i3status.conf");
202 if (path_exists(config_path))
205 /* 2: check for $XDG_CONFIG_HOME/i3status/config */
206 if ((xdg_config_home = getenv("XDG_CONFIG_HOME")) == NULL)
207 xdg_config_home = "~/.config";
209 xdg_config_home = resolve_tilde(xdg_config_home);
210 if (asprintf(&config_path, "%s/i3status/config", xdg_config_home) == -1)
211 die("asprintf() failed");
212 free(xdg_config_home);
214 if (path_exists(config_path))
218 /* 3: check the traditional path under /etc */
219 config_path = SYSCONFDIR "/i3status.conf";
220 if (path_exists(config_path))
221 return sstrdup(config_path);
223 /* 4: check for $XDG_CONFIG_DIRS/i3status/config */
224 if ((xdg_config_dirs = getenv("XDG_CONFIG_DIRS")) == NULL)
225 xdg_config_dirs = "/etc/xdg";
227 char *buf = strdup(xdg_config_dirs);
228 char *tok = strtok(buf, ":");
229 while (tok != NULL) {
230 tok = resolve_tilde(tok);
231 if (asprintf(&config_path, "%s/i3status/config", tok) == -1)
232 die("asprintf() failed");
234 if (path_exists(config_path)) {
239 tok = strtok(NULL, ":");
243 die("Unable to find the configuration file (looked at "
244 "~/.i3status.conf, $XDG_CONFIG_HOME/i3status/config, "
245 "/etc/i3status.conf and $XDG_CONFIG_DIRS/i3status/config)");
250 * Returns the default separator to use if no custom separator has been specified.
252 static char *get_default_separator() {
253 if (output_format == O_DZEN2)
254 return "^p(5;-2)^ro(2)^p()^p(5)";
255 if (output_format == O_I3BAR)
256 // anything besides the empty string indicates that the default separator should be used
261 int main(int argc, char *argv[]) {
264 cfg_opt_t general_opts[] = {
265 CFG_STR("output_format", "auto", CFGF_NONE),
266 CFG_BOOL("colors", 1, CFGF_NONE),
267 CFG_STR("separator", "default", CFGF_NONE),
268 CFG_STR("color_separator", "#333333", CFGF_NONE),
269 CFG_INT("interval", 1, CFGF_NONE),
270 CFG_COLOR_OPTS("#00FF00", "#FFFF00", "#FF0000"),
274 cfg_opt_t run_watch_opts[] = {
275 CFG_STR("pidfile", NULL, CFGF_NONE),
276 CFG_STR("format", "%title: %status", CFGF_NONE),
277 CFG_CUSTOM_ALIGN_OPT,
278 CFG_CUSTOM_COLOR_OPTS,
279 CFG_CUSTOM_MIN_WIDTH_OPT,
283 cfg_opt_t path_exists_opts[] = {
284 CFG_STR("path", NULL, CFGF_NONE),
285 CFG_STR("format", "%title: %status", CFGF_NONE),
286 CFG_CUSTOM_ALIGN_OPT,
287 CFG_CUSTOM_COLOR_OPTS,
288 CFG_CUSTOM_MIN_WIDTH_OPT,
292 cfg_opt_t wireless_opts[] = {
293 CFG_STR("format_up", "W: (%quality at %essid, %bitrate) %ip", CFGF_NONE),
294 CFG_STR("format_down", "W: down", CFGF_NONE),
295 CFG_CUSTOM_ALIGN_OPT,
296 CFG_CUSTOM_COLOR_OPTS,
297 CFG_CUSTOM_MIN_WIDTH_OPT,
301 cfg_opt_t ethernet_opts[] = {
302 CFG_STR("format_up", "E: %ip (%speed)", CFGF_NONE),
303 CFG_STR("format_down", "E: down", CFGF_NONE),
304 CFG_CUSTOM_ALIGN_OPT,
305 CFG_CUSTOM_COLOR_OPTS,
306 CFG_CUSTOM_MIN_WIDTH_OPT,
310 cfg_opt_t ipv6_opts[] = {
311 CFG_STR("format_up", "%ip", CFGF_NONE),
312 CFG_STR("format_down", "no IPv6", CFGF_NONE),
313 CFG_CUSTOM_ALIGN_OPT,
314 CFG_CUSTOM_COLOR_OPTS,
315 CFG_CUSTOM_MIN_WIDTH_OPT,
319 cfg_opt_t battery_opts[] = {
320 CFG_STR("format", "%status %percentage %remaining", CFGF_NONE),
321 CFG_STR("format_down", "No battery", CFGF_NONE),
322 CFG_STR("path", "/sys/class/power_supply/BAT%d/uevent", CFGF_NONE),
323 CFG_INT("low_threshold", 30, CFGF_NONE),
324 CFG_STR("threshold_type", "time", CFGF_NONE),
325 CFG_BOOL("last_full_capacity", false, CFGF_NONE),
326 CFG_BOOL("integer_battery_capacity", false, CFGF_NONE),
327 CFG_BOOL("hide_seconds", false, CFGF_NONE),
328 CFG_CUSTOM_ALIGN_OPT,
329 CFG_CUSTOM_COLOR_OPTS,
330 CFG_CUSTOM_MIN_WIDTH_OPT,
334 cfg_opt_t time_opts[] = {
335 CFG_STR("format", "%Y-%m-%d %H:%M:%S", CFGF_NONE),
336 CFG_CUSTOM_ALIGN_OPT,
337 CFG_CUSTOM_MIN_WIDTH_OPT,
341 cfg_opt_t tztime_opts[] = {
342 CFG_STR("format", "%Y-%m-%d %H:%M:%S %Z", CFGF_NONE),
343 CFG_STR("timezone", "", CFGF_NONE),
344 CFG_CUSTOM_ALIGN_OPT,
345 CFG_CUSTOM_MIN_WIDTH_OPT,
349 cfg_opt_t ddate_opts[] = {
350 CFG_STR("format", "%{%a, %b %d%}, %Y%N - %H", CFGF_NONE),
351 CFG_CUSTOM_ALIGN_OPT,
352 CFG_CUSTOM_MIN_WIDTH_OPT,
356 cfg_opt_t load_opts[] = {
357 CFG_STR("format", "%1min %5min %15min", CFGF_NONE),
358 CFG_FLOAT("max_threshold", 5, CFGF_NONE),
359 CFG_CUSTOM_ALIGN_OPT,
360 CFG_CUSTOM_COLOR_OPTS,
361 CFG_CUSTOM_MIN_WIDTH_OPT,
365 cfg_opt_t usage_opts[] = {
366 CFG_STR("format", "%usage", CFGF_NONE),
367 CFG_CUSTOM_ALIGN_OPT,
368 CFG_CUSTOM_MIN_WIDTH_OPT,
372 cfg_opt_t temp_opts[] = {
373 CFG_STR("format", "%degrees C", CFGF_NONE),
374 CFG_STR("path", NULL, CFGF_NONE),
375 CFG_INT("max_threshold", 75, CFGF_NONE),
376 CFG_CUSTOM_ALIGN_OPT,
377 CFG_CUSTOM_COLOR_OPTS,
378 CFG_CUSTOM_MIN_WIDTH_OPT,
382 cfg_opt_t disk_opts[] = {
383 CFG_STR("format", "%free", CFGF_NONE),
384 CFG_STR("prefix_type", "binary", CFGF_NONE),
385 CFG_STR("threshold_type", "percentage_avail", CFGF_NONE),
386 CFG_FLOAT("low_threshold", 0, CFGF_NONE),
387 CFG_CUSTOM_ALIGN_OPT,
388 CFG_CUSTOM_COLOR_OPTS,
389 CFG_CUSTOM_MIN_WIDTH_OPT,
393 cfg_opt_t volume_opts[] = {
394 CFG_STR("format", "♪: %volume", CFGF_NONE),
395 CFG_STR("format_muted", "♪: 0%%", CFGF_NONE),
396 CFG_STR("device", "default", CFGF_NONE),
397 CFG_STR("mixer", "Master", CFGF_NONE),
398 CFG_INT("mixer_idx", 0, CFGF_NONE),
399 CFG_CUSTOM_ALIGN_OPT,
400 CFG_CUSTOM_COLOR_OPTS,
401 CFG_CUSTOM_MIN_WIDTH_OPT,
406 CFG_STR_LIST("order", "{}", CFGF_NONE),
407 CFG_SEC("general", general_opts, CFGF_NONE),
408 CFG_SEC("run_watch", run_watch_opts, CFGF_TITLE | CFGF_MULTI),
409 CFG_SEC("path_exists", path_exists_opts, CFGF_TITLE | CFGF_MULTI),
410 CFG_SEC("wireless", wireless_opts, CFGF_TITLE | CFGF_MULTI),
411 CFG_SEC("ethernet", ethernet_opts, CFGF_TITLE | CFGF_MULTI),
412 CFG_SEC("battery", battery_opts, CFGF_TITLE | CFGF_MULTI),
413 CFG_SEC("cpu_temperature", temp_opts, CFGF_TITLE | CFGF_MULTI),
414 CFG_SEC("disk", disk_opts, CFGF_TITLE | CFGF_MULTI),
415 CFG_SEC("volume", volume_opts, CFGF_TITLE | CFGF_MULTI),
416 CFG_SEC("ipv6", ipv6_opts, CFGF_NONE),
417 CFG_SEC("time", time_opts, CFGF_NONE),
418 CFG_SEC("tztime", tztime_opts, CFGF_TITLE | CFGF_MULTI),
419 CFG_SEC("ddate", ddate_opts, CFGF_NONE),
420 CFG_SEC("load", load_opts, CFGF_NONE),
421 CFG_SEC("cpu_usage", usage_opts, CFGF_NONE),
425 char *configfile = NULL;
426 int o, option_index = 0;
427 struct option long_options[] = {
428 {"config", required_argument, 0, 'c'},
429 {"help", no_argument, 0, 'h'},
430 {"version", no_argument, 0, 'v'},
434 struct sigaction action;
435 memset(&action, 0, sizeof(struct sigaction));
436 action.sa_handler = fatalsig;
438 /* Exit upon SIGPIPE because when we have nowhere to write to, gathering system
439 * information is pointless. Also exit explicitly on SIGTERM and SIGINT because
440 * only this will trigger a reset of the cursor in the terminal output-format.
442 sigaction(SIGPIPE, &action, NULL);
443 sigaction(SIGTERM, &action, NULL);
444 sigaction(SIGINT, &action, NULL);
446 memset(&action, 0, sizeof(struct sigaction));
447 action.sa_handler = sigusr1;
448 sigaction(SIGUSR1, &action, NULL);
450 if (setlocale(LC_ALL, "") == NULL)
451 die("Could not set locale. Please make sure all your LC_* / LANG settings are correct.");
453 while ((o = getopt_long(argc, argv, "c:hv", long_options, &option_index)) != -1)
456 else if ((char)o == 'h') {
457 printf("i3status " VERSION " © 2008-2012 Michael Stapelberg and contributors\n"
458 "Syntax: %s [-c <configfile>] [-h] [-v]\n", argv[0]);
460 } else if ((char)o == 'v') {
461 printf("i3status " VERSION " © 2008-2012 Michael Stapelberg and contributors\n");
466 if (configfile == NULL)
467 configfile = get_config_path();
469 cfg = cfg_init(opts, CFGF_NOCASE);
470 if (cfg_parse(cfg, configfile) == CFG_PARSE_ERROR)
473 if (cfg_size(cfg, "order") == 0)
474 die("Your 'order' array is empty. Please fix your config.\n");
476 cfg_general = cfg_getsec(cfg, "general");
477 if (cfg_general == NULL)
478 die("Could not get section \"general\"\n");
480 char *output_str = cfg_getstr(cfg_general, "output_format");
481 if (strcasecmp(output_str, "auto") == 0) {
482 fprintf(stderr, "i3status: trying to auto-detect output_format setting\n");
483 output_str = auto_detect_format();
486 fprintf(stderr, "i3status: falling back to \"none\"\n");
488 fprintf(stderr, "i3status: auto-detected \"%s\"\n", output_str);
492 if (strcasecmp(output_str, "dzen2") == 0)
493 output_format = O_DZEN2;
494 else if (strcasecmp(output_str, "xmobar") == 0)
495 output_format = O_XMOBAR;
496 else if (strcasecmp(output_str, "i3bar") == 0)
497 output_format = O_I3BAR;
498 else if (strcasecmp(output_str, "term") == 0)
499 output_format = O_TERM;
500 else if (strcasecmp(output_str, "none") == 0)
501 output_format = O_NONE;
502 else die("Unknown output format: \"%s\"\n", output_str);
504 const char *separator = cfg_getstr(cfg_general, "separator");
506 // if no custom separator has been provided, use the default one
507 if (strcasecmp(separator, "default") == 0)
508 separator = get_default_separator();
510 if (!valid_color(cfg_getstr(cfg_general, "color_good"))
511 || !valid_color(cfg_getstr(cfg_general, "color_degraded"))
512 || !valid_color(cfg_getstr(cfg_general, "color_bad"))
513 || !valid_color(cfg_getstr(cfg_general, "color_separator")))
514 die("Bad color format");
517 yajl_gen json_gen = yajl_gen_alloc(NULL);
519 yajl_gen json_gen = yajl_gen_alloc(NULL, NULL);
522 if (output_format == O_I3BAR) {
523 /* Initialize the i3bar protocol. See i3/docs/i3bar-protocol
525 printf("{\"version\":1}\n[\n");
527 yajl_gen_array_open(json_gen);
528 yajl_gen_clear(json_gen);
530 if (output_format == O_TERM) {
531 /* Save the cursor-position and hide the cursor */
532 printf("\033[s\033[?25l");
534 atexit(&reset_cursor);
537 if ((general_socket = socket(AF_INET, SOCK_DGRAM, 0)) == -1)
538 die("Could not create socket\n");
540 int interval = cfg_getint(cfg_general, "interval");
542 /* One memory page which each plugin can use to buffer output.
543 * Even though it’s unclean, we just assume that the user will not
544 * specify a format string which expands to something longer than 4096
545 * bytes — given that the output of i3status is used to display
546 * information on screen, more than 1024 characters for the full line
547 * (!), not individual plugins, seem very unlikely. */
551 if (exit_upon_signal) {
552 fprintf(stderr, "Exiting due to signal.\n");
556 gettimeofday(&tv, NULL);
557 if (output_format == O_I3BAR)
558 yajl_gen_array_open(json_gen);
559 else if (output_format == O_TERM)
560 /* Restore the cursor-position, clear line */
561 printf("\033[u\033[K");
562 for (j = 0; j < cfg_size(cfg, "order"); j++) {
564 print_separator(separator);
566 const char *current = cfg_getnstr(cfg, "order", j);
569 SEC_OPEN_MAP("ipv6");
570 print_ipv6_info(json_gen, buffer, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
574 CASE_SEC_TITLE("wireless") {
575 SEC_OPEN_MAP("wireless");
576 print_wireless_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
580 CASE_SEC_TITLE("ethernet") {
581 SEC_OPEN_MAP("ethernet");
582 print_eth_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
586 CASE_SEC_TITLE("battery") {
587 SEC_OPEN_MAP("battery");
588 print_battery_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"), cfg_getstr(sec, "format_down"), 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"));
592 CASE_SEC_TITLE("run_watch") {
593 SEC_OPEN_MAP("run_watch");
594 print_run_watch(json_gen, buffer, title, cfg_getstr(sec, "pidfile"), cfg_getstr(sec, "format"));
598 CASE_SEC_TITLE("path_exists") {
599 SEC_OPEN_MAP("path_exists");
600 print_path_exists(json_gen, buffer, title, cfg_getstr(sec, "path"), cfg_getstr(sec, "format"));
604 CASE_SEC_TITLE("disk") {
605 SEC_OPEN_MAP("disk_info");
606 print_disk_info(json_gen, buffer, title, cfg_getstr(sec, "format"), cfg_getstr(sec, "prefix_type"), cfg_getstr(sec, "threshold_type"), cfg_getfloat(sec, "low_threshold"));
611 SEC_OPEN_MAP("load");
612 print_load(json_gen, buffer, cfg_getstr(sec, "format"), cfg_getfloat(sec, "max_threshold"));
617 SEC_OPEN_MAP("time");
618 print_time(json_gen, buffer, cfg_getstr(sec, "format"), NULL, tv.tv_sec);
622 CASE_SEC_TITLE("tztime") {
623 SEC_OPEN_MAP("tztime");
624 print_time(json_gen, buffer, cfg_getstr(sec, "format"), cfg_getstr(sec, "timezone"), tv.tv_sec);
629 SEC_OPEN_MAP("ddate");
630 print_ddate(json_gen, buffer, cfg_getstr(sec, "format"), tv.tv_sec);
634 CASE_SEC_TITLE("volume") {
635 SEC_OPEN_MAP("volume");
636 print_volume(json_gen, buffer, cfg_getstr(sec, "format"),
637 cfg_getstr(sec, "format_muted"),
638 cfg_getstr(sec, "device"),
639 cfg_getstr(sec, "mixer"),
640 cfg_getint(sec, "mixer_idx"));
644 CASE_SEC_TITLE("cpu_temperature") {
645 SEC_OPEN_MAP("cpu_temperature");
646 print_cpu_temperature_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"), cfg_getint(sec, "max_threshold"));
650 CASE_SEC("cpu_usage") {
651 SEC_OPEN_MAP("cpu_usage");
652 print_cpu_usage(json_gen, buffer, cfg_getstr(sec, "format"));
656 if (output_format == O_I3BAR) {
657 yajl_gen_array_close(json_gen);
658 const unsigned char *buf;
664 yajl_gen_get_buf(json_gen, &buf, &len);
665 write(STDOUT_FILENO, buf, len);
666 yajl_gen_clear(json_gen);
672 /* To provide updates on every full second (as good as possible)
673 * we don’t use sleep(interval) but we sleep until the next
674 * second (with microsecond precision) plus (interval-1)
675 * seconds. We also align to 60 seconds modulo interval such
676 * that we start with :00 on every new minute. */
677 struct timeval current_timeval;
678 gettimeofday(¤t_timeval, NULL);
679 struct timespec ts = {interval - 1 - (current_timeval.tv_sec % interval), (10e5 - current_timeval.tv_usec) * 1000};
680 nanosleep(&ts, NULL);