]> git.sur5r.net Git - i3/i3status/blob - i3status.c
signal handler: set flag because directly calling fprintf() is unsafe
[i3/i3status] / i3status.c
1 /*
2  * vim:ts=8:expandtab
3  *
4  * i3status – Generates a status line for dzen2 or xmobar
5  *
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>
10  *
11  * See file LICENSE for license information.
12  *
13  */
14 #include <string.h>
15 #include <stdio.h>
16 #include <stdbool.h>
17 #include <unistd.h>
18 #include <stdlib.h>
19 #include <sys/socket.h>
20 #include <netinet/in.h>
21 #include <getopt.h>
22 #include <signal.h>
23 #include <confuse.h>
24 #include <glob.h>
25 #include <sys/stat.h>
26 #include <sys/types.h>
27 #include <time.h>
28 #include <sys/time.h>
29 #include <locale.h>
30
31 #include <yajl/yajl_gen.h>
32 #include <yajl/yajl_version.h>
33
34 #include "i3status.h"
35
36 #define exit_if_null(pointer, ...) { if (pointer == NULL) die(__VA_ARGS__); }
37
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)
42
43 #define CFG_CUSTOM_COLOR_OPTS CFG_COLOR_OPTS(NULL, NULL, NULL)
44
45 /* socket file descriptor for general purposes */
46 int general_socket;
47
48 static bool exit_upon_signal = false;
49
50 cfg_t *cfg, *cfg_general, *cfg_section;
51
52 /*
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
57  *
58  */
59 void fatalsig(int signum) {
60         exit_upon_signal = true;
61 }
62
63 /*
64  * Do nothing upon SIGUSR1. Running this signal handler will nevertheless
65  * interrupt nanosleep() so that i3status immediately generates new output.
66  *
67  */
68 void sigusr1(int signum) {
69 }
70
71 /*
72  * Checks if the given path exists by calling stat().
73  *
74  */
75 static bool path_exists(const char *path) {
76         struct stat buf;
77         return (stat(path, &buf) == 0);
78 }
79
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);
83         return result;
84 }
85
86 static char *sstrdup(const char *str) {
87         char *result = strdup(str);
88         exit_if_null(result, "Error: out of memory (strdup())\n");
89         return result;
90 }
91
92
93 /*
94  * Validates a color in "#RRGGBB" format
95  *
96  */
97 static int valid_color(const char *value)
98 {
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;
105                 return 0;
106         }
107         return 1;
108 }
109
110 /*
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.
114  *
115  */
116 static char *resolve_tilde(const char *path) {
117         static glob_t globbuf;
118         char *head, *tail, *result = NULL;
119
120         tail = strchr(path, '/');
121         head = strndup(path, tail ? (size_t)(tail - path) : strlen(path));
122
123         int res = glob(head, GLOB_TILDE, NULL, &globbuf);
124         free(head);
125         /* no match, or many wildcard matches are bad */
126         if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
127                 result = sstrdup(path);
128         else if (res != 0) {
129                 die("glob() failed");
130         } else {
131                 head = globbuf.gl_pathv[0];
132                 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
133                 strncpy(result, head, strlen(head));
134                 if (tail)
135                         strncat(result, tail, strlen(tail));
136         }
137         globfree(&globbuf);
138
139         return result;
140 }
141
142 static char *get_config_path(void) {
143         char *xdg_config_home, *xdg_config_dirs, *config_path;
144
145         /* 1: check the traditional path under the home directory */
146         config_path = resolve_tilde("~/.i3status.conf");
147         if (path_exists(config_path))
148                 return config_path;
149
150         /* 2: check for $XDG_CONFIG_HOME/i3status/config */
151         if ((xdg_config_home = getenv("XDG_CONFIG_HOME")) == NULL)
152                 xdg_config_home = "~/.config";
153
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);
158
159         if (path_exists(config_path))
160                 return config_path;
161         free(config_path);
162
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);
167
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";
171
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");
178                 free(tok);
179                 if (path_exists(config_path)) {
180                         free(buf);
181                         return config_path;
182                 }
183                 free(config_path);
184                 tok = strtok(NULL, ":");
185         }
186         free(buf);
187
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)");
191         return NULL;
192 }
193
194 int main(int argc, char *argv[]) {
195         unsigned int j;
196
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"),
203                 CFG_END()
204         };
205
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,
210                 CFG_END()
211         };
212
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,
217                 CFG_END()
218         };
219
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,
224                 CFG_END()
225         };
226
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,
231                 CFG_END()
232         };
233
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,
243                 CFG_END()
244         };
245
246         cfg_opt_t time_opts[] = {
247                 CFG_STR("format", "%Y-%m-%d %H:%M:%S", CFGF_NONE),
248                 CFG_END()
249         };
250
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),
254                 CFG_END()
255         };
256
257         cfg_opt_t ddate_opts[] = {
258                 CFG_STR("format", "%{%a, %b %d%}, %Y%N - %H", CFGF_NONE),
259                 CFG_END()
260         };
261
262         cfg_opt_t load_opts[] = {
263                 CFG_STR("format", "%1min %5min %15min", CFGF_NONE),
264                 CFG_INT("max_threshold", 5, CFGF_NONE),
265                 CFG_CUSTOM_COLOR_OPTS,
266                 CFG_END()
267         };
268
269         cfg_opt_t usage_opts[] = {
270                 CFG_STR("format", "%usage", CFGF_NONE),
271                 CFG_END()
272         };
273
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,
279                 CFG_END()
280         };
281
282         cfg_opt_t disk_opts[] = {
283                 CFG_STR("format", "%free", CFGF_NONE),
284                 CFG_END()
285         };
286
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,
293                 CFG_END()
294         };
295
296         cfg_opt_t 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,
313                 CFG_END()
314         };
315
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'},
322                 {0, 0, 0, 0}
323         };
324
325         struct sigaction action;
326         memset(&action, 0, sizeof(struct sigaction));
327         action.sa_handler = fatalsig;
328
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.
332          */
333         sigaction(SIGPIPE, &action, NULL);
334         sigaction(SIGTERM, &action, NULL);
335         sigaction(SIGINT, &action, NULL);
336
337         memset(&action, 0, sizeof(struct sigaction));
338         action.sa_handler = sigusr1;
339         sigaction(SIGUSR1, &action, NULL);
340
341         if (setlocale(LC_ALL, "") == NULL)
342                 die("Could not set locale. Please make sure all your LC_* / LANG settings are correct.");
343
344         while ((o = getopt_long(argc, argv, "c:hv", long_options, &option_index)) != -1)
345                 if ((char)o == 'c')
346                         configfile = optarg;
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]);
350                         return 0;
351                 } else if ((char)o == 'v') {
352                         printf("i3status " VERSION " © 2008-2012 Michael Stapelberg and contributors\n");
353                         return 0;
354                 }
355
356
357         if (configfile == NULL)
358                 configfile = get_config_path();
359
360         cfg = cfg_init(opts, CFGF_NOCASE);
361         if (cfg_parse(cfg, configfile) == CFG_PARSE_ERROR)
362                 return EXIT_FAILURE;
363
364         if (cfg_size(cfg, "order") == 0)
365                 die("Your 'order' array is empty. Please fix your config.\n");
366
367         cfg_general = cfg_getsec(cfg, "general");
368         if (cfg_general == NULL)
369                 die("Could not get section \"general\"\n");
370
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();
375                 if (!output_str) {
376                         output_str = "none";
377                         fprintf(stderr, "i3status: falling back to \"none\"\n");
378                 } else {
379                         fprintf(stderr, "i3status: auto-detected \"%s\"\n", output_str);
380                 }
381         }
382
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);
394
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");
400
401 #if YAJL_MAJOR >= 2
402         yajl_gen json_gen = yajl_gen_alloc(NULL);
403 #else
404         yajl_gen json_gen = yajl_gen_alloc(NULL, NULL);
405 #endif
406
407         if (output_format == O_I3BAR) {
408                 /* Initialize the i3bar protocol. See i3/docs/i3bar-protocol
409                  * for details. */
410                 printf("{\"version\":1}\n[\n");
411                 fflush(stdout);
412                 yajl_gen_array_open(json_gen);
413                 yajl_gen_clear(json_gen);
414         }
415         if (output_format == O_TERM) {
416                 /* Save the cursor-position and hide the cursor */
417                 printf("\033[s\033[?25l");
418                 /* Undo at exit */
419                 atexit(&reset_cursor);
420         }
421
422         if ((general_socket = socket(AF_INET, SOCK_DGRAM, 0)) == -1)
423                 die("Could not create socket\n");
424
425         int interval = cfg_getint(cfg_general, "interval");
426
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. */
433         char buffer[4096];
434
435         while (1) {
436                 if (exit_upon_signal) {
437                         fprintf(stderr, "Exiting due to signal.\n");
438                         exit(1);
439                 }
440                 struct timeval tv;
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 */
446                         printf("\033[u");
447                 for (j = 0; j < cfg_size(cfg, "order"); j++) {
448                         if (j > 0)
449                                 print_seperator();
450
451                         const char *current = cfg_getnstr(cfg, "order", j);
452
453                         CASE_SEC("ipv6") {
454                                 SEC_OPEN_MAP("ipv6");
455                                 print_ipv6_info(json_gen, buffer, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
456                                 SEC_CLOSE_MAP;
457                         }
458
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"));
462                                 SEC_CLOSE_MAP;
463                         }
464
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"));
468                                 SEC_CLOSE_MAP;
469                         }
470
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"));
474                                 SEC_CLOSE_MAP;
475                         }
476
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"));
480                                 SEC_CLOSE_MAP;
481                         }
482
483                         CASE_SEC_TITLE("disk") {
484                                 SEC_OPEN_MAP("disk_info");
485                                 print_disk_info(json_gen, buffer, title, cfg_getstr(sec, "format"));
486                                 SEC_CLOSE_MAP;
487                         }
488
489                         CASE_SEC("load") {
490                                 SEC_OPEN_MAP("load");
491                                 print_load(json_gen, buffer, cfg_getstr(sec, "format"), cfg_getint(sec, "max_threshold"));
492                                 SEC_CLOSE_MAP;
493                         }
494
495                         CASE_SEC("time") {
496                                 SEC_OPEN_MAP("time");
497                                 print_time(json_gen, buffer, cfg_getstr(sec, "format"), NULL, tv.tv_sec);
498                                 SEC_CLOSE_MAP;
499                         }
500
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);
504                                 SEC_CLOSE_MAP;
505                         }
506
507                         CASE_SEC("ddate") {
508                                 SEC_OPEN_MAP("ddate");
509                                 print_ddate(json_gen, buffer, cfg_getstr(sec, "format"), tv.tv_sec);
510                                 SEC_CLOSE_MAP;
511                         }
512
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"));
519                                 SEC_CLOSE_MAP;
520                         }
521
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"));
525                                 SEC_CLOSE_MAP;
526                         }
527
528                         CASE_SEC("cpu_usage") {
529                                 SEC_OPEN_MAP("cpu_usage");
530                                 print_cpu_usage(json_gen, buffer, cfg_getstr(sec, "format"));
531                                 SEC_CLOSE_MAP;
532                         }
533                 }
534                 if (output_format == O_I3BAR) {
535                         yajl_gen_array_close(json_gen);
536                         const unsigned char *buf;
537 #if YAJL_MAJOR >= 2
538                         size_t len;
539 #else
540                         unsigned int len;
541 #endif
542                         yajl_gen_get_buf(json_gen, &buf, &len);
543                         write(STDOUT_FILENO, buf, len);
544                         yajl_gen_clear(json_gen);
545                 }
546
547                 printf("\n");
548                 fflush(stdout);
549
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(&current_timeval, NULL);
557                 struct timespec ts = {interval - 1 - (current_timeval.tv_sec % interval), (10e5 - current_timeval.tv_usec) * 1000};
558                 nanosleep(&ts, NULL);
559         }
560 }