2 * Generates a status line for use with wmii or other minimal window managers
5 * Copyright (c) 2008-2009 Michael Stapelberg and contributors
8 * Redistribution and use in source and binary forms, with or without modification,
9 * are permitted provided that the following conditions are met:
11 * * Redistributions of source code must retain the above copyright notice, this
12 * list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright notice, this
15 * list of conditions and the following disclaimer in the documentation and/or other
16 * materials provided with the distribution.
18 * * Neither the name of Michael Stapelberg nor the names of contributors
19 * may be used to endorse or promote products derived from this software without
20 * specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
23 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25 * SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
27 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
34 #include <sys/types.h>
47 #include <sys/ioctl.h>
48 #include <sys/socket.h>
49 #include <netinet/in.h>
50 #include <arpa/inet.h>
56 #include <linux/ethtool.h>
57 #include <linux/sockios.h>
59 /* TODO: correctly check for *BSD */
60 #include <sys/param.h>
61 #include <sys/sysctl.h>
62 #include <sys/resource.h>
65 #define _IS_WMIISTATUS_C
66 #include "wmiistatus.h"
67 #undef _IS_WMIISTATUS_C
69 /* socket file descriptor for general purposes */
70 static int general_socket;
72 static const char *wlan_interface;
73 static const char *eth_interface;
74 static char *wmii_path;
75 static const char *time_format;
76 static const char *battery_path;
77 static bool use_colors;
78 static bool get_ethspeed;
79 static const char *wmii_normcolors = "#222222 #333333";
80 static char order[MAX_ORDER][2];
81 static const char **run_watches;
82 static unsigned int num_run_watches;
83 static unsigned int interval = 1;
86 * This function just concats two strings in place, it should only be used
87 * for concatting order to the name of a file or concatting color codes.
88 * Otherwise, the buffer size would have to be increased.
91 static char *concat(const char *str1, const char *str2) {
92 static char concatbuf[32];
93 (void)snprintf(concatbuf, sizeof(concatbuf), "%s%s", str1, str2);
98 * Cleans wmii's /rbar directory by deleting all regular files
101 static void cleanup_rbar_dir() {
104 char pathbuf[strlen(wmii_path)+256+1];
106 if ((dir = opendir(wmii_path)) == NULL)
109 while ((ent = readdir(dir)) != NULL) {
110 if (ent->d_type == DT_REG) {
111 (void)snprintf(pathbuf, sizeof(pathbuf), "%s%s", wmii_path, ent->d_name);
112 if (unlink(pathbuf) == -1)
121 * Creates the specified file in wmii's /rbar directory with
122 * correct modes and initializes colors if colormode is enabled
125 static void create_file(const char *name) {
126 char pathbuf[strlen(wmii_path)+256+1];
128 int flags = O_CREAT | O_WRONLY;
131 (void)snprintf(pathbuf, sizeof(pathbuf), "%s%s", wmii_path, name);
133 /* Overwrite file's contents if it exists */
134 if (stat(pathbuf, &statbuf) >= 0)
137 if ((fd = open(pathbuf, flags, S_IRUSR | S_IWUSR)) < 0)
140 char *tmp = concat("#888888 ", wmii_normcolors);
141 if (write(fd, tmp, strlen(tmp)) != (ssize_t)strlen(tmp))
148 * Waits until wmii_path/rbar exists (= the filesystem gets mounted),
149 * cleans up all files and creates the needed files
152 static void setup(void) {
157 /* Wait until wmii_path/rbar exists */
158 for (; stat(wmii_path, &statbuf) < 0; sleep(interval));
162 create_file(concat(order[ORDER_WLAN],"wlan"));
164 create_file(concat(order[ORDER_ETH],"eth"));
166 create_file(concat(order[ORDER_BATTERY],"battery"));
167 create_file(concat(order[ORDER_LOAD],"load"));
169 create_file(concat(order[ORDER_TIME],"time"));
170 for (i = 0; i < num_run_watches; i += 2) {
171 snprintf(pathbuf, sizeof(pathbuf), "%s%s", order[ORDER_RUN], run_watches[i]);
172 create_file(pathbuf);
177 * Writes the given message in the corresponding file in wmii's /rbar directory
180 static void write_to_statusbar(const char *name, const char *message) {
181 char pathbuf[strlen(wmii_path)+256+1];
184 (void)snprintf(pathbuf, sizeof(pathbuf), "%s%s", wmii_path, name);
185 if ((fd = open(pathbuf, O_RDWR)) == -1) {
186 /* Try to re-setup stuff and just continue */
190 if (write(fd, message, strlen(message)) != (ssize_t)strlen(message))
196 * Writes an errormessage to statusbar
199 static void write_error_to_statusbar(const char *message) {
201 create_file("error");
202 write_to_statusbar("error", message);
206 * Write errormessage to statusbar and exit
209 void die(const char *fmt, ...) {
210 if (wmii_path != NULL) {
214 (void)vsnprintf(buffer, sizeof(buffer), fmt, ap);
217 write_error_to_statusbar(buffer);
223 * Skip the given character for exactly 'amount' times, returns
224 * a pointer to the first non-'character' character in 'input'.
227 static char *skip_character(char *input, char character, int amount) {
229 size_t len = strlen(input);
232 for (walk = input; ((size_t)(walk - input) < len) && (blanks < amount); walk++)
233 if (*walk == character)
236 return (walk == input ? walk : walk-1);
240 * Get battery information from /sys. Note that it uses the design capacity to
241 * calculate the percentage, not the last full capacity, so you can see how
242 * worn off your battery is.
245 static char *get_battery_info() {
247 static char part[512];
250 int full_design = -1,
253 charging_status_t status = CS_DISCHARGING;
255 if ((fd = open(battery_path, O_RDONLY)) == -1)
256 return "No battery found";
258 memset(part, 0, sizeof(part));
259 (void)read(fd, buf, sizeof(buf));
260 for (walk = buf, last = buf; (walk-buf) < 1024; walk++)
262 if (BEGINS_WITH(last, "POWER_SUPPLY_ENERGY_FULL_DESIGN") ||
263 BEGINS_WITH(last, "POWER_SUPPLY_CHARGE_FULL_DESIGN"))
264 full_design = atoi(walk+1);
265 else if (BEGINS_WITH(last, "POWER_SUPPLY_ENERGY_NOW") ||
266 BEGINS_WITH(last, "POWER_SUPPLY_CHARGE_NOW"))
267 remaining = atoi(walk+1);
268 else if (BEGINS_WITH(last, "POWER_SUPPLY_CURRENT_NOW"))
269 present_rate = atoi(walk+1);
270 else if (BEGINS_WITH(last, "POWER_SUPPLY_STATUS=Charging"))
271 status = CS_CHARGING;
272 else if (BEGINS_WITH(last, "POWER_SUPPLY_STATUS=Full"))
274 } else if (*walk == '\n')
278 if ((full_design != -1) && (remaining != -1) && (present_rate != -1)) {
279 float remaining_time;
280 int seconds, hours, minutes;
281 if (status == CS_CHARGING)
282 remaining_time = ((float)full_design - (float)remaining) / (float)present_rate;
283 else if (status == CS_DISCHARGING)
284 remaining_time = ((float)remaining / (float)present_rate);
285 else remaining_time = 0;
287 seconds = (int)(remaining_time * 3600.0);
288 hours = seconds / 3600;
289 seconds -= (hours * 3600);
290 minutes = seconds / 60;
291 seconds -= (minutes * 60);
293 (void)snprintf(part, sizeof(part), "%s %.02f%% %02d:%02d:%02d",
294 (status == CS_CHARGING ? "CHR" :
295 (status == CS_DISCHARGING ? "BAT" : "FULL")),
296 (((float)remaining / (float)full_design) * 100),
297 hours, minutes, seconds);
303 * Return the IP address for the given interface or "no IP" if the
304 * interface is up and running but hasn't got an IP address yet
307 static const char *get_ip_address(const char *interface) {
308 static char part[512];
310 struct sockaddr_in addr;
311 socklen_t len = sizeof(struct sockaddr_in);
312 memset(part, 0, sizeof(part));
314 (void)strcpy(ifr.ifr_name, interface);
315 ifr.ifr_addr.sa_family = AF_INET;
316 if (ioctl(general_socket, SIOCGIFADDR, &ifr) < 0)
319 memcpy(&addr, &ifr.ifr_addr, len);
320 (void)inet_ntop(AF_INET, &addr.sin_addr.s_addr, part, len);
321 if (strlen(part) == 0)
322 (void)snprintf(part, sizeof(part), "no IP");
328 * Just parses /proc/net/wireless looking for lines beginning with
329 * wlan_interface, extracting the quality of the link and adding the
330 * current IP address of wlan_interface.
333 static char *get_wireless_info() {
335 static char part[512];
338 memset(buf, 0, sizeof(buf));
339 memset(part, 0, sizeof(part));
341 if ((fd = open("/proc/net/wireless", O_RDONLY)) == -1)
342 die("Could not open /proc/net/wireless\n");
343 (void)read(fd, buf, sizeof(buf));
346 interfaces = skip_character(buf, '\n', 1) + 1;
347 while ((interfaces = skip_character(interfaces, '\n', 1)+1) < buf+strlen(buf)) {
348 while (isspace((int)*interfaces))
350 if (!BEGINS_WITH(interfaces, wlan_interface))
353 if (sscanf(interfaces, "%*[^:]: 0000 %d", &quality) != 1)
355 if ((quality == UCHAR_MAX) || (quality == 0)) {
357 (void)snprintf(part, sizeof(part), "%s%s",
358 concat("#FF0000 ", wmii_normcolors), " W: down");
359 else (void)snprintf(part, sizeof(part), "W: down");
360 } else (void)snprintf(part, sizeof(part), "W: (%03d%%) %s",
361 quality, get_ip_address(wlan_interface));
369 * Combines ethernet IP addresses and speed (if requested) for displaying
372 static char *get_eth_info() {
373 static char part[512];
374 const char *ip_address = get_ip_address(eth_interface);
379 /* This code path requires root privileges */
381 struct ethtool_cmd ecmd;
383 ecmd.cmd = ETHTOOL_GSET;
384 (void)memset(&ifr, 0, sizeof(ifr));
385 ifr.ifr_data = (caddr_t)&ecmd;
386 (void)strcpy(ifr.ifr_name, eth_interface);
387 if (ioctl(general_socket, SIOCETHTOOL, &ifr) == 0)
388 ethspeed = (ecmd.speed == USHRT_MAX ? 0 : ecmd.speed);
389 else get_ethspeed = false;
393 if (ip_address == NULL)
394 (void)snprintf(part, sizeof(part), "E: down");
397 (void)snprintf(part, sizeof(part), "E: %s (%d Mbit/s)", ip_address, ethspeed);
398 else (void)snprintf(part, sizeof(part), "E: %s", ip_address);
405 * Checks if the PID in path is still valid by checking:
406 * (Linux) if /proc/<pid> exists
407 * (NetBSD) if sysctl returns process infos for this pid
410 static bool process_runs(const char *path) {
412 static glob_t globbuf;
414 memset(pidbuf, 0, sizeof(pidbuf));
416 if (glob(path, GLOB_NOCHECK | GLOB_TILDE, NULL, &globbuf) < 0)
417 die("glob() failed\n");
418 fd = open((globbuf.gl_pathc > 0 ? globbuf.gl_pathv[0] : path), O_RDONLY);
422 (void)read(fd, pidbuf, sizeof(pidbuf));
428 (void)snprintf(procbuf, sizeof(procbuf), "/proc/%ld", strtol(pidbuf, NULL, 10));
429 return (stat(procbuf, &statbuf) >= 0);
431 /* TODO: correctly check for NetBSD. Evaluate if this runs on OpenBSD/FreeBSD */
432 struct kinfo_proc info;
433 size_t length = sizeof(struct kinfo_proc);
434 int mib[4] = { CTL_KERN, KERN_PROC, KERN_PROC_PID, strtol(pidbuf, NULL, 10) };
435 if (sysctl(mib, 4, &info, &length, NULL, 0) < 0)
437 return (length != 0);
442 * Reads the configuration from the given file
445 static int load_configuration(const char *configfile) {
446 #define OPT(x) else if (strcasecmp(dest_name, x) == 0)
448 /* check if the file exists */
450 if (stat(configfile, &buf) < 0)
454 FILE *handle = fopen(configfile, "r");
456 die("Could not open configfile\n");
457 char dest_name[512], dest_value[512], whole_buffer[1026];
459 while (!feof(handle)) {
461 if ((ret = fgets(whole_buffer, 1024, handle)) == whole_buffer) {
462 /* sscanf implicitly strips whitespace */
463 if (sscanf(whole_buffer, "%s %[^\n]", dest_name, dest_value) < 1)
465 } else if (ret != NULL)
466 die("Could not read line in configuration file\n");
468 /* skip comments and empty lines */
469 if (dest_name[0] == '#' || strlen(dest_name) < 3)
473 wlan_interface = strdup(dest_value);
475 eth_interface = strdup(dest_value);
477 time_format = strdup(dest_value);
479 battery_path = strdup(dest_value);
485 wmii_normcolors = strdup(dest_value);
487 interval = atoi(dest_value);
490 static glob_t globbuf;
491 if (glob(dest_value, GLOB_NOCHECK | GLOB_TILDE, NULL, &globbuf) < 0)
492 die("glob() failed\n");
493 wmii_path = strdup(globbuf.gl_pathc > 0 ? globbuf.gl_pathv[0] : dest_value);
496 if ((stat(wmii_path, &stbuf)) == -1) {
497 fprintf(stderr, "Warning: wmii_path contains an invalid path\n");
499 wmii_path = strdup(dest_value);
501 if (wmii_path[strlen(wmii_path)-1] != '/')
502 die("wmii_path is not terminated by /\n");
506 char *name = strdup(dest_value);
511 num_run_watches += 2;
512 run_watches = realloc(run_watches, sizeof(char*) * num_run_watches);
513 run_watches[num_run_watches-2] = name;
514 run_watches[num_run_watches-1] = path;
518 #define SET_ORDER(opt, idx) { if (strcasecmp(token, opt) == 0) sprintf(order[idx], "%d", c++); }
521 walk = token = dest_value;
522 while (*walk != '\0') {
523 while ((*walk != ',') && (*walk != '\0'))
526 SET_ORDER("run", ORDER_RUN);
527 SET_ORDER("wlan", ORDER_WLAN);
528 SET_ORDER("eth", ORDER_ETH);
529 SET_ORDER("battery", ORDER_BATTERY);
530 SET_ORDER("load", ORDER_LOAD);
531 SET_ORDER("time", ORDER_TIME);
533 while (isspace((int)(*token)))
540 die("Unknown configfile option: %s\n", dest_name);
545 if (wmii_path == NULL)
551 int main(int argc, char *argv[]) {
556 char *configfile = PREFIX "/etc/wmiistatus.conf";
557 int o, option_index = 0;
558 struct option long_options[] = {
559 {"config", required_argument, 0, 'c'},
560 {"help", no_argument, 0, 'h'},
564 while ((o = getopt_long(argc, argv, "c:h", long_options, &option_index)) != -1)
567 else if ((char)o == 'h') {
568 printf("wmiistatus (c) 2008-2009 Michael Stapelberg\n"
569 "Syntax: %s [-c <configfile>]\n", argv[0]);
573 if (load_configuration(configfile) < 0)
578 if ((general_socket = socket(AF_INET, SOCK_DGRAM, 0)) == -1)
579 die("Could not create socket\n");
582 for (i = 0; i < num_run_watches; i += 2) {
583 bool running = process_runs(run_watches[i+1]);
585 snprintf(part, sizeof(part), "%s %s: %s",
587 concat("#00FF00 ", wmii_normcolors) :
588 concat("#FF0000 ", wmii_normcolors)),
590 (running ? "yes" : "no"));
591 else snprintf(part, sizeof(part), "%s: %s", run_watches[i], (running ? "yes" : "no"));
592 snprintf(pathbuf, sizeof(pathbuf), "%s%s", order[ORDER_RUN], run_watches[i]);
593 write_to_statusbar(pathbuf, part);
597 write_to_statusbar(concat(order[ORDER_WLAN], "wlan"), get_wireless_info());
599 write_to_statusbar(concat(order[ORDER_ETH], "eth"), get_eth_info());
601 write_to_statusbar(concat(order[ORDER_BATTERY], "battery"), get_battery_info());
606 if ((load_avg = open("/proc/loadavg", O_RDONLY)) == -1)
607 die("Could not open /proc/loadavg\n");
608 (void)read(load_avg, part, sizeof(part));
609 (void)close(load_avg);
610 *skip_character(part, ' ', 3) = '\0';
612 /* TODO: correctly check for NetBSD, check if it works the same on *BSD */
614 size_t length = sizeof(struct loadavg);
615 int mib[2] = { CTL_VM, VM_LOADAVG };
616 if (sysctl(mib, 2, &load, &length, NULL, 0) < 0)
617 die("Could not sysctl({ CTL_VM, VM_LOADAVG })\n");
618 double scale = load.fscale;
619 (void)snprintf(part, sizeof(part), "%.02f %.02f %.02f",
620 (double)load.ldavg[0] / scale,
621 (double)load.ldavg[1] / scale,
622 (double)load.ldavg[2] / scale);
624 write_to_statusbar(concat(order[ORDER_LOAD], "load"), part);
627 /* Get date & time */
628 time_t current_time = time(NULL);
629 struct tm *current_tm = localtime(¤t_time);
630 (void)strftime(part, sizeof(part), time_format, current_tm);
631 write_to_statusbar(concat(order[ORDER_TIME], "time"), part);