├── DEPENDS ├── .gitignore ├── config.sample ├── AUTHORS ├── src ├── thinkpad.h ├── console.h ├── xorg.h ├── shared.h ├── main.h ├── thinkpad.c ├── console.c ├── xorg.c └── main.c ├── Makefile ├── README.md ├── configure.sh └── COPYING /DEPENDS: -------------------------------------------------------------------------------- 1 | Require: 2 | libx11-dev 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | disk_indicator 2 | build/ 3 | *.o 4 | *.out 5 | -------------------------------------------------------------------------------- /config.sample: -------------------------------------------------------------------------------- 1 | led=x|scroll event=both device=sdb 2 | led=x|caps event=both device=sda 3 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Programming: 2 | Mladen Mijatov 3 | Justin Crawford 4 | -------------------------------------------------------------------------------- /src/thinkpad.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | #define THINKPAD_AVAILABLE 3 | 4 | #include "shared.h" 5 | 6 | #define THINKPAD_ACPI_DEVICE "/proc/acpi/ibm/led" 7 | 8 | 9 | typedef struct { 10 | char *led; 11 | int device; 12 | } ThinkpadConfig; 13 | 14 | 15 | void thinkpad_init(Indicator *indicator, char *led); 16 | void thinkpad_quit(Indicator *indicator); 17 | void thinkpad_turn_on(Indicator *indicator); 18 | void thinkpad_turn_off(Indicator *indicator); 19 | -------------------------------------------------------------------------------- /src/console.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | #define CONSOLE_AVAILABLE 3 | 4 | #include 5 | #include "shared.h" 6 | 7 | #define CONSOLE_CONFIG_FORMAT "%[^|]|%s" 8 | 9 | 10 | enum console_led { 11 | SCROLL_LOCK = LED_SCR, 12 | NUM_LOCK = LED_NUM, 13 | CAPS_LOCK = LED_CAP 14 | }; 15 | 16 | 17 | typedef struct { 18 | int device; 19 | enum console_led led; 20 | char tty[100]; 21 | } ConsoleConfig; 22 | 23 | 24 | void console_init(Indicator *indicator, char *config); 25 | void console_quit(Indicator *indicator); 26 | void console_turn_on(Indicator *indicator); 27 | void console_turn_off(Indicator *indicator); 28 | -------------------------------------------------------------------------------- /src/xorg.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | #define XORG_AVAILABLE 3 | 4 | #include 5 | #include 6 | #include "shared.h" 7 | 8 | 9 | enum xorg_led { 10 | XORG_CAPS_LOCK = 1, 11 | XORG_NUM_LOCK = 2, 12 | XORG_SCROLL_LOCK = 3 13 | }; 14 | 15 | 16 | typedef struct { 17 | Display *display; 18 | XKeyboardState *keyboard_state; 19 | 20 | bool initial_state; 21 | enum xorg_led flag_bit; 22 | } XOrgConfig; 23 | 24 | 25 | void xorg_init(Indicator *indicator, char *led); 26 | void xorg_quit(Indicator *indicator); 27 | void xorg_turn_on(Indicator *indicator); 28 | void xorg_turn_off(Indicator *indicator); 29 | -------------------------------------------------------------------------------- /src/shared.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | 3 | #include 4 | 5 | 6 | enum notify_method { 7 | X_ORG, 8 | CONSOLE, 9 | THINKPAD 10 | }; 11 | 12 | enum indicator_event { 13 | READ, 14 | WRITE, 15 | BOTH 16 | }; 17 | 18 | typedef struct Indicator { 19 | bool initialized; 20 | enum notify_method method; 21 | enum indicator_event event; 22 | char *device; 23 | 24 | // pointer to functions used for notifying user 25 | void (*turn_notification_on)(struct Indicator *indicator); 26 | void (*turn_notification_off)(struct Indicator *indicator); 27 | 28 | // pointer to method config 29 | char *config; 30 | 31 | // history 32 | unsigned long read_count; 33 | unsigned long write_count; 34 | } Indicator; 35 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PROJECT=disk_indicator 2 | COMPILER=c99 3 | LINK_FLAGS=-lm $(shell cat build/flags) 4 | COMPILE_FLAGS=-Wall -Wextra -pedantic -Werror -D _DEFAULT_SOURCE -O2 -march=native 5 | OBJECTS=$(shell cat build/objects) main.o 6 | 7 | all: $(PROJECT) 8 | 9 | debug: COMPILE_FLAGS += -g 10 | debug: $(PROJECT) 11 | 12 | .check-dependencies: 13 | ifeq ("$(realpath ./build/dependencies.h)","") 14 | $(error Missing dependencies file. To generate one, please run ./configure.sh) 15 | endif 16 | 17 | %.o: src/%.c src/%.h 18 | $(COMPILER) $(COMPILE_FLAGS) -c $< 19 | 20 | $(PROJECT): .check-dependencies $(OBJECTS) 21 | $(COMPILER) $(OBJECTS) $(LINK_FLAGS) -o $(PROJECT) 22 | 23 | clean: 24 | $(RM) -r build/ 25 | $(RM) $(PROJECT) *.o 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Disk-Indicator 2 | ============== 3 | 4 | Small program for Linux that will turn your `Scroll`, `Caps` or `Num Lock` LED or LED on your ThinkPad laptop into hard disk indicator. 5 | 6 | ### Usage 7 | 8 | `./disk_indicator [-f] [-c config.file]` 9 | 10 | - `-c` Load specified config. (default: ~/.disk-indicator) 11 | - `-f` Do not fork to background. 12 | 13 | ### Sample config file: 14 | ``` 15 | led=t|0 event=read device=sda 16 | led=c|tty1|caps event=write device=sda 17 | led=x|scroll event=both device=sda1 18 | ``` 19 | 20 | #### Config params: 21 | - `led=|` 22 | - Provider: Thinkpad (`t`), Console (`c`), XOrg (`x`) 23 | - Name: `0-15` (only Thinkpad provider), `caps`, `scroll`, `num` 24 | - `event=` - Type: `read`, `write`, `both` 25 | - `device=` - Name: eg. `sda1`, `sda`, `mmcblkp1` 26 | -------------------------------------------------------------------------------- /src/main.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | 3 | #include 4 | #include "shared.h" 5 | 6 | #define FILENAME "/proc/diskstats" 7 | #define STATS_FORMAT "%*d %*d %s %lu %*u %*u %*u %lu %*u %*u %*u %*u %*u %*u" 8 | #define CONFIG_FORMAT "led=%s event=%s device=%s" 9 | 10 | 11 | typedef struct { 12 | bool initialized; 13 | 14 | // statistics file handle 15 | int stats_file; 16 | 17 | // configured indicators 18 | Indicator *indicators[20]; 19 | int indicator_count; 20 | 21 | // timeouts measured in CPU cycles 22 | int check_interval; 23 | int power_on_interval; 24 | int power_off_interval; 25 | 26 | // method flags 27 | bool xorg_initialized; 28 | bool console_initialized; 29 | bool thinkpad_initialized; 30 | } Config; 31 | 32 | 33 | Config *config; 34 | 35 | Config *load_config(int argc, const char *argv[]); 36 | void unload_config(Config *config); 37 | unsigned int read_line(int file, char *line); 38 | bool open_stats_file(); 39 | void close_stats_file(); 40 | char set_keyboard_led(Config *config, unsigned char new_state); 41 | char get_led_state(Config *config, unsigned char *state); 42 | void get_disk_stats(void *data, unsigned int size); 43 | -------------------------------------------------------------------------------- /configure.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | function show_help { 4 | echo "Configure DiskIndicator provider support." 5 | echo -e "Usage: ./configre.sh [options]\n" 6 | echo "Options:" 7 | echo -e "\t-h, --help Show this text" 8 | echo -e "\t--xorg Include X.Org provider" 9 | echo -e "\t--console Include console provider" 10 | echo -e "\t--thinkpad Include ThinkPad provider" 11 | echo -e "\t--all Include all providers" 12 | exit 0 13 | } 14 | 15 | add_xorg=false 16 | add_console=false 17 | add_thinkpad=false 18 | 19 | # show help when no params are specified 20 | if [ $# = 0 ]; then 21 | show_help 22 | fi 23 | 24 | # process flags 25 | while test $# -gt 0; do 26 | case "$1" in 27 | -h|--help) 28 | show_help 29 | ;; 30 | --all) 31 | add_xorg=true 32 | add_console=true 33 | add_thinkpad=true 34 | shift 35 | ;; 36 | --xorg) 37 | add_xorg=true 38 | shift 39 | ;; 40 | --console) 41 | add_console=true 42 | shift 43 | ;; 44 | --thinkpad) 45 | add_thinkpad=true 46 | shift 47 | ;; 48 | *) 49 | echo "Came" 50 | break 51 | ;; 52 | esac 53 | done 54 | 55 | # clean up dependencies file 56 | mkdir -p build 57 | truncate --size=0 build/dependencies.h build/flags build/objects 58 | 59 | # include selected providers 60 | if $add_xorg; then 61 | echo -n "xorg.o " >> build/objects 62 | echo -n "-lX11 " >> build/flags 63 | echo "#include \"../src/xorg.h\"" >> build/dependencies.h 64 | fi 65 | 66 | if $add_console; then 67 | echo -n "console.o " >> build/objects 68 | echo "#include \"../src/console.h\"" >> build/dependencies.h 69 | fi 70 | 71 | if $add_thinkpad; then 72 | echo -n "thinkpad.o " >> build/objects 73 | echo "#include \"../src/thinkpad.h\"" >> build/dependencies.h 74 | fi 75 | -------------------------------------------------------------------------------- /src/thinkpad.c: -------------------------------------------------------------------------------- 1 | /** 2 | * Disk Indicator 0.2 3 | * Copyright © 2015. by Mladen Mijatov . 4 | * 5 | * Support for notifications using ThinkPad LEDs. 6 | * 7 | * This nifty little tool will turn your scroll lock (or some other LED) 8 | * into your disk activity indicator. Program must be started as root. 9 | * It had very little overhead and almost no CPU usage. 10 | * 11 | * Original idea and some code by Dan Stahlke . His 12 | * source code can be found here: http://www.stahlke.org/dan/hdd_led/ 13 | * 14 | * This program is free software: you can redistribute it and/or modify 15 | * it under the terms of the GNU General Public License as published by 16 | * the Free Software Foundation, either version 3 of the License, or 17 | * (at your option) any later version. 18 | * 19 | * This program is distributed in the hope that it will be useful, 20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | * GNU General Public License for more details. 23 | * 24 | * You should have received a copy of the GNU General Public License 25 | * along with this program. If not, see . 26 | */ 27 | 28 | #include 29 | #include 30 | #include 31 | #include 32 | #include 33 | 34 | #include "thinkpad.h" 35 | 36 | 37 | /** 38 | * Initialize ThinkPad notification support. 39 | */ 40 | void thinkpad_init(Indicator *indicator, char *led) 41 | { 42 | // allocate memory for configuration structure 43 | ThinkpadConfig *thinkpad_config = calloc(1, sizeof(ThinkpadConfig)); 44 | indicator->config = (char *) thinkpad_config; 45 | 46 | // default config 47 | thinkpad_config->led = calloc(1, strlen(led) + 1); 48 | strcpy(thinkpad_config->led, led); 49 | 50 | // open acpi device 51 | thinkpad_config->device = open(THINKPAD_ACPI_DEVICE, O_RDONLY); 52 | 53 | if (!thinkpad_config->device) 54 | indicator->initialized = false; else 55 | indicator->initialized = true; 56 | } 57 | 58 | /** 59 | * Free memory taken by ThinkPad notification support config. 60 | */ 61 | void thinkpad_quit(Indicator *indicator) 62 | { 63 | ThinkpadConfig *thinkpad_config = (ThinkpadConfig *) indicator->config; 64 | 65 | // free device 66 | if (indicator->initialized) { 67 | indicator->turn_notification_on(indicator); 68 | close(thinkpad_config->device); 69 | } 70 | 71 | // free memory 72 | free(thinkpad_config->led); 73 | free(thinkpad_config); 74 | } 75 | 76 | /** 77 | * Turn ThinkPad light on. 78 | */ 79 | void thinkpad_turn_on(Indicator *indicator) 80 | { 81 | ThinkpadConfig *thinkpad_config = (ThinkpadConfig *) indicator->config; 82 | 83 | // set new state 84 | write(thinkpad_config->device, thinkpad_config->led, strlen(thinkpad_config->led)); 85 | write(thinkpad_config->device, " on\n", 4); 86 | fsync(thinkpad_config->device); 87 | } 88 | 89 | /** 90 | * Turn ThinkPad light off. 91 | */ 92 | void thinkpad_turn_off(Indicator *indicator) 93 | { 94 | ThinkpadConfig *thinkpad_config = (ThinkpadConfig *) indicator->config; 95 | 96 | // set new state 97 | write(thinkpad_config->device, thinkpad_config->led, strlen(thinkpad_config->led)); 98 | write(thinkpad_config->device, " off\n", 5); 99 | fsync(thinkpad_config->device); 100 | } 101 | -------------------------------------------------------------------------------- /src/console.c: -------------------------------------------------------------------------------- 1 | /** 2 | * Disk Indicator 0.2 3 | * Copyright © 2015. by Mladen Mijatov . 4 | * 5 | * Support for notification using keyboard LEDs through 6 | * standard TTY interface. 7 | * 8 | * This nifty little tool will turn your scroll lock (or some other LED) 9 | * into your disk activity indicator. Program must be started as root. 10 | * It had very little overhead and almost no CPU usage. 11 | * 12 | * Original idea and some code by Dan Stahlke . His 13 | * source code can be found here: http://www.stahlke.org/dan/hdd_led/ 14 | * 15 | * This program is free software: you can redistribute it and/or modify 16 | * it under the terms of the GNU General Public License as published by 17 | * the Free Software Foundation, either version 3 of the License, or 18 | * (at your option) any later version. 19 | * 20 | * This program is distributed in the hope that it will be useful, 21 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 | * GNU General Public License for more details. 24 | * 25 | * You should have received a copy of the GNU General Public License 26 | * along with this program. If not, see . 27 | */ 28 | 29 | #include 30 | #include 31 | #include 32 | #include 33 | #include 34 | #include 35 | 36 | #include "console.h" 37 | 38 | /** 39 | * Initialize keyboard LED notification through TTY. 40 | */ 41 | void console_init(Indicator *indicator, char *config) 42 | { 43 | // allocate memory for configuration structure 44 | ConsoleConfig *console_config = malloc(sizeof(ConsoleConfig)); 45 | indicator->config = (char *) console_config; 46 | 47 | // parse config 48 | char device[10] = {0}; 49 | char led[10] = {0}; 50 | 51 | // get tty device 52 | console_config->tty[0] = '\0'; 53 | strcat(console_config->tty, "/dev/"); 54 | if (sscanf(config, CONSOLE_CONFIG_FORMAT, device, led) == 2) 55 | strcat(console_config->tty, device); else 56 | strcat(console_config->tty, "console"); 57 | 58 | // get led id 59 | if (strcmp(led, "scroll") == 0) { 60 | console_config->led = SCROLL_LOCK; 61 | } else if (strcmp(led, "num") == 0) { 62 | console_config->led = NUM_LOCK; 63 | } else { 64 | console_config->led = CAPS_LOCK; 65 | } 66 | 67 | // open console interface 68 | console_config->device = open(console_config->tty, O_RDWR); 69 | 70 | if (console_config->device == -1) 71 | indicator->initialized = false; else 72 | indicator->initialized = true; 73 | } 74 | 75 | /** 76 | * Clean up after us. 77 | */ 78 | void console_quit(Indicator *indicator) 79 | { 80 | ConsoleConfig *console_config = (ConsoleConfig *) indicator->config; 81 | 82 | if (indicator->initialized) 83 | close(console_config->device); 84 | free(console_config); 85 | } 86 | 87 | /** 88 | * Turn keyboard LED on. 89 | */ 90 | void console_turn_on(Indicator *indicator) 91 | { 92 | unsigned char state; 93 | ConsoleConfig *console_config = (ConsoleConfig *) indicator->config; 94 | 95 | // get current state 96 | ioctl(console_config->device, KDGETLED, &state); 97 | 98 | // toggle state of specified LED 99 | state |= console_config->led; 100 | 101 | // apply new state 102 | ioctl(console_config->device, KDSETLED, state); 103 | } 104 | 105 | /** 106 | * Turn keyboard LED off. 107 | */ 108 | void console_turn_off(Indicator *indicator) 109 | { 110 | unsigned char state; 111 | ConsoleConfig *console_config = (ConsoleConfig *) indicator->config; 112 | 113 | // get current state 114 | ioctl(console_config->device, KDGETLED, &state); 115 | 116 | // toggle state of specified LED 117 | state &= ~console_config->led; 118 | 119 | // apply new state 120 | ioctl(console_config->device, KDSETLED, state); 121 | } 122 | -------------------------------------------------------------------------------- /src/xorg.c: -------------------------------------------------------------------------------- 1 | /** 2 | * Disk Indicator 0.2 3 | * Copyright © 2015. by Mladen Mijatov . 4 | * 5 | * Support for notifications by keyboard light through 6 | * X.Org display server. This is a prefered method for 7 | * users in graphical desktop environment. 8 | * 9 | * This nifty little tool will turn your scroll lock (or some other LED) 10 | * into your disk activity indicator. Program must be started as root. 11 | * It had very little overhead and almost no CPU usage. 12 | * 13 | * Original idea and some code by Dan Stahlke . His 14 | * source code can be found here: http://www.stahlke.org/dan/hdd_led/ 15 | * 16 | * This program is free software: you can redistribute it and/or modify 17 | * it under the terms of the GNU General Public License as published by 18 | * the Free Software Foundation, either version 3 of the License, or 19 | * (at your option) any later version. 20 | * 21 | * This program is distributed in the hope that it will be useful, 22 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 23 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 24 | * GNU General Public License for more details. 25 | * 26 | * You should have received a copy of the GNU General Public License 27 | * along with this program. If not, see . 28 | */ 29 | 30 | #include 31 | #include 32 | #include 33 | 34 | #include "xorg.h" 35 | 36 | /** 37 | * Initialize X.Org display support. 38 | */ 39 | void xorg_init(Indicator *indicator, char *led) 40 | { 41 | // allocate memory to store config 42 | XOrgConfig *xorg_config = calloc(1, sizeof(XOrgConfig)); 43 | indicator->config = (char *) xorg_config; 44 | 45 | // open connection to display server 46 | xorg_config->display = XOpenDisplay(NULL); 47 | xorg_config->keyboard_state = calloc(1, sizeof(XKeyboardState)); 48 | xorg_config->flag_bit = XORG_SCROLL_LOCK; 49 | 50 | // parse additional parameters 51 | if (strncmp(led, "scroll", 6) == 0) { 52 | xorg_config->flag_bit = XORG_SCROLL_LOCK; 53 | } else if (strncmp(led, "num", 3) == 0) { 54 | xorg_config->flag_bit = XORG_NUM_LOCK; 55 | } else if (strncmp(led, "caps", 4) == 0) { 56 | xorg_config->flag_bit = XORG_CAPS_LOCK; 57 | } 58 | 59 | // mark indicator as initialized 60 | indicator->initialized = true; 61 | } 62 | 63 | /** 64 | * Free memory taken by X.Org display support config. 65 | */ 66 | void xorg_quit(Indicator *indicator) 67 | { 68 | XOrgConfig *xorg_config = (XOrgConfig *) indicator->config; 69 | 70 | XCloseDisplay(xorg_config->display); 71 | free(xorg_config->keyboard_state); 72 | free(xorg_config); 73 | } 74 | 75 | /** 76 | * Turn keyboard LED on. 77 | */ 78 | void xorg_turn_on(Indicator *indicator) 79 | { 80 | unsigned long led_mask; 81 | XKeyboardControl values; 82 | 83 | // get config 84 | XOrgConfig *xorg_config = (XOrgConfig *) indicator->config; 85 | 86 | // get current LED state 87 | XGetKeyboardControl(xorg_config->display, xorg_config->keyboard_state); 88 | led_mask = xorg_config->keyboard_state->led_mask; 89 | 90 | // store initial flag state 91 | xorg_config->initial_state = (led_mask & xorg_config->flag_bit) == xorg_config->flag_bit; 92 | 93 | // set new state 94 | if (xorg_config->initial_state) 95 | values.led_mode = LedModeOff; else 96 | values.led_mode = LedModeOn; 97 | values.led = xorg_config->flag_bit; 98 | 99 | XChangeKeyboardControl(xorg_config->display, KBLed | KBLedMode, &values); 100 | 101 | // get the state again to apply changes 102 | XGetKeyboardControl(xorg_config->display, xorg_config->keyboard_state); 103 | } 104 | 105 | /** 106 | * Turn keyboard LED off. 107 | */ 108 | void xorg_turn_off(Indicator *indicator) 109 | { 110 | XKeyboardControl values; 111 | 112 | // get config 113 | XOrgConfig *xorg_config = (XOrgConfig *) indicator->config; 114 | 115 | // set new state 116 | if (xorg_config->initial_state) 117 | values.led_mode = LedModeOn; else 118 | values.led_mode = LedModeOff; 119 | values.led = xorg_config->flag_bit; 120 | 121 | XChangeKeyboardControl(xorg_config->display, KBLed | KBLedMode, &values); 122 | 123 | // get the state again to apply changes 124 | XGetKeyboardControl(xorg_config->display, xorg_config->keyboard_state); 125 | } 126 | -------------------------------------------------------------------------------- /src/main.c: -------------------------------------------------------------------------------- 1 | /** 2 | * Disk Indicator 0.3 3 | * Copyright © 2017. by Mladen Mijatov . 4 | * 5 | * This nifty little tool will turn your scroll lock (or some other LED) 6 | * into your disk activity indicator. Program must be started as root. 7 | * It had very little overhead and almost no CPU usage. 8 | * 9 | * Original idea and some code by Dan Stahlke . His 10 | * source code can be found here: http://www.stahlke.org/dan/hdd_led/ 11 | * 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * This program is distributed in the hope that it will be useful, 18 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | * GNU General Public License for more details. 21 | * 22 | * You should have received a copy of the GNU General Public License 23 | * along with this program. 24 | * 25 | * If not, see . 26 | */ 27 | 28 | #define _POSIX_C_SOURCE 1 29 | #include 30 | #include 31 | #include 32 | #include 33 | #include 34 | #include 35 | #include 36 | #include 37 | 38 | #include "main.h" 39 | #include "../build/dependencies.h" 40 | 41 | char stat_device[20]; 42 | unsigned long stat_read_count; 43 | unsigned long stat_write_count; 44 | 45 | /** 46 | * Create new configuration structure and populate 47 | * with default values if no arguments were passed. 48 | */ 49 | Config *load_config(int argc, const char *argv[]) 50 | { 51 | Config *result = calloc(1, sizeof(Config)); 52 | int config; 53 | char config_file[4096] = {0}; 54 | char default_config_file[] = "~/.disk-indicator"; 55 | 56 | // set default values 57 | result->xorg_initialized = false; 58 | result->console_initialized = false; 59 | result->thinkpad_initialized = false; 60 | 61 | // get config file 62 | if (argc > 0 && strcmp(argv[0], "-c") == 0) { 63 | argc--; 64 | argv++; 65 | 66 | strcpy(config_file, argv[0]); 67 | 68 | } else { 69 | // use default config file 70 | strcpy(config_file, default_config_file); 71 | } 72 | 73 | // load config file 74 | config = open(config_file, O_RDONLY); 75 | if (config < 0) { 76 | perror(config_file); 77 | goto _exit; 78 | } 79 | 80 | char led[20]; 81 | char device[20]; 82 | char event[6]; 83 | char line[128]; 84 | 85 | while (read_line(config, line) > 0) { 86 | // parse line from config file 87 | if (sscanf(line, CONFIG_FORMAT, led, event, device) < 3) 88 | continue; 89 | 90 | // make sure we don't go over our limit 91 | if (result->indicator_count == 20) { 92 | printf("Indicator limit (20) is reached, ignoring the rest of the config file.\n"); 93 | break; 94 | } 95 | 96 | // create new indicator 97 | Indicator *indicator = calloc(1, sizeof(Indicator)); 98 | 99 | // store device name to indicator 100 | indicator->device = calloc(1, strlen(device) + 1); 101 | strcpy(indicator->device, device); 102 | 103 | // assign function calls 104 | switch (led[0]) { 105 | case 'x': 106 | #ifdef XORG_AVAILABLE 107 | indicator->method = X_ORG; 108 | indicator->turn_notification_on = &xorg_turn_on; 109 | indicator->turn_notification_off = &xorg_turn_off; 110 | 111 | xorg_init(indicator, led + 2); 112 | result->xorg_initialized |= indicator->initialized; 113 | #endif 114 | break; 115 | 116 | case 'c': 117 | #ifdef CONSOLE_AVAILABLE 118 | indicator->method = CONSOLE; 119 | indicator->turn_notification_on = &console_turn_on; 120 | indicator->turn_notification_off = &console_turn_off; 121 | 122 | console_init(indicator, led + 2); 123 | result->console_initialized |= indicator->initialized; 124 | #endif 125 | break; 126 | 127 | case 't': 128 | #ifdef THINKPAD_AVAILABLE 129 | indicator->method = THINKPAD; 130 | indicator->turn_notification_on = &thinkpad_turn_on; 131 | indicator->turn_notification_off = &thinkpad_turn_off; 132 | 133 | thinkpad_init(indicator, led + 2); 134 | result->thinkpad_initialized |= indicator->initialized; 135 | #endif 136 | break; 137 | } 138 | 139 | // assign event type 140 | if (strcmp(event, "read") == 0) { 141 | indicator->event = READ; 142 | } else if (strcmp(event, "write") == 0) { 143 | indicator->event = WRITE; 144 | } else { 145 | indicator->event = BOTH; 146 | } 147 | 148 | // reset counters 149 | indicator->read_count = 0; 150 | indicator->write_count = 0; 151 | 152 | // store indicator 153 | result->indicators[result->indicator_count] = indicator; 154 | result->indicator_count++; 155 | } 156 | 157 | // close config file 158 | close(config); 159 | 160 | // default configuration 161 | result->check_interval = 200000; 162 | result->power_on_interval = 40000; 163 | result->power_off_interval= 10000; 164 | 165 | _exit: 166 | // set config initialization result value 167 | result->initialized = false; 168 | result->initialized |= result->xorg_initialized; 169 | result->initialized |= result->console_initialized; 170 | result->initialized |= result->thinkpad_initialized; 171 | 172 | if (result->initialized) 173 | printf("Loaded %d indicators.\n", result->indicator_count); 174 | 175 | return result; 176 | } 177 | 178 | /** 179 | * Free memory taken by the config. 180 | */ 181 | void unload_config(Config *config) 182 | { 183 | // close disk statistics file 184 | close_stats_file(); 185 | 186 | // free indicator memory 187 | for (int i = 0; i < config->indicator_count; i++) { 188 | Indicator *indicator = config->indicators[i]; 189 | 190 | // allow subsystems to clean up 191 | switch (indicator->method) { 192 | case X_ORG: 193 | #ifdef XORG_AVAILABLE 194 | xorg_quit(indicator); 195 | #endif 196 | break; 197 | 198 | case CONSOLE: 199 | #ifdef CONSOLE_AVAILABLE 200 | console_quit(indicator); 201 | #endif 202 | break; 203 | 204 | case THINKPAD: 205 | #ifdef THINKPAD_AVAILABLE 206 | thinkpad_quit(indicator); 207 | #endif 208 | break; 209 | } 210 | 211 | free(config->indicators[i]->device); 212 | free(config->indicators[i]); 213 | } 214 | 215 | free(config); 216 | } 217 | 218 | /** 219 | * Read single line from specified file descriptor. 220 | */ 221 | unsigned int read_line(int file, char *line) 222 | { 223 | int length = 0, read_count = 0; 224 | char character[2]; 225 | 226 | while (true) { 227 | read_count = read(file, character, 1); 228 | 229 | // end of file 230 | if (read_count == 0) 231 | break; 232 | 233 | // new line 234 | if (character[0] == '\0' || character[0] == '\n') 235 | break; 236 | 237 | line[length] = character[0]; 238 | length += read_count; 239 | } 240 | 241 | line[length] = '\0'; 242 | 243 | return length; 244 | } 245 | 246 | /** 247 | * Open disk statistics file. 248 | */ 249 | bool open_stats_file() 250 | { 251 | bool result = true; 252 | 253 | // open file 254 | config->stats_file = open(FILENAME, O_RDONLY); 255 | if (config->stats_file < 0) { 256 | perror(FILENAME); 257 | result = false; 258 | } 259 | 260 | return result; 261 | } 262 | 263 | /** 264 | * Close disk statistics file. 265 | */ 266 | void close_stats_file() 267 | { 268 | if (config->stats_file) 269 | close(config->stats_file); 270 | } 271 | 272 | /** 273 | * Get content for disk statistics file. 274 | */ 275 | void read_stats(char *device, unsigned long *read_count, unsigned long *write_count) 276 | { 277 | char buff[200] = {0}; 278 | unsigned int count = read_line(config->stats_file, buff); 279 | 280 | // go to beginning of the file 281 | if (count == 0) { 282 | lseek(config->stats_file, 0, SEEK_SET); 283 | 284 | // let check indicators know we reached end of file 285 | strcpy(device, "null"); 286 | read_count = 0; 287 | write_count = 0; 288 | return; 289 | } 290 | 291 | // parse line 292 | sscanf(buff, STATS_FORMAT, device, read_count, write_count); 293 | } 294 | 295 | /** 296 | * Handle external signals. 297 | */ 298 | void handle_signal() 299 | { 300 | unload_config(config); 301 | exit(EXIT_SUCCESS); 302 | } 303 | 304 | /** 305 | * Check if we're attached to a terminal. 306 | */ 307 | int is_attached(void) 308 | { 309 | return isatty( 310 | fileno(stdout) && 311 | isatty(fileno(stdin)) && 312 | isatty(fileno(stderr)) 313 | ); 314 | } 315 | 316 | /** 317 | * Daemonize to background and detach from console. 318 | */ 319 | void daemonize(void) 320 | { 321 | if (!is_attached()) 322 | return; 323 | 324 | // fork process 325 | int pid = fork(); 326 | 327 | // exit our parent process 328 | if (pid > 0) 329 | exit(EXIT_SUCCESS); 330 | 331 | printf("Going away from console, pid: %d\n", getpid()); 332 | 333 | // close file descriptors 334 | freopen("/dev/null", "r", stdin); 335 | freopen("/dev/null", "w", stdout); 336 | freopen("/dev/null", "w", stderr); 337 | 338 | if (setpgid(0, 0) < 0 || pid == -1) 339 | exit(EXIT_FAILURE); 340 | } 341 | 342 | /** 343 | * Check all indicators and return number of currently active ones. 344 | */ 345 | char check_indicators(void) 346 | { 347 | char result = 0; 348 | bool changed; 349 | 350 | read_stats(stat_device, &stat_read_count, &stat_write_count); 351 | 352 | while (strcmp(stat_device, "null") != 0) { 353 | for (int i = 0; i < config->indicator_count; i++) { 354 | Indicator *indicator = config->indicators[i]; 355 | 356 | // jump to next indicator 357 | if (strcmp(stat_device, indicator->device) != 0) 358 | continue; 359 | 360 | // compare data 361 | changed = false; 362 | 363 | if (indicator->event == READ || indicator->event == BOTH) 364 | changed |= stat_read_count != indicator->read_count; 365 | 366 | if (indicator->event == WRITE || indicator->event == BOTH) 367 | changed |= stat_write_count != indicator->write_count; 368 | 369 | // store new data 370 | indicator->read_count = stat_read_count; 371 | indicator->write_count = stat_write_count; 372 | 373 | // turn the light on 374 | if (changed) { 375 | indicator->turn_notification_on(indicator); 376 | usleep(config->power_on_interval); 377 | 378 | // turn it off 379 | indicator->turn_notification_off(indicator); 380 | usleep(config->power_off_interval); 381 | 382 | // increase result 383 | result++; 384 | } 385 | } 386 | 387 | // read stats again 388 | read_stats(stat_device, &stat_read_count, &stat_write_count); 389 | } 390 | 391 | return result; 392 | } 393 | 394 | /** 395 | * Main application loop. 396 | */ 397 | int main(int argc, const char *argv[]) 398 | { 399 | int no_fork = 0; 400 | 401 | // shift arguments, first is just program executable 402 | argc--; 403 | argv++; 404 | 405 | // show help if no arguments are specified 406 | if (argc > 0 && ((strcmp(argv[0], "-h") == 0) || (strcmp(argv[0], "--help") == 0))) { 407 | printf( 408 | "Usage: disk_indicator [-f] [-c config.file]\n" 409 | "\t-c\tLoad specified config. (default: ~/.disk-indicator)\n" 410 | "\t-f\tDo not fork to background.\n\n" 411 | "Sample config file:\n" 412 | "\tled=t|0 event=read device=sda\n" 413 | "\tled=c|tty1|caps event=write device=sda\n" 414 | "\tled=x|scroll event=both device=sda1\n\n" 415 | "Config params:\n" 416 | "\tled=|\tProvider: t, c, x\tName: 0-15, caps, scroll, num\n" 417 | "\tevent=\t\tType: read, write, both\n" 418 | "\tdevice=\t\tName: eg. sda1, sda, mmcblkp1\n\n" 419 | ); 420 | printf("Supported providers:\n"); 421 | #ifdef XORG_AVAILABLE 422 | printf("\tx - X.Org\n"); 423 | #endif 424 | #ifdef CONSOLE_AVAILABLE 425 | printf("\tc - Console\n"); 426 | #endif 427 | #ifdef THINKPAD_AVAILABLE 428 | printf("\tt - ThinkPad\n"); 429 | #endif 430 | exit(EXIT_SUCCESS); 431 | } 432 | 433 | if (argc > 0 && strcmp(argv[0], "-f") == 0) { 434 | // set forking flag 435 | no_fork = 1; 436 | 437 | // shift parameters 438 | argc--; 439 | argv++; 440 | } 441 | 442 | // register signal handler 443 | signal(SIGINT, handle_signal); 444 | signal(SIGTERM, handle_signal); 445 | 446 | // load config 447 | config = load_config(argc, argv); 448 | 449 | // check if config was successfully initialized 450 | if (!config->initialized) { 451 | unload_config(config); 452 | printf("Error loading configuration file.\n"); 453 | exit(1); 454 | } 455 | 456 | // try opening disk statistics 457 | if (open_stats_file() == false) { 458 | unload_config(config); 459 | exit(2); 460 | } 461 | 462 | // fork to background 463 | if (!no_fork) 464 | daemonize(); 465 | 466 | // start main loop 467 | while (1) { 468 | if (check_indicators() == 0) 469 | usleep(config->check_interval); 470 | } 471 | 472 | unload_config(config); 473 | return EXIT_SUCCESS; 474 | } 475 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------