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 cfg_t *cfg, *cfg_general, *cfg_section;
51 * Exit upon SIGPIPE because when we have nowhere to write to, gathering
52 * system information is pointless.
55 void sigpipe(int signum) {
56 fprintf(stderr, "Received SIGPIPE, exiting\n");
61 * Do nothing upon SIGUSR1. Running this signal handler will nevertheless
62 * interrupt nanosleep() so that i3status immediately generates new output.
65 void sigusr1(int signum) {
69 * Checks if the given path exists by calling stat().
72 static bool path_exists(const char *path) {
74 return (stat(path, &buf) == 0);
77 static void *scalloc(size_t size) {
78 void *result = calloc(size, 1);
79 exit_if_null(result, "Error: out of memory (calloc(%zd))\n", size);
83 static char *sstrdup(const char *str) {
84 char *result = strdup(str);
85 exit_if_null(result, "Error: out of memory (strdup())\n");
91 * Validates a color in "#RRGGBB" format
94 static int valid_color(const char *value)
96 if (strlen(value) != 7) return 0;
97 if (value[0] != '#') return 0;
98 for (int i = 1; i < 7; ++i) {
99 if (value[i] >= '0' && value[i] <= '9') continue;
100 if (value[i] >= 'a' && value[i] <= 'f') continue;
101 if (value[i] >= 'A' && value[i] <= 'F') continue;
108 * This function resolves ~ in pathnames.
109 * It may resolve wildcards in the first part of the path, but if no match
110 * or multiple matches are found, it just returns a copy of path as given.
113 static char *resolve_tilde(const char *path) {
114 static glob_t globbuf;
115 char *head, *tail, *result = NULL;
117 tail = strchr(path, '/');
118 head = strndup(path, tail ? (size_t)(tail - path) : strlen(path));
120 int res = glob(head, GLOB_TILDE, NULL, &globbuf);
122 /* no match, or many wildcard matches are bad */
123 if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
124 result = sstrdup(path);
126 die("glob() failed");
128 head = globbuf.gl_pathv[0];
129 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
130 strncpy(result, head, strlen(head));
132 strncat(result, tail, strlen(tail));
139 static char *get_config_path(void) {
140 char *xdg_config_home, *xdg_config_dirs, *config_path;
142 /* 1: check the traditional path under the home directory */
143 config_path = resolve_tilde("~/.i3status.conf");
144 if (path_exists(config_path))
147 /* 2: check for $XDG_CONFIG_HOME/i3status/config */
148 if ((xdg_config_home = getenv("XDG_CONFIG_HOME")) == NULL)
149 xdg_config_home = "~/.config";
151 xdg_config_home = resolve_tilde(xdg_config_home);
152 if (asprintf(&config_path, "%s/i3status/config", xdg_config_home) == -1)
153 die("asprintf() failed");
154 free(xdg_config_home);
156 if (path_exists(config_path))
160 /* 3: check the traditional path under /etc */
161 config_path = SYSCONFDIR "/i3status.conf";
162 if (path_exists(config_path))
163 return sstrdup(config_path);
165 /* 4: check for $XDG_CONFIG_DIRS/i3status/config */
166 if ((xdg_config_dirs = getenv("XDG_CONFIG_DIRS")) == NULL)
167 xdg_config_dirs = "/etc/xdg";
169 char *buf = strdup(xdg_config_dirs);
170 char *tok = strtok(buf, ":");
171 while (tok != NULL) {
172 tok = resolve_tilde(tok);
173 if (asprintf(&config_path, "%s/i3status/config", tok) == -1)
174 die("asprintf() failed");
176 if (path_exists(config_path)) {
181 tok = strtok(NULL, ":");
185 die("Unable to find the configuration file (looked at "
186 "~/.i3status.conf, $XDG_CONFIG_HOME/i3status/config, "
187 "/etc/i3status.conf and $XDG_CONFIG_DIRS/i3status/config)");
191 int main(int argc, char *argv[]) {
194 cfg_opt_t general_opts[] = {
195 CFG_STR("output_format", "auto", CFGF_NONE),
196 CFG_BOOL("colors", 1, CFGF_NONE),
197 CFG_STR("color_separator", "#333333", CFGF_NONE),
198 CFG_INT("interval", 1, CFGF_NONE),
199 CFG_COLOR_OPTS("#00FF00", "#FFFF00", "#FF0000"),
203 cfg_opt_t run_watch_opts[] = {
204 CFG_STR("pidfile", NULL, CFGF_NONE),
205 CFG_STR("format", "%title: %status", CFGF_NONE),
206 CFG_CUSTOM_COLOR_OPTS,
210 cfg_opt_t wireless_opts[] = {
211 CFG_STR("format_up", "W: (%quality at %essid, %bitrate) %ip", CFGF_NONE),
212 CFG_STR("format_down", "W: down", CFGF_NONE),
213 CFG_CUSTOM_COLOR_OPTS,
217 cfg_opt_t ethernet_opts[] = {
218 CFG_STR("format_up", "E: %ip (%speed)", CFGF_NONE),
219 CFG_STR("format_down", "E: down", CFGF_NONE),
220 CFG_CUSTOM_COLOR_OPTS,
224 cfg_opt_t ipv6_opts[] = {
225 CFG_STR("format_up", "%ip", CFGF_NONE),
226 CFG_STR("format_down", "no IPv6", CFGF_NONE),
227 CFG_CUSTOM_COLOR_OPTS,
231 cfg_opt_t battery_opts[] = {
232 CFG_STR("format", "%status %percentage %remaining", CFGF_NONE),
233 CFG_STR("format_down", "No battery", CFGF_NONE),
234 CFG_STR("path", "/sys/class/power_supply/BAT%d/uevent", CFGF_NONE),
235 CFG_INT("low_threshold", 30, CFGF_NONE),
236 CFG_STR("threshold_type", "time", CFGF_NONE),
237 CFG_BOOL("last_full_capacity", false, CFGF_NONE),
238 CFG_BOOL("integer_battery_capacity", false, CFGF_NONE),
239 CFG_CUSTOM_COLOR_OPTS,
243 cfg_opt_t time_opts[] = {
244 CFG_STR("format", "%Y-%m-%d %H:%M:%S", CFGF_NONE),
248 cfg_opt_t tztime_opts[] = {
249 CFG_STR("format", "%Y-%m-%d %H:%M:%S %Z", CFGF_NONE),
250 CFG_STR("timezone", "", CFGF_NONE),
254 cfg_opt_t ddate_opts[] = {
255 CFG_STR("format", "%{%a, %b %d%}, %Y%N - %H", CFGF_NONE),
259 cfg_opt_t load_opts[] = {
260 CFG_STR("format", "%1min %5min %15min", CFGF_NONE),
261 CFG_INT("max_threshold", 5, CFGF_NONE),
262 CFG_CUSTOM_COLOR_OPTS,
266 cfg_opt_t usage_opts[] = {
267 CFG_STR("format", "%usage", CFGF_NONE),
271 cfg_opt_t temp_opts[] = {
272 CFG_STR("format", "%degrees C", CFGF_NONE),
273 CFG_STR("path", NULL, CFGF_NONE),
274 CFG_INT("max_threshold", 75, CFGF_NONE),
275 CFG_CUSTOM_COLOR_OPTS,
279 cfg_opt_t disk_opts[] = {
280 CFG_STR("format", "%free", CFGF_NONE),
284 cfg_opt_t volume_opts[] = {
285 CFG_STR("format", "♪: %volume", CFGF_NONE),
286 CFG_STR("device", "default", CFGF_NONE),
287 CFG_STR("mixer", "Master", CFGF_NONE),
288 CFG_INT("mixer_idx", 0, CFGF_NONE),
289 CFG_CUSTOM_COLOR_OPTS,
294 CFG_STR_LIST("order", "{}", CFGF_NONE),
295 CFG_SEC("general", general_opts, CFGF_NONE),
296 CFG_SEC("run_watch", run_watch_opts, CFGF_TITLE | CFGF_MULTI),
297 CFG_SEC("wireless", wireless_opts, CFGF_TITLE | CFGF_MULTI),
298 CFG_SEC("ethernet", ethernet_opts, CFGF_TITLE | CFGF_MULTI),
299 CFG_SEC("battery", battery_opts, CFGF_TITLE | CFGF_MULTI),
300 CFG_SEC("cpu_temperature", temp_opts, CFGF_TITLE | CFGF_MULTI),
301 CFG_SEC("disk", disk_opts, CFGF_TITLE | CFGF_MULTI),
302 CFG_SEC("volume", volume_opts, CFGF_TITLE | CFGF_MULTI),
303 CFG_SEC("ipv6", ipv6_opts, CFGF_NONE),
304 CFG_SEC("time", time_opts, CFGF_NONE),
305 CFG_SEC("tztime", tztime_opts, CFGF_TITLE | CFGF_MULTI),
306 CFG_SEC("ddate", ddate_opts, CFGF_NONE),
307 CFG_SEC("load", load_opts, CFGF_NONE),
308 CFG_SEC("cpu_usage", usage_opts, CFGF_NONE),
309 CFG_CUSTOM_COLOR_OPTS,
313 char *configfile = NULL;
314 int o, option_index = 0;
315 struct option long_options[] = {
316 {"config", required_argument, 0, 'c'},
317 {"help", no_argument, 0, 'h'},
318 {"version", no_argument, 0, 'v'},
322 struct sigaction action;
323 memset(&action, 0, sizeof(struct sigaction));
324 action.sa_handler = sigpipe;
325 sigaction(SIGPIPE, &action, NULL);
327 memset(&action, 0, sizeof(struct sigaction));
328 action.sa_handler = sigusr1;
329 sigaction(SIGUSR1, &action, NULL);
331 if (setlocale(LC_ALL, "") == NULL)
332 die("Could not set locale. Please make sure all your LC_* / LANG settings are correct.");
334 while ((o = getopt_long(argc, argv, "c:hv", long_options, &option_index)) != -1)
337 else if ((char)o == 'h') {
338 printf("i3status " VERSION " © 2008-2012 Michael Stapelberg and contributors\n"
339 "Syntax: %s [-c <configfile>] [-h] [-v]\n", argv[0]);
341 } else if ((char)o == 'v') {
342 printf("i3status " VERSION " © 2008-2012 Michael Stapelberg and contributors\n");
347 if (configfile == NULL)
348 configfile = get_config_path();
350 cfg = cfg_init(opts, CFGF_NOCASE);
351 if (cfg_parse(cfg, configfile) == CFG_PARSE_ERROR)
354 if (cfg_size(cfg, "order") == 0)
355 die("Your 'order' array is empty. Please fix your config.\n");
357 cfg_general = cfg_getsec(cfg, "general");
358 if (cfg_general == NULL)
359 die("Could not get section \"general\"\n");
361 char *output_str = cfg_getstr(cfg_general, "output_format");
362 if (strcasecmp(output_str, "auto") == 0) {
363 fprintf(stderr, "i3status: trying to auto-detect output_format setting\n");
364 output_str = auto_detect_format();
367 fprintf(stderr, "i3status: falling back to \"none\"\n");
369 fprintf(stderr, "i3status: auto-detected \"%s\"\n", output_str);
373 if (strcasecmp(output_str, "dzen2") == 0)
374 output_format = O_DZEN2;
375 else if (strcasecmp(output_str, "xmobar") == 0)
376 output_format = O_XMOBAR;
377 else if (strcasecmp(output_str, "i3bar") == 0)
378 output_format = O_I3BAR;
379 else if (strcasecmp(output_str, "none") == 0)
380 output_format = O_NONE;
381 else die("Unknown output format: \"%s\"\n", output_str);
383 if (!valid_color(cfg_getstr(cfg_general, "color_good"))
384 || !valid_color(cfg_getstr(cfg_general, "color_degraded"))
385 || !valid_color(cfg_getstr(cfg_general, "color_bad"))
386 || !valid_color(cfg_getstr(cfg_general, "color_separator")))
387 die("Bad color format");
390 yajl_gen json_gen = yajl_gen_alloc(NULL);
392 yajl_gen json_gen = yajl_gen_alloc(NULL, NULL);
395 if (output_format == O_I3BAR) {
396 /* Initialize the i3bar protocol. See i3/docs/i3bar-protocol
398 printf("{\"version\":1}\n[\n");
400 yajl_gen_array_open(json_gen);
401 yajl_gen_clear(json_gen);
404 if ((general_socket = socket(AF_INET, SOCK_DGRAM, 0)) == -1)
405 die("Could not create socket\n");
407 int interval = cfg_getint(cfg_general, "interval");
409 /* One memory page which each plugin can use to buffer output.
410 * Even though it’s unclean, we just assume that the user will not
411 * specify a format string which expands to something longer than 4096
412 * bytes — given that the output of i3status is used to display
413 * information on screen, more than 1024 characters for the full line
414 * (!), not individual plugins, seem very unlikely. */
419 gettimeofday(&tv, NULL);
420 if (output_format == O_I3BAR)
421 yajl_gen_array_open(json_gen);
422 for (j = 0; j < cfg_size(cfg, "order"); j++) {
426 const char *current = cfg_getnstr(cfg, "order", j);
429 SEC_OPEN_MAP("ipv6");
430 print_ipv6_info(json_gen, buffer, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
434 CASE_SEC_TITLE("wireless") {
435 SEC_OPEN_MAP("wireless");
436 print_wireless_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
440 CASE_SEC_TITLE("ethernet") {
441 SEC_OPEN_MAP("ethernet");
442 print_eth_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
446 CASE_SEC_TITLE("battery") {
447 SEC_OPEN_MAP("battery");
448 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"));
452 CASE_SEC_TITLE("run_watch") {
453 SEC_OPEN_MAP("run_watch");
454 print_run_watch(json_gen, buffer, title, cfg_getstr(sec, "pidfile"), cfg_getstr(sec, "format"));
458 CASE_SEC_TITLE("disk") {
459 SEC_OPEN_MAP("disk_info");
460 print_disk_info(json_gen, buffer, title, cfg_getstr(sec, "format"));
465 SEC_OPEN_MAP("load");
466 print_load(json_gen, buffer, cfg_getstr(sec, "format"), cfg_getint(sec, "max_threshold"));
471 SEC_OPEN_MAP("time");
472 print_time(json_gen, buffer, cfg_getstr(sec, "format"), NULL, tv.tv_sec);
476 CASE_SEC_TITLE("tztime") {
477 SEC_OPEN_MAP("tztime");
478 print_time(json_gen, buffer, cfg_getstr(sec, "format"), cfg_getstr(sec, "timezone"), tv.tv_sec);
483 SEC_OPEN_MAP("ddate");
484 print_ddate(json_gen, buffer, cfg_getstr(sec, "format"), tv.tv_sec);
488 CASE_SEC_TITLE("volume") {
489 SEC_OPEN_MAP("volume");
490 print_volume(json_gen, buffer, cfg_getstr(sec, "format"),
491 cfg_getstr(sec, "device"),
492 cfg_getstr(sec, "mixer"),
493 cfg_getint(sec, "mixer_idx"));
497 CASE_SEC_TITLE("cpu_temperature") {
498 SEC_OPEN_MAP("cpu_temperature");
499 print_cpu_temperature_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"), cfg_getint(sec, "max_threshold"));
503 CASE_SEC("cpu_usage") {
504 SEC_OPEN_MAP("cpu_usage");
505 print_cpu_usage(json_gen, buffer, cfg_getstr(sec, "format"));
509 if (output_format == O_I3BAR) {
510 yajl_gen_array_close(json_gen);
511 const unsigned char *buf;
517 yajl_gen_get_buf(json_gen, &buf, &len);
518 write(STDOUT_FILENO, buf, len);
519 yajl_gen_clear(json_gen);
525 /* To provide updates on every full second (as good as possible)
526 * we don’t use sleep(interval) but we sleep until the next
527 * second (with microsecond precision) plus (interval-1)
528 * seconds. We also align to 60 seconds modulo interval such
529 * that we start with :00 on every new minute. */
530 struct timeval current_timeval;
531 gettimeofday(¤t_timeval, NULL);
532 struct timespec ts = {interval - 1 - (current_timeval.tv_sec % interval), (10e5 - current_timeval.tv_usec) * 1000};
533 nanosleep(&ts, NULL);