4 * i3status – Generates a status line for dzen2 or xmobar
6 * Copyright © 2008-2011 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 /* socket file descriptor for general purposes */
41 cfg_t *cfg, *cfg_general;
44 * Exit upon SIGPIPE because when we have nowhere to write to, gathering
45 * system information is pointless.
48 void sigpipe(int signum) {
49 fprintf(stderr, "Received SIGPIPE, exiting\n");
54 * Checks if the given path exists by calling stat().
57 static bool path_exists(const char *path) {
59 return (stat(path, &buf) == 0);
62 static void *scalloc(size_t size) {
63 void *result = calloc(size, 1);
64 exit_if_null(result, "Error: out of memory (calloc(%zd))\n", size);
68 static char *sstrdup(const char *str) {
69 char *result = strdup(str);
70 exit_if_null(result, "Error: out of memory (strdup())\n");
76 * Validates a color in "#RRGGBB" format
79 static int valid_color(const char *value)
81 if (strlen(value) != 7) return 0;
82 if (value[0] != '#') return 0;
83 for (int i = 1; i < 7; ++i) {
84 if (value[i] >= '0' && value[i] <= '9') continue;
85 if (value[i] >= 'a' && value[i] <= 'f') continue;
86 if (value[i] >= 'A' && value[i] <= 'F') continue;
93 * This function resolves ~ in pathnames.
94 * It may resolve wildcards in the first part of the path, but if no match
95 * or multiple matches are found, it just returns a copy of path as given.
98 static char *resolve_tilde(const char *path) {
99 static glob_t globbuf;
100 char *head, *tail, *result = NULL;
102 tail = strchr(path, '/');
103 head = strndup(path, tail ? (size_t)(tail - path) : strlen(path));
105 int res = glob(head, GLOB_TILDE, NULL, &globbuf);
107 /* no match, or many wildcard matches are bad */
108 if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
109 result = sstrdup(path);
111 die("glob() failed");
113 head = globbuf.gl_pathv[0];
114 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
115 strncpy(result, head, strlen(head));
117 strncat(result, tail, strlen(tail));
124 static char *get_config_path() {
125 char *xdg_config_home, *xdg_config_dirs, *config_path;
127 /* 1: check the traditional path under the home directory */
128 config_path = resolve_tilde("~/.i3status.conf");
129 if (path_exists(config_path))
132 /* 2: check for $XDG_CONFIG_HOME/i3status/config */
133 if ((xdg_config_home = getenv("XDG_CONFIG_HOME")) == NULL)
134 xdg_config_home = "~/.config";
136 xdg_config_home = resolve_tilde(xdg_config_home);
137 if (asprintf(&config_path, "%s/i3status/config", xdg_config_home) == -1)
138 die("asprintf() failed");
139 free(xdg_config_home);
141 if (path_exists(config_path))
145 /* 3: check the traditional path under /etc */
146 config_path = SYSCONFDIR "/i3status.conf";
147 if (path_exists(config_path))
148 return sstrdup(config_path);
150 /* 4: check for $XDG_CONFIG_DIRS/i3status/config */
151 if ((xdg_config_dirs = getenv("XDG_CONFIG_DIRS")) == NULL)
152 xdg_config_dirs = "/etc/xdg";
154 char *buf = strdup(xdg_config_dirs);
155 char *tok = strtok(buf, ":");
156 while (tok != NULL) {
157 tok = resolve_tilde(tok);
158 if (asprintf(&config_path, "%s/i3status/config", tok) == -1)
159 die("asprintf() failed");
161 if (path_exists(config_path)) {
166 tok = strtok(NULL, ":");
170 die("Unable to find the configuration file (looked at "
171 "~/.i3status.conf, $XDG_CONFIG_HOME/i3status/config, "
172 "/etc/i3status.conf and $XDG_CONFIG_DIRS/i3status/config)");
176 int main(int argc, char *argv[]) {
179 cfg_opt_t general_opts[] = {
180 CFG_STR("output_format", "auto", CFGF_NONE),
181 CFG_BOOL("colors", 1, CFGF_NONE),
182 CFG_STR("color_good", "#00FF00", CFGF_NONE),
183 CFG_STR("color_degraded", "#FFFF00", CFGF_NONE),
184 CFG_STR("color_bad", "#FF0000", CFGF_NONE),
185 CFG_STR("color_separator", "#333333", CFGF_NONE),
186 CFG_INT("interval", 1, CFGF_NONE),
190 cfg_opt_t run_watch_opts[] = {
191 CFG_STR("pidfile", NULL, CFGF_NONE),
192 CFG_STR("format", "%title: %status", CFGF_NONE),
196 cfg_opt_t wireless_opts[] = {
197 CFG_STR("format_up", "W: (%quality at %essid, %bitrate) %ip", CFGF_NONE),
198 CFG_STR("format_down", "W: down", CFGF_NONE),
202 cfg_opt_t ethernet_opts[] = {
203 CFG_STR("format_up", "E: %ip (%speed)", CFGF_NONE),
204 CFG_STR("format_down", "E: down", CFGF_NONE),
208 cfg_opt_t ipv6_opts[] = {
209 CFG_STR("format_up", "%ip", CFGF_NONE),
210 CFG_STR("format_down", "no IPv6", CFGF_NONE),
214 cfg_opt_t battery_opts[] = {
215 CFG_STR("format", "%status %percentage %remaining", CFGF_NONE),
216 CFG_STR("path", "/sys/class/power_supply/BAT%d/uevent", CFGF_NONE),
217 CFG_BOOL("last_full_capacity", false, CFGF_NONE),
221 cfg_opt_t time_opts[] = {
222 CFG_STR("format", "%d.%m.%Y %H:%M:%S", CFGF_NONE),
226 cfg_opt_t ddate_opts[] = {
227 CFG_STR("format", "%{%a, %b %d%}, %Y%N - %H", CFGF_NONE),
231 cfg_opt_t load_opts[] = {
232 CFG_STR("format", "%1min %5min %15min", CFGF_NONE),
236 cfg_opt_t usage_opts[] = {
237 CFG_STR("format", "%usage", CFGF_NONE),
241 cfg_opt_t temp_opts[] = {
242 CFG_STR("format", "%degrees C", CFGF_NONE),
243 CFG_STR("path", NULL, CFGF_NONE),
247 cfg_opt_t disk_opts[] = {
248 CFG_STR("format", "%free", CFGF_NONE),
252 cfg_opt_t volume_opts[] = {
253 CFG_STR("format", "♪: %volume", CFGF_NONE),
254 CFG_STR("device", "default", CFGF_NONE),
255 CFG_STR("mixer", "Master", CFGF_NONE),
256 CFG_INT("mixer_idx", 0, CFGF_NONE),
261 CFG_STR_LIST("order", "{}", CFGF_NONE),
262 CFG_SEC("general", general_opts, CFGF_NONE),
263 CFG_SEC("run_watch", run_watch_opts, CFGF_TITLE | CFGF_MULTI),
264 CFG_SEC("wireless", wireless_opts, CFGF_TITLE | CFGF_MULTI),
265 CFG_SEC("ethernet", ethernet_opts, CFGF_TITLE | CFGF_MULTI),
266 CFG_SEC("battery", battery_opts, CFGF_TITLE | CFGF_MULTI),
267 CFG_SEC("cpu_temperature", temp_opts, CFGF_TITLE | CFGF_MULTI),
268 CFG_SEC("disk", disk_opts, CFGF_TITLE | CFGF_MULTI),
269 CFG_SEC("volume", volume_opts, CFGF_TITLE | CFGF_MULTI),
270 CFG_SEC("ipv6", ipv6_opts, CFGF_NONE),
271 CFG_SEC("time", time_opts, CFGF_NONE),
272 CFG_SEC("ddate", ddate_opts, CFGF_NONE),
273 CFG_SEC("load", load_opts, CFGF_NONE),
274 CFG_SEC("cpu_usage", usage_opts, CFGF_NONE),
278 char *configfile = NULL;
279 int o, option_index = 0;
280 struct option long_options[] = {
281 {"config", required_argument, 0, 'c'},
282 {"help", no_argument, 0, 'h'},
283 {"version", no_argument, 0, 'v'},
287 struct sigaction action;
288 memset(&action, 0, sizeof(struct sigaction));
289 action.sa_handler = sigpipe;
290 sigaction(SIGPIPE, &action, NULL);
292 if (setlocale(LC_ALL, "") == NULL)
293 die("Could not set locale. Please make sure all your LC_* / LANG settings are correct.");
295 while ((o = getopt_long(argc, argv, "c:hv", long_options, &option_index)) != -1)
298 else if ((char)o == 'h') {
299 printf("i3status " VERSION " © 2008-2011 Michael Stapelberg and contributors\n"
300 "Syntax: %s [-c <configfile>] [-h] [-v]\n", argv[0]);
302 } else if ((char)o == 'v') {
303 printf("i3status " VERSION " © 2008-2011 Michael Stapelberg and contributors\n");
308 if (configfile == NULL)
309 configfile = get_config_path();
311 cfg = cfg_init(opts, CFGF_NOCASE);
312 if (cfg_parse(cfg, configfile) == CFG_PARSE_ERROR)
315 if (cfg_size(cfg, "order") == 0)
316 die("Your 'order' array is empty. Please fix your config.\n");
318 cfg_general = cfg_getsec(cfg, "general");
319 if (cfg_general == NULL)
320 die("Could not get section \"general\"\n");
322 char *output_str = cfg_getstr(cfg_general, "output_format");
323 if (strcasecmp(output_str, "auto") == 0) {
324 fprintf(stderr, "i3status: trying to auto-detect output_format setting\n");
325 output_str = auto_detect_format();
328 fprintf(stderr, "i3status: falling back to \"none\"\n");
330 fprintf(stderr, "i3status: auto-detected \"%s\"\n", output_str);
334 if (strcasecmp(output_str, "dzen2") == 0)
335 output_format = O_DZEN2;
336 else if (strcasecmp(output_str, "xmobar") == 0)
337 output_format = O_XMOBAR;
338 else if (strcasecmp(output_str, "i3bar") == 0)
339 output_format = O_I3BAR;
340 else if (strcasecmp(output_str, "none") == 0)
341 output_format = O_NONE;
342 else die("Unknown output format: \"%s\"\n", output_str);
344 if (!valid_color(cfg_getstr(cfg_general, "color_good"))
345 || !valid_color(cfg_getstr(cfg_general, "color_degraded"))
346 || !valid_color(cfg_getstr(cfg_general, "color_bad"))
347 || !valid_color(cfg_getstr(cfg_general, "color_separator")))
348 die("Bad color format");
351 yajl_gen json_gen = yajl_gen_alloc(NULL);
353 yajl_gen json_gen = yajl_gen_alloc(NULL, NULL);
356 if (output_format == O_I3BAR) {
357 /* Initialize the i3bar protocol. See i3/docs/i3bar-protocol
359 printf("{\"version\":1}\n[\n");
361 yajl_gen_array_open(json_gen);
362 yajl_gen_clear(json_gen);
365 if ((general_socket = socket(AF_INET, SOCK_DGRAM, 0)) == -1)
366 die("Could not create socket\n");
368 int interval = cfg_getint(cfg_general, "interval");
370 /* One memory page which each plugin can use to buffer output.
371 * Even though it’s unclean, we just assume that the user will not
372 * specify a format string which expands to something longer than 4096
373 * bytes — given that the output of i3status is used to display
374 * information on screen, more than 1024 characters for the full line
375 * (!), not individual plugins, seem very unlikely. */
381 gettimeofday(&tv, NULL);
382 time_t current_time = tv.tv_sec;
383 struct tm *current_tm = NULL;
384 if (current_time != (time_t) -1) {
385 localtime_r(¤t_time, &tm);
388 if (output_format == O_I3BAR)
389 yajl_gen_array_open(json_gen);
390 for (j = 0; j < cfg_size(cfg, "order"); j++) {
394 const char *current = cfg_getnstr(cfg, "order", j);
397 SEC_OPEN_MAP("ipv6");
398 print_ipv6_info(json_gen, buffer, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
402 CASE_SEC_TITLE("wireless") {
403 SEC_OPEN_MAP("wireless");
404 print_wireless_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
408 CASE_SEC_TITLE("ethernet") {
409 SEC_OPEN_MAP("ethernet");
410 print_eth_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
414 CASE_SEC_TITLE("battery") {
415 SEC_OPEN_MAP("battery");
416 print_battery_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"), cfg_getbool(sec, "last_full_capacity"));
420 CASE_SEC_TITLE("run_watch") {
421 SEC_OPEN_MAP("run_watch");
422 print_run_watch(json_gen, buffer, title, cfg_getstr(sec, "pidfile"), cfg_getstr(sec, "format"));
426 CASE_SEC_TITLE("disk") {
427 SEC_OPEN_MAP("disk_info");
428 print_disk_info(json_gen, buffer, title, cfg_getstr(sec, "format"));
433 SEC_OPEN_MAP("load");
434 print_load(json_gen, buffer, cfg_getstr(sec, "format"));
439 SEC_OPEN_MAP("time");
440 print_time(json_gen, buffer, cfg_getstr(sec, "format"), current_tm);
445 SEC_OPEN_MAP("ddate");
446 print_ddate(json_gen, buffer, cfg_getstr(sec, "format"), current_tm);
450 CASE_SEC_TITLE("volume") {
451 SEC_OPEN_MAP("volume");
452 print_volume(json_gen, buffer, cfg_getstr(sec, "format"),
453 cfg_getstr(sec, "device"),
454 cfg_getstr(sec, "mixer"),
455 cfg_getint(sec, "mixer_idx"));
459 CASE_SEC_TITLE("cpu_temperature") {
460 SEC_OPEN_MAP("cpu_temperature");
461 print_cpu_temperature_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"));
465 CASE_SEC("cpu_usage") {
466 SEC_OPEN_MAP("cpu_usage");
467 print_cpu_usage(json_gen, buffer, cfg_getstr(sec, "format"));
471 if (output_format == O_I3BAR) {
472 yajl_gen_array_close(json_gen);
473 const unsigned char *buf;
479 yajl_gen_get_buf(json_gen, &buf, &len);
480 write(STDOUT_FILENO, buf, len);
481 yajl_gen_clear(json_gen);
487 /* To provide updates on every full second (as good as possible)
488 * we don’t use sleep(interval) but we sleep until the next
489 * second (with microsecond precision) plus (interval-1)
491 struct timeval current_timeval;
492 gettimeofday(¤t_timeval, NULL);
493 struct timespec ts = {interval - 1, (10e5 - current_timeval.tv_usec) * 1000};
494 nanosleep(&ts, NULL);