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.
19 #include <sys/socket.h>
20 #include <netinet/in.h>
26 #include <sys/types.h>
31 #include <yajl/yajl_gen.h>
32 #include <yajl/yajl_version.h>
36 #define exit_if_null(pointer, ...) { if (pointer == NULL) die(__VA_ARGS__); }
38 #define CFG_COLOR_OPTS(good, degraded, bad) \
39 CFG_STR("color_good", good, CFGF_NONE), \
40 CFG_STR("color_degraded", degraded, CFGF_NONE), \
41 CFG_STR("color_bad", bad, CFGF_NONE)
43 #define CFG_CUSTOM_COLOR_OPTS CFG_COLOR_OPTS(NULL, NULL, NULL)
45 /* socket file descriptor for general purposes */
48 static bool exit_upon_signal = false;
50 cfg_t *cfg, *cfg_general, *cfg_section;
53 * Set the exit_upon_signal flag, because one cannot do anything in a safe
54 * manner in a signal handler (e.g. fprintf, which we really want to do for
55 * debugging purposes), see
56 * https://www.securecoding.cert.org/confluence/display/seccode/SIG30-C.+Call+only+asynchronous-safe+functions+within+signal+handlers
59 void fatalsig(int signum) {
60 exit_upon_signal = true;
64 * Do nothing upon SIGUSR1. Running this signal handler will nevertheless
65 * interrupt nanosleep() so that i3status immediately generates new output.
68 void sigusr1(int signum) {
72 * Checks if the given path exists by calling stat().
75 static bool path_exists(const char *path) {
77 return (stat(path, &buf) == 0);
80 static void *scalloc(size_t size) {
81 void *result = calloc(size, 1);
82 exit_if_null(result, "Error: out of memory (calloc(%zd))\n", size);
86 static char *sstrdup(const char *str) {
87 char *result = strdup(str);
88 exit_if_null(result, "Error: out of memory (strdup())\n");
94 * Validates a color in "#RRGGBB" format
97 static int valid_color(const char *value)
99 if (strlen(value) != 7) return 0;
100 if (value[0] != '#') return 0;
101 for (int i = 1; i < 7; ++i) {
102 if (value[i] >= '0' && value[i] <= '9') continue;
103 if (value[i] >= 'a' && value[i] <= 'f') continue;
104 if (value[i] >= 'A' && value[i] <= 'F') continue;
111 * This function resolves ~ in pathnames.
112 * It may resolve wildcards in the first part of the path, but if no match
113 * or multiple matches are found, it just returns a copy of path as given.
116 static char *resolve_tilde(const char *path) {
117 static glob_t globbuf;
118 char *head, *tail, *result = NULL;
120 tail = strchr(path, '/');
121 head = strndup(path, tail ? (size_t)(tail - path) : strlen(path));
123 int res = glob(head, GLOB_TILDE, NULL, &globbuf);
125 /* no match, or many wildcard matches are bad */
126 if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
127 result = sstrdup(path);
129 die("glob() failed");
131 head = globbuf.gl_pathv[0];
132 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
133 strncpy(result, head, strlen(head));
135 strncat(result, tail, strlen(tail));
142 static char *get_config_path(void) {
143 char *xdg_config_home, *xdg_config_dirs, *config_path;
145 /* 1: check the traditional path under the home directory */
146 config_path = resolve_tilde("~/.i3status.conf");
147 if (path_exists(config_path))
150 /* 2: check for $XDG_CONFIG_HOME/i3status/config */
151 if ((xdg_config_home = getenv("XDG_CONFIG_HOME")) == NULL)
152 xdg_config_home = "~/.config";
154 xdg_config_home = resolve_tilde(xdg_config_home);
155 if (asprintf(&config_path, "%s/i3status/config", xdg_config_home) == -1)
156 die("asprintf() failed");
157 free(xdg_config_home);
159 if (path_exists(config_path))
163 /* 3: check the traditional path under /etc */
164 config_path = SYSCONFDIR "/i3status.conf";
165 if (path_exists(config_path))
166 return sstrdup(config_path);
168 /* 4: check for $XDG_CONFIG_DIRS/i3status/config */
169 if ((xdg_config_dirs = getenv("XDG_CONFIG_DIRS")) == NULL)
170 xdg_config_dirs = "/etc/xdg";
172 char *buf = strdup(xdg_config_dirs);
173 char *tok = strtok(buf, ":");
174 while (tok != NULL) {
175 tok = resolve_tilde(tok);
176 if (asprintf(&config_path, "%s/i3status/config", tok) == -1)
177 die("asprintf() failed");
179 if (path_exists(config_path)) {
184 tok = strtok(NULL, ":");
188 die("Unable to find the configuration file (looked at "
189 "~/.i3status.conf, $XDG_CONFIG_HOME/i3status/config, "
190 "/etc/i3status.conf and $XDG_CONFIG_DIRS/i3status/config)");
194 int main(int argc, char *argv[]) {
197 cfg_opt_t general_opts[] = {
198 CFG_STR("output_format", "auto", CFGF_NONE),
199 CFG_BOOL("colors", 1, CFGF_NONE),
200 CFG_STR("color_separator", "#333333", CFGF_NONE),
201 CFG_INT("interval", 1, CFGF_NONE),
202 CFG_COLOR_OPTS("#00FF00", "#FFFF00", "#FF0000"),
206 cfg_opt_t run_watch_opts[] = {
207 CFG_STR("pidfile", NULL, CFGF_NONE),
208 CFG_STR("format", "%title: %status", CFGF_NONE),
209 CFG_CUSTOM_COLOR_OPTS,
213 cfg_opt_t wireless_opts[] = {
214 CFG_STR("format_up", "W: (%quality at %essid, %bitrate) %ip", CFGF_NONE),
215 CFG_STR("format_down", "W: down", CFGF_NONE),
216 CFG_CUSTOM_COLOR_OPTS,
220 cfg_opt_t ethernet_opts[] = {
221 CFG_STR("format_up", "E: %ip (%speed)", CFGF_NONE),
222 CFG_STR("format_down", "E: down", CFGF_NONE),
223 CFG_CUSTOM_COLOR_OPTS,
227 cfg_opt_t ipv6_opts[] = {
228 CFG_STR("format_up", "%ip", CFGF_NONE),
229 CFG_STR("format_down", "no IPv6", CFGF_NONE),
230 CFG_CUSTOM_COLOR_OPTS,
234 cfg_opt_t battery_opts[] = {
235 CFG_STR("format", "%status %percentage %remaining", CFGF_NONE),
236 CFG_STR("format_down", "No battery", CFGF_NONE),
237 CFG_STR("path", "/sys/class/power_supply/BAT%d/uevent", CFGF_NONE),
238 CFG_INT("low_threshold", 30, CFGF_NONE),
239 CFG_STR("threshold_type", "time", CFGF_NONE),
240 CFG_BOOL("last_full_capacity", false, CFGF_NONE),
241 CFG_BOOL("integer_battery_capacity", false, CFGF_NONE),
242 CFG_CUSTOM_COLOR_OPTS,
246 cfg_opt_t time_opts[] = {
247 CFG_STR("format", "%Y-%m-%d %H:%M:%S", CFGF_NONE),
251 cfg_opt_t tztime_opts[] = {
252 CFG_STR("format", "%Y-%m-%d %H:%M:%S %Z", CFGF_NONE),
253 CFG_STR("timezone", "", CFGF_NONE),
257 cfg_opt_t ddate_opts[] = {
258 CFG_STR("format", "%{%a, %b %d%}, %Y%N - %H", CFGF_NONE),
262 cfg_opt_t load_opts[] = {
263 CFG_STR("format", "%1min %5min %15min", CFGF_NONE),
264 CFG_FLOAT("max_threshold", 5, CFGF_NONE),
265 CFG_CUSTOM_COLOR_OPTS,
269 cfg_opt_t usage_opts[] = {
270 CFG_STR("format", "%usage", CFGF_NONE),
274 cfg_opt_t temp_opts[] = {
275 CFG_STR("format", "%degrees C", CFGF_NONE),
276 CFG_STR("path", NULL, CFGF_NONE),
277 CFG_INT("max_threshold", 75, CFGF_NONE),
278 CFG_CUSTOM_COLOR_OPTS,
282 cfg_opt_t disk_opts[] = {
283 CFG_STR("format", "%free", CFGF_NONE),
287 cfg_opt_t volume_opts[] = {
288 CFG_STR("format", "♪: %volume", CFGF_NONE),
289 CFG_STR("device", "default", CFGF_NONE),
290 CFG_STR("mixer", "Master", CFGF_NONE),
291 CFG_INT("mixer_idx", 0, CFGF_NONE),
292 CFG_CUSTOM_COLOR_OPTS,
297 CFG_STR_LIST("order", "{}", CFGF_NONE),
298 CFG_SEC("general", general_opts, CFGF_NONE),
299 CFG_SEC("run_watch", run_watch_opts, CFGF_TITLE | CFGF_MULTI),
300 CFG_SEC("wireless", wireless_opts, CFGF_TITLE | CFGF_MULTI),
301 CFG_SEC("ethernet", ethernet_opts, CFGF_TITLE | CFGF_MULTI),
302 CFG_SEC("battery", battery_opts, CFGF_TITLE | CFGF_MULTI),
303 CFG_SEC("cpu_temperature", temp_opts, CFGF_TITLE | CFGF_MULTI),
304 CFG_SEC("disk", disk_opts, CFGF_TITLE | CFGF_MULTI),
305 CFG_SEC("volume", volume_opts, CFGF_TITLE | CFGF_MULTI),
306 CFG_SEC("ipv6", ipv6_opts, CFGF_NONE),
307 CFG_SEC("time", time_opts, CFGF_NONE),
308 CFG_SEC("tztime", tztime_opts, CFGF_TITLE | CFGF_MULTI),
309 CFG_SEC("ddate", ddate_opts, CFGF_NONE),
310 CFG_SEC("load", load_opts, CFGF_NONE),
311 CFG_SEC("cpu_usage", usage_opts, CFGF_NONE),
312 CFG_CUSTOM_COLOR_OPTS,
316 char *configfile = NULL;
317 int o, option_index = 0;
318 struct option long_options[] = {
319 {"config", required_argument, 0, 'c'},
320 {"help", no_argument, 0, 'h'},
321 {"version", no_argument, 0, 'v'},
325 struct sigaction action;
326 memset(&action, 0, sizeof(struct sigaction));
327 action.sa_handler = fatalsig;
329 /* Exit upon SIGPIPE because when we have nowhere to write to, gathering system
330 * information is pointless. Also exit explicitly on SIGTERM and SIGINT because
331 * only this will trigger a reset of the cursor in the terminal output-format.
333 sigaction(SIGPIPE, &action, NULL);
334 sigaction(SIGTERM, &action, NULL);
335 sigaction(SIGINT, &action, NULL);
337 memset(&action, 0, sizeof(struct sigaction));
338 action.sa_handler = sigusr1;
339 sigaction(SIGUSR1, &action, NULL);
341 if (setlocale(LC_ALL, "") == NULL)
342 die("Could not set locale. Please make sure all your LC_* / LANG settings are correct.");
344 while ((o = getopt_long(argc, argv, "c:hv", long_options, &option_index)) != -1)
347 else if ((char)o == 'h') {
348 printf("i3status " VERSION " © 2008-2012 Michael Stapelberg and contributors\n"
349 "Syntax: %s [-c <configfile>] [-h] [-v]\n", argv[0]);
351 } else if ((char)o == 'v') {
352 printf("i3status " VERSION " © 2008-2012 Michael Stapelberg and contributors\n");
357 if (configfile == NULL)
358 configfile = get_config_path();
360 cfg = cfg_init(opts, CFGF_NOCASE);
361 if (cfg_parse(cfg, configfile) == CFG_PARSE_ERROR)
364 if (cfg_size(cfg, "order") == 0)
365 die("Your 'order' array is empty. Please fix your config.\n");
367 cfg_general = cfg_getsec(cfg, "general");
368 if (cfg_general == NULL)
369 die("Could not get section \"general\"\n");
371 char *output_str = cfg_getstr(cfg_general, "output_format");
372 if (strcasecmp(output_str, "auto") == 0) {
373 fprintf(stderr, "i3status: trying to auto-detect output_format setting\n");
374 output_str = auto_detect_format();
377 fprintf(stderr, "i3status: falling back to \"none\"\n");
379 fprintf(stderr, "i3status: auto-detected \"%s\"\n", output_str);
383 if (strcasecmp(output_str, "dzen2") == 0)
384 output_format = O_DZEN2;
385 else if (strcasecmp(output_str, "xmobar") == 0)
386 output_format = O_XMOBAR;
387 else if (strcasecmp(output_str, "i3bar") == 0)
388 output_format = O_I3BAR;
389 else if (strcasecmp(output_str, "term") == 0)
390 output_format = O_TERM;
391 else if (strcasecmp(output_str, "none") == 0)
392 output_format = O_NONE;
393 else die("Unknown output format: \"%s\"\n", output_str);
395 if (!valid_color(cfg_getstr(cfg_general, "color_good"))
396 || !valid_color(cfg_getstr(cfg_general, "color_degraded"))
397 || !valid_color(cfg_getstr(cfg_general, "color_bad"))
398 || !valid_color(cfg_getstr(cfg_general, "color_separator")))
399 die("Bad color format");
402 yajl_gen json_gen = yajl_gen_alloc(NULL);
404 yajl_gen json_gen = yajl_gen_alloc(NULL, NULL);
407 if (output_format == O_I3BAR) {
408 /* Initialize the i3bar protocol. See i3/docs/i3bar-protocol
410 printf("{\"version\":1}\n[\n");
412 yajl_gen_array_open(json_gen);
413 yajl_gen_clear(json_gen);
415 if (output_format == O_TERM) {
416 /* Save the cursor-position and hide the cursor */
417 printf("\033[s\033[?25l");
419 atexit(&reset_cursor);
422 if ((general_socket = socket(AF_INET, SOCK_DGRAM, 0)) == -1)
423 die("Could not create socket\n");
425 int interval = cfg_getint(cfg_general, "interval");
427 /* One memory page which each plugin can use to buffer output.
428 * Even though it’s unclean, we just assume that the user will not
429 * specify a format string which expands to something longer than 4096
430 * bytes — given that the output of i3status is used to display
431 * information on screen, more than 1024 characters for the full line
432 * (!), not individual plugins, seem very unlikely. */
436 if (exit_upon_signal) {
437 fprintf(stderr, "Exiting due to signal.\n");
441 gettimeofday(&tv, NULL);
442 if (output_format == O_I3BAR)
443 yajl_gen_array_open(json_gen);
444 else if (output_format == O_TERM)
445 /* Restore the cursor-position, clear line */
446 printf("\033[u\033[K");
447 for (j = 0; j < cfg_size(cfg, "order"); j++) {
451 const char *current = cfg_getnstr(cfg, "order", j);
454 SEC_OPEN_MAP("ipv6");
455 print_ipv6_info(json_gen, buffer, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
459 CASE_SEC_TITLE("wireless") {
460 SEC_OPEN_MAP("wireless");
461 print_wireless_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
465 CASE_SEC_TITLE("ethernet") {
466 SEC_OPEN_MAP("ethernet");
467 print_eth_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
471 CASE_SEC_TITLE("battery") {
472 SEC_OPEN_MAP("battery");
473 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"));
477 CASE_SEC_TITLE("run_watch") {
478 SEC_OPEN_MAP("run_watch");
479 print_run_watch(json_gen, buffer, title, cfg_getstr(sec, "pidfile"), cfg_getstr(sec, "format"));
483 CASE_SEC_TITLE("disk") {
484 SEC_OPEN_MAP("disk_info");
485 print_disk_info(json_gen, buffer, title, cfg_getstr(sec, "format"));
490 SEC_OPEN_MAP("load");
491 print_load(json_gen, buffer, cfg_getstr(sec, "format"), cfg_getfloat(sec, "max_threshold"));
496 SEC_OPEN_MAP("time");
497 print_time(json_gen, buffer, cfg_getstr(sec, "format"), NULL, tv.tv_sec);
501 CASE_SEC_TITLE("tztime") {
502 SEC_OPEN_MAP("tztime");
503 print_time(json_gen, buffer, cfg_getstr(sec, "format"), cfg_getstr(sec, "timezone"), tv.tv_sec);
508 SEC_OPEN_MAP("ddate");
509 print_ddate(json_gen, buffer, cfg_getstr(sec, "format"), tv.tv_sec);
513 CASE_SEC_TITLE("volume") {
514 SEC_OPEN_MAP("volume");
515 print_volume(json_gen, buffer, cfg_getstr(sec, "format"),
516 cfg_getstr(sec, "device"),
517 cfg_getstr(sec, "mixer"),
518 cfg_getint(sec, "mixer_idx"));
522 CASE_SEC_TITLE("cpu_temperature") {
523 SEC_OPEN_MAP("cpu_temperature");
524 print_cpu_temperature_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"), cfg_getint(sec, "max_threshold"));
528 CASE_SEC("cpu_usage") {
529 SEC_OPEN_MAP("cpu_usage");
530 print_cpu_usage(json_gen, buffer, cfg_getstr(sec, "format"));
534 if (output_format == O_I3BAR) {
535 yajl_gen_array_close(json_gen);
536 const unsigned char *buf;
542 yajl_gen_get_buf(json_gen, &buf, &len);
543 write(STDOUT_FILENO, buf, len);
544 yajl_gen_clear(json_gen);
550 /* To provide updates on every full second (as good as possible)
551 * we don’t use sleep(interval) but we sleep until the next
552 * second (with microsecond precision) plus (interval-1)
553 * seconds. We also align to 60 seconds modulo interval such
554 * that we start with :00 on every new minute. */
555 struct timeval current_timeval;
556 gettimeofday(¤t_timeval, NULL);
557 struct timespec ts = {interval - 1 - (current_timeval.tv_sec % interval), (10e5 - current_timeval.tv_usec) * 1000};
558 nanosleep(&ts, NULL);