git.sur5r.net Git - i3/i3status/blob - 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 cfg_t *cfg, *cfg_general, *cfg_section;
  49
  50 /*
  51  * Exit upon SIGPIPE because when we have nowhere to write to, gathering
  52  * system information is pointless.
  53  *
  54  */
  55 void sigpipe(int signum) {
  56         fprintf(stderr, "Received SIGPIPE, exiting\n");
  57         exit(1);
  58 }
  59
  60 /*
  61  * Checks if the given path exists by calling stat().
  62  *
  63  */
  64 static bool path_exists(const char *path) {
  65         struct stat buf;
  66         return (stat(path, &buf) == 0);
  67 }
  68
  69 static void *scalloc(size_t size) {
  70         void *result = calloc(size, 1);
  71         exit_if_null(result, "Error: out of memory (calloc(%zd))\n", size);
  72         return result;
  73 }
  74
  75 static char *sstrdup(const char *str) {
  76         char *result = strdup(str);
  77         exit_if_null(result, "Error: out of memory (strdup())\n");
  78         return result;
  79 }
  80
  81
  82 /*
  83  * Validates a color in "#RRGGBB" format
  84  *
  85  */
  86 static int valid_color(const char *value)
  87 {
  88         if (strlen(value) != 7) return 0;
  89         if (value[0] != '#') return 0;
  90         for (int i = 1; i < 7; ++i) {
  91                 if (value[i] >= '0' && value[i] <= '9') continue;
  92                 if (value[i] >= 'a' && value[i] <= 'f') continue;
  93                 if (value[i] >= 'A' && value[i] <= 'F') continue;
  94                 return 0;
  95         }
  96         return 1;
  97 }
  98
  99 /*
 100  * This function resolves ~ in pathnames.
 101  * It may resolve wildcards in the first part of the path, but if no match
 102  * or multiple matches are found, it just returns a copy of path as given.
 103  *
 104  */
 105 static char *resolve_tilde(const char *path) {
 106         static glob_t globbuf;
 107         char *head, *tail, *result = NULL;
 108
 109         tail = strchr(path, '/');
 110         head = strndup(path, tail ? (size_t)(tail - path) : strlen(path));
 111
 112         int res = glob(head, GLOB_TILDE, NULL, &globbuf);
 113         free(head);
 114         /* no match, or many wildcard matches are bad */
 115         if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
 116                 result = sstrdup(path);
 117         else if (res != 0) {
 118                 die("glob() failed");
 119         } else {
 120                 head = globbuf.gl_pathv[0];
 121                 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
 122                 strncpy(result, head, strlen(head));
 123                 if (tail)
 124                         strncat(result, tail, strlen(tail));
 125         }
 126         globfree(&globbuf);
 127
 128         return result;
 129 }
 130
 131 static char *get_config_path(void) {
 132         char *xdg_config_home, *xdg_config_dirs, *config_path;
 133
 134         /* 1: check the traditional path under the home directory */
 135         config_path = resolve_tilde("~/.i3status.conf");
 136         if (path_exists(config_path))
 137                 return config_path;
 138
 139         /* 2: check for $XDG_CONFIG_HOME/i3status/config */
 140         if ((xdg_config_home = getenv("XDG_CONFIG_HOME")) == NULL)
 141                 xdg_config_home = "~/.config";
 142
 143         xdg_config_home = resolve_tilde(xdg_config_home);
 144         if (asprintf(&config_path, "%s/i3status/config", xdg_config_home) == -1)
 145                 die("asprintf() failed");
 146         free(xdg_config_home);
 147
 148         if (path_exists(config_path))
 149                 return config_path;
 150         free(config_path);
 151
 152         /* 3: check the traditional path under /etc */
 153         config_path = SYSCONFDIR "/i3status.conf";
 154         if (path_exists(config_path))
 155             return sstrdup(config_path);
 156
 157         /* 4: check for $XDG_CONFIG_DIRS/i3status/config */
 158         if ((xdg_config_dirs = getenv("XDG_CONFIG_DIRS")) == NULL)
 159                 xdg_config_dirs = "/etc/xdg";
 160
 161         char *buf = strdup(xdg_config_dirs);
 162         char *tok = strtok(buf, ":");
 163         while (tok != NULL) {
 164                 tok = resolve_tilde(tok);
 165                 if (asprintf(&config_path, "%s/i3status/config", tok) == -1)
 166                         die("asprintf() failed");
 167                 free(tok);
 168                 if (path_exists(config_path)) {
 169                         free(buf);
 170                         return config_path;
 171                 }
 172                 free(config_path);
 173                 tok = strtok(NULL, ":");
 174         }
 175         free(buf);
 176
 177         die("Unable to find the configuration file (looked at "
 178                 "~/.i3status.conf, $XDG_CONFIG_HOME/i3status/config, "
 179                 "/etc/i3status.conf and $XDG_CONFIG_DIRS/i3status/config)");
 180         return NULL;
 181 }
 182
 183 int main(int argc, char *argv[]) {
 184         unsigned int j;
 185
 186         cfg_opt_t general_opts[] = {
 187                 CFG_STR("output_format", "auto", CFGF_NONE),
 188                 CFG_BOOL("colors", 1, CFGF_NONE),
 189                 CFG_STR("color_separator", "#333333", CFGF_NONE),
 190                 CFG_INT("interval", 1, CFGF_NONE),
 191                 CFG_COLOR_OPTS("#00FF00", "#FFFF00", "#FF0000"),
 192                 CFG_END()
 193         };
 194
 195         cfg_opt_t run_watch_opts[] = {
 196                 CFG_STR("pidfile", NULL, CFGF_NONE),
 197                 CFG_STR("format", "%title: %status", CFGF_NONE),
 198                 CFG_CUSTOM_COLOR_OPTS,
 199                 CFG_END()
 200         };
 201
 202         cfg_opt_t wireless_opts[] = {
 203                 CFG_STR("format_up", "W: (%quality at %essid, %bitrate) %ip", CFGF_NONE),
 204                 CFG_STR("format_down", "W: down", CFGF_NONE),
 205                 CFG_CUSTOM_COLOR_OPTS,
 206                 CFG_END()
 207         };
 208
 209         cfg_opt_t ethernet_opts[] = {
 210                 CFG_STR("format_up", "E: %ip (%speed)", CFGF_NONE),
 211                 CFG_STR("format_down", "E: down", CFGF_NONE),
 212                 CFG_CUSTOM_COLOR_OPTS,
 213                 CFG_END()
 214         };
 215
 216         cfg_opt_t ipv6_opts[] = {
 217                 CFG_STR("format_up", "%ip", CFGF_NONE),
 218                 CFG_STR("format_down", "no IPv6", CFGF_NONE),
 219                 CFG_CUSTOM_COLOR_OPTS,
 220                 CFG_END()
 221         };
 222
 223         cfg_opt_t battery_opts[] = {
 224                 CFG_STR("format", "%status %percentage %remaining", CFGF_NONE),
 225                 CFG_STR("path", "/sys/class/power_supply/BAT%d/uevent", CFGF_NONE),
 226                 CFG_INT("low_threshold", 30, CFGF_NONE),
 227                 CFG_STR("threshold_type", "time", CFGF_NONE),
 228                 CFG_BOOL("last_full_capacity", false, CFGF_NONE),
 229                 CFG_END()
 230         };
 231
 232         cfg_opt_t time_opts[] = {
 233                 CFG_STR("format", "%d.%m.%Y %H:%M:%S", CFGF_NONE),
 234                 CFG_END()
 235         };
 236
 237         cfg_opt_t ddate_opts[] = {
 238                 CFG_STR("format", "%{%a, %b %d%}, %Y%N - %H", CFGF_NONE),
 239                 CFG_END()
 240         };
 241
 242         cfg_opt_t load_opts[] = {
 243                 CFG_STR("format", "%1min %5min %15min", CFGF_NONE),
 244                 CFG_END()
 245         };
 246
 247         cfg_opt_t usage_opts[] = {
 248                 CFG_STR("format", "%usage", CFGF_NONE),
 249                 CFG_END()
 250         };
 251
 252         cfg_opt_t temp_opts[] = {
 253                 CFG_STR("format", "%degrees C", CFGF_NONE),
 254                 CFG_STR("path", NULL, CFGF_NONE),
 255                 CFG_INT("max_threshold", 75, CFGF_NONE),
 256                 CFG_END()
 257         };
 258
 259         cfg_opt_t disk_opts[] = {
 260                 CFG_STR("format", "%free", CFGF_NONE),
 261                 CFG_END()
 262         };
 263
 264         cfg_opt_t volume_opts[] = {
 265                 CFG_STR("format", "♪: %volume", CFGF_NONE),
 266                 CFG_STR("device", "default", CFGF_NONE),
 267                 CFG_STR("mixer", "Master", CFGF_NONE),
 268                 CFG_INT("mixer_idx", 0, CFGF_NONE),
 269                 CFG_CUSTOM_COLOR_OPTS,
 270                 CFG_END()
 271         };
 272
 273         cfg_opt_t opts[] = {
 274                 CFG_STR_LIST("order", "{}", CFGF_NONE),
 275                 CFG_SEC("general", general_opts, CFGF_NONE),
 276                 CFG_SEC("run_watch", run_watch_opts, CFGF_TITLE | CFGF_MULTI),
 277                 CFG_SEC("wireless", wireless_opts, CFGF_TITLE | CFGF_MULTI),
 278                 CFG_SEC("ethernet", ethernet_opts, CFGF_TITLE | CFGF_MULTI),
 279                 CFG_SEC("battery", battery_opts, CFGF_TITLE | CFGF_MULTI),
 280                 CFG_SEC("cpu_temperature", temp_opts, CFGF_TITLE | CFGF_MULTI),
 281                 CFG_SEC("disk", disk_opts, CFGF_TITLE | CFGF_MULTI),
 282                 CFG_SEC("volume", volume_opts, CFGF_TITLE | CFGF_MULTI),
 283                 CFG_SEC("ipv6", ipv6_opts, CFGF_NONE),
 284                 CFG_SEC("time", time_opts, CFGF_NONE),
 285                 CFG_SEC("ddate", ddate_opts, CFGF_NONE),
 286                 CFG_SEC("load", load_opts, CFGF_NONE),
 287                 CFG_SEC("cpu_usage", usage_opts, CFGF_NONE),
 288                 CFG_CUSTOM_COLOR_OPTS,
 289                 CFG_END()
 290         };
 291
 292         char *configfile = NULL;
 293         int o, option_index = 0;
 294         struct option long_options[] = {
 295                 {"config", required_argument, 0, 'c'},
 296                 {"help", no_argument, 0, 'h'},
 297                 {"version", no_argument, 0, 'v'},
 298                 {0, 0, 0, 0}
 299         };
 300
 301         struct sigaction action;
 302         memset(&action, 0, sizeof(struct sigaction));
 303         action.sa_handler = sigpipe;
 304         sigaction(SIGPIPE, &action, NULL);
 305
 306         if (setlocale(LC_ALL, "") == NULL)
 307                 die("Could not set locale. Please make sure all your LC_* / LANG settings are correct.");
 308
 309         while ((o = getopt_long(argc, argv, "c:hv", long_options, &option_index)) != -1)
 310                 if ((char)o == 'c')
 311                         configfile = optarg;
 312                 else if ((char)o == 'h') {
 313                         printf("i3status " VERSION " © 2008-2012 Michael Stapelberg and contributors\n"
 314                                 "Syntax: %s [-c <configfile>] [-h] [-v]\n", argv[0]);
 315                         return 0;
 316                 } else if ((char)o == 'v') {
 317                         printf("i3status " VERSION " © 2008-2012 Michael Stapelberg and contributors\n");
 318                         return 0;
 319                 }
 320
 321
 322         if (configfile == NULL)
 323                 configfile = get_config_path();
 324
 325         cfg = cfg_init(opts, CFGF_NOCASE);
 326         if (cfg_parse(cfg, configfile) == CFG_PARSE_ERROR)
 327                 return EXIT_FAILURE;
 328
 329         if (cfg_size(cfg, "order") == 0)
 330                 die("Your 'order' array is empty. Please fix your config.\n");
 331
 332         cfg_general = cfg_getsec(cfg, "general");
 333         if (cfg_general == NULL)
 334                 die("Could not get section \"general\"\n");
 335
 336         char *output_str = cfg_getstr(cfg_general, "output_format");
 337         if (strcasecmp(output_str, "auto") == 0) {
 338                 fprintf(stderr, "i3status: trying to auto-detect output_format setting\n");
 339                 output_str = auto_detect_format();
 340                 if (!output_str) {
 341                         output_str = "none";
 342                         fprintf(stderr, "i3status: falling back to \"none\"\n");
 343                 } else {
 344                         fprintf(stderr, "i3status: auto-detected \"%s\"\n", output_str);
 345                 }
 346         }
 347
 348         if (strcasecmp(output_str, "dzen2") == 0)
 349                 output_format = O_DZEN2;
 350         else if (strcasecmp(output_str, "xmobar") == 0)
 351                 output_format = O_XMOBAR;
 352         else if (strcasecmp(output_str, "i3bar") == 0)
 353                 output_format = O_I3BAR;
 354         else if (strcasecmp(output_str, "none") == 0)
 355                 output_format = O_NONE;
 356         else die("Unknown output format: \"%s\"\n", output_str);
 357
 358         if (!valid_color(cfg_getstr(cfg_general, "color_good"))
 359                         || !valid_color(cfg_getstr(cfg_general, "color_degraded"))
 360                         || !valid_color(cfg_getstr(cfg_general, "color_bad"))
 361                         || !valid_color(cfg_getstr(cfg_general, "color_separator")))
 362                die("Bad color format");
 363
 364 #if YAJL_MAJOR >= 2
 365         yajl_gen json_gen = yajl_gen_alloc(NULL);
 366 #else
 367         yajl_gen json_gen = yajl_gen_alloc(NULL, NULL);
 368 #endif
 369
 370         if (output_format == O_I3BAR) {
 371                 /* Initialize the i3bar protocol. See i3/docs/i3bar-protocol
 372                  * for details. */
 373                 printf("{\"version\":1}\n[\n");
 374                 fflush(stdout);
 375                 yajl_gen_array_open(json_gen);
 376                 yajl_gen_clear(json_gen);
 377         }
 378
 379         if ((general_socket = socket(AF_INET, SOCK_DGRAM, 0)) == -1)
 380                 die("Could not create socket\n");
 381
 382         int interval = cfg_getint(cfg_general, "interval");
 383
 384         /* One memory page which each plugin can use to buffer output.
 385          * Even though it’s unclean, we just assume that the user will not
 386          * specify a format string which expands to something longer than 4096
 387          * bytes — given that the output of i3status is used to display
 388          * information on screen, more than 1024 characters for the full line
 389          * (!), not individual plugins, seem very unlikely. */
 390         char buffer[4096];
 391
 392         struct tm tm;
 393         while (1) {
 394                 struct timeval tv;
 395                 gettimeofday(&tv, NULL);
 396                 time_t current_time = tv.tv_sec;
 397                 struct tm *current_tm = NULL;
 398                 if (current_time != (time_t) -1) {
 399                         localtime_r(&current_time, &tm);
 400                         current_tm = &tm;
 401                 }
 402                 if (output_format == O_I3BAR)
 403                         yajl_gen_array_open(json_gen);
 404                 for (j = 0; j < cfg_size(cfg, "order"); j++) {
 405                         if (j > 0)
 406                                 print_seperator();
 407
 408                         const char *current = cfg_getnstr(cfg, "order", j);
 409
 410                         CASE_SEC("ipv6") {
 411                                 SEC_OPEN_MAP("ipv6");
 412                                 print_ipv6_info(json_gen, buffer, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
 413                                 SEC_CLOSE_MAP;
 414                         }
 415
 416                         CASE_SEC_TITLE("wireless") {
 417                                 SEC_OPEN_MAP("wireless");
 418                                 print_wireless_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
 419                                 SEC_CLOSE_MAP;
 420                         }
 421
 422                         CASE_SEC_TITLE("ethernet") {
 423                                 SEC_OPEN_MAP("ethernet");
 424                                 print_eth_info(json_gen, buffer, title, cfg_getstr(sec, "format_up"), cfg_getstr(sec, "format_down"));
 425                                 SEC_CLOSE_MAP;
 426                         }
 427
 428                         CASE_SEC_TITLE("battery") {
 429                                 SEC_OPEN_MAP("battery");
 430                                 print_battery_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"), cfg_getint(sec, "low_threshold"), cfg_getstr(sec, "threshold_type"), cfg_getbool(sec, "last_full_capacity"));
 431                                 SEC_CLOSE_MAP;
 432                         }
 433
 434                         CASE_SEC_TITLE("run_watch") {
 435                                 SEC_OPEN_MAP("run_watch");
 436                                 print_run_watch(json_gen, buffer, title, cfg_getstr(sec, "pidfile"), cfg_getstr(sec, "format"));
 437                                 SEC_CLOSE_MAP;
 438                         }
 439
 440                         CASE_SEC_TITLE("disk") {
 441                                 SEC_OPEN_MAP("disk_info");
 442                                 print_disk_info(json_gen, buffer, title, cfg_getstr(sec, "format"));
 443                                 SEC_CLOSE_MAP;
 444                         }
 445
 446                         CASE_SEC("load") {
 447                                 SEC_OPEN_MAP("load");
 448                                 print_load(json_gen, buffer, cfg_getstr(sec, "format"));
 449                                 SEC_CLOSE_MAP;
 450                         }
 451
 452                         CASE_SEC("time") {
 453                                 SEC_OPEN_MAP("time");
 454                                 print_time(json_gen, buffer, cfg_getstr(sec, "format"), current_tm);
 455                                 SEC_CLOSE_MAP;
 456                         }
 457
 458                         CASE_SEC("ddate") {
 459                                 SEC_OPEN_MAP("ddate");
 460                                 print_ddate(json_gen, buffer, cfg_getstr(sec, "format"), current_tm);
 461                                 SEC_CLOSE_MAP;
 462                         }
 463
 464                         CASE_SEC_TITLE("volume") {
 465                                 SEC_OPEN_MAP("volume");
 466                                 print_volume(json_gen, buffer, cfg_getstr(sec, "format"),
 467                                              cfg_getstr(sec, "device"),
 468                                              cfg_getstr(sec, "mixer"),
 469                                              cfg_getint(sec, "mixer_idx"));
 470                                 SEC_CLOSE_MAP;
 471                         }
 472
 473                         CASE_SEC_TITLE("cpu_temperature") {
 474                                 SEC_OPEN_MAP("cpu_temperature");
 475                                 print_cpu_temperature_info(json_gen, buffer, atoi(title), cfg_getstr(sec, "path"), cfg_getstr(sec, "format"), cfg_getint(sec, "max_threshold"));
 476                                 SEC_CLOSE_MAP;
 477                         }
 478
 479                         CASE_SEC("cpu_usage") {
 480                                 SEC_OPEN_MAP("cpu_usage");
 481                                 print_cpu_usage(json_gen, buffer, cfg_getstr(sec, "format"));
 482                                 SEC_CLOSE_MAP;
 483                         }
 484                 }
 485                 if (output_format == O_I3BAR) {
 486                         yajl_gen_array_close(json_gen);
 487                         const unsigned char *buf;
 488 #if YAJL_MAJOR >= 2
 489                         size_t len;
 490 #else
 491                         unsigned int len;
 492 #endif
 493                         yajl_gen_get_buf(json_gen, &buf, &len);
 494                         write(STDOUT_FILENO, buf, len);
 495                         yajl_gen_clear(json_gen);
 496                 }
 497
 498                 printf("\n");
 499                 fflush(stdout);
 500
 501                 /* To provide updates on every full second (as good as possible)
 502                  * we don’t use sleep(interval) but we sleep until the next
 503                  * second (with microsecond precision) plus (interval-1)
 504                  * seconds. */
 505                 struct timeval current_timeval;
 506                 gettimeofday(&current_timeval, NULL);
 507                 struct timespec ts = {interval - 1, (10e5 - current_timeval.tv_usec) * 1000};
 508                 nanosleep(&ts, NULL);
 509         }
 510 }