// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. #include "fsnotifier.h" #include #include #include #include #include #include #include #include #include #include #include #include #define LOG_ENV "FSNOTIFIER_LOG_LEVEL" #define LOG_ENV_DEBUG "debug" #define LOG_ENV_INFO "info" #define LOG_ENV_WARNING "warning" #define LOG_ENV_ERROR "error" #define LOG_ENV_OFF "off" #define USAGE_MSG \ "fsnotifier - IntelliJ IDEA companion program for watching and reporting file and directory structure modifications.\n\n" \ "fsnotifier utilizes \"user\" facility of syslog(3) - messages usually can be found in /var/log/user.log.\n" \ "Verbosity is regulated via " LOG_ENV " environment variable, possible values are: " \ LOG_ENV_DEBUG ", " LOG_ENV_INFO ", " LOG_ENV_WARNING ", " LOG_ENV_ERROR ", " LOG_ENV_OFF "; default is " LOG_ENV_WARNING ".\n\n" \ "Use 'fsnotifier --selftest' to perform some self-diagnostics (output will be logged and printed to console).\n" #define HELP_MSG \ "Try 'fsnotifier --help' for more information.\n" #define MISSING_ROOT_TIMEOUT 1 #define UNFLATTEN(root) (root[0] == '|' ? root + 1 : root) typedef struct { char* path; int id; // negative value means missing root } watch_root; static array* roots = NULL; static int log_level = 0; static bool self_test = false; static void init_log(); static void run_self_test(); static bool main_loop(); static int read_input(); static bool update_roots(array* new_roots); static void unregister_roots(); static bool register_roots(array* new_roots, array* unwatchable, array* mounts); static array* unwatchable_mounts(); static void inotify_callback(const char* path, int event); static void report_event(const char* event, const char* path); static void output(const char* format, ...); static void check_missing_roots(); static void check_root_removal(const char*); int main(int argc, char** argv) { if (argc > 1) { if (strcmp(argv[1], "--help") == 0) { printf(USAGE_MSG); return 0; } else if (strcmp(argv[1], "--version") == 0) { printf("fsnotifier " VERSION "\n"); return 0; } else if (strcmp(argv[1], "--selftest") == 0) { self_test = true; } else { printf("unrecognized option: %s\n", argv[1]); printf(HELP_MSG); return 1; } } init_log(); if (!self_test) { userlog(LOG_INFO, "started (v." VERSION ")"); } else { userlog(LOG_INFO, "started (self-test mode) (v." VERSION ")"); } setvbuf(stdin, NULL, _IONBF, 0); int rv = 0; roots = array_create(20); if (roots != NULL && init_inotify()) { set_inotify_callback(&inotify_callback); if (!self_test) { if (!main_loop()) { rv = 3; } } else { run_self_test(); } unregister_roots(); } else { output("GIVEUP\n"); rv = 2; } close_inotify(); array_delete(roots); userlog(LOG_INFO, "finished (%d)", rv); closelog(); return rv; } static void init_log() { int level = LOG_WARNING; char* env_level = getenv(LOG_ENV); if (env_level != NULL) { if (strcmp(env_level, LOG_ENV_DEBUG) == 0) level = LOG_DEBUG; else if (strcmp(env_level, LOG_ENV_INFO) == 0) level = LOG_INFO; else if (strcmp(env_level, LOG_ENV_WARNING) == 0) level = LOG_WARNING; else if (strcmp(env_level, LOG_ENV_ERROR) == 0) level = LOG_ERR; } if (self_test) { level = LOG_DEBUG; } char ident[32]; snprintf(ident, sizeof(ident), "fsnotifier[%d]", getpid()); openlog(ident, 0, LOG_USER); log_level = level; } void message(const char *text) { output("MESSAGE\n%s\n", text); } void userlog(int priority, const char* format, ...) { if (priority > log_level) { return; } va_list ap; va_start(ap, format); vsyslog(priority, format, ap); va_end(ap); if (self_test) { const char* level = "debug"; switch (priority) { case LOG_ERR: level = "error"; break; case LOG_WARNING: level = " warn"; break; case LOG_INFO: level = " info"; break; } printf("fsnotifier[%d] %s: ", getpid(), level); va_start(ap, format); vprintf(format, ap); va_end(ap); printf("\n"); } } static void run_self_test() { array* test_roots = array_create(1); char* cwd = malloc(PATH_MAX); if (getcwd(cwd, PATH_MAX) == NULL) { strncpy(cwd, ".", PATH_MAX); } array_push(test_roots, cwd); update_roots(test_roots); } static bool main_loop() { int input_fd = fileno(stdin), inotify_fd = get_inotify_fd(); int nfds = (inotify_fd > input_fd ? inotify_fd : input_fd) + 1; fd_set rfds; struct timeval timeout; while (true) { usleep(50000); FD_ZERO(&rfds); FD_SET(input_fd, &rfds); FD_SET(inotify_fd, &rfds); timeout = (struct timeval){MISSING_ROOT_TIMEOUT, 0}; if (select(nfds, &rfds, NULL, NULL, &timeout) < 0) { if (errno != EINTR) { userlog(LOG_ERR, "select: %s", strerror(errno)); return false; } } else if (FD_ISSET(input_fd, &rfds)) { int result = read_input(); if (result == 0) return true; else if (result != ERR_CONTINUE) return false; } else if (FD_ISSET(inotify_fd, &rfds)) { if (!process_inotify_input()) return false; } else { check_missing_roots(); } } } static int read_input() { char* line = read_line(stdin); userlog(LOG_DEBUG, "input: %s", (line ? line : "")); if (line == NULL || strcmp(line, "EXIT") == 0) { userlog(LOG_INFO, "exiting: %s", line); return 0; } if (strcmp(line, "ROOTS") == 0) { array* new_roots = array_create(20); CHECK_NULL(new_roots, ERR_ABORT); while (1) { line = read_line(stdin); userlog(LOG_DEBUG, "input: %s", (line ? line : "")); if (line == NULL || strlen(line) == 0) { return 0; } else if (strcmp(line, "#") == 0) { break; } else { int l = strlen(line); if (l > 1 && line[l-1] == '/') line[l-1] = '\0'; CHECK_NULL(array_push(new_roots, strdup(line)), ERR_ABORT); } } return update_roots(new_roots) ? ERR_CONTINUE : ERR_ABORT; } userlog(LOG_WARNING, "unrecognised command: %s", line); return ERR_CONTINUE; } static bool update_roots(array* new_roots) { userlog(LOG_INFO, "updating roots (curr:%d, new:%d)", array_size(roots), array_size(new_roots)); unregister_roots(); if (array_size(new_roots) == 0) { output("UNWATCHEABLE\n#\n"); array_delete(new_roots); return true; } else if (array_size(new_roots) == 1 && strcmp(array_get(new_roots, 0), "/") == 0) { // refuse to watch entire tree output("UNWATCHEABLE\n/\n#\n"); userlog(LOG_INFO, "unwatchable: /"); array_delete_vs_data(new_roots); return true; } array* mounts = unwatchable_mounts(); if (mounts == NULL) { return false; } array* unwatchable = array_create(20); if (!register_roots(new_roots, unwatchable, mounts)) { return false; } output("UNWATCHEABLE\n"); for (int i=0; ipath); unwatch(root->id); free(root->path); free(root); }; } static bool register_roots(array* new_roots, array* unwatchable, array* mounts) { for (int i=0; i= 0 || id == ERR_MISSING) { watch_root* root = malloc(sizeof(watch_root)); CHECK_NULL(root, false); root->id = id; root->path = strdup(new_root); CHECK_NULL(root->path, false); CHECK_NULL(array_push(roots, root), false); } else if (id == ERR_ABORT) { return false; } else if (id != ERR_IGNORE) { userlog(LOG_WARNING, "watch root '%s' cannot be watched: %d", unflattened, id); CHECK_NULL(array_push(unwatchable, strdup(unflattened)), false); } } return true; } static bool is_watchable(const char* fs) { // don't watch special and network filesystems return !(strncmp(fs, "dev", 3) == 0 || strcmp(fs, "proc") == 0 || strcmp(fs, "sysfs") == 0 || strcmp(fs, MNTTYPE_SWAP) == 0 || (strncmp(fs, "fuse", 4) == 0 && strcmp(fs + 4, "blk") != 0 && strcmp(fs + 4, ".osxfs") != 0) || strcmp(fs, "cifs") == 0 || strcmp(fs, MNTTYPE_NFS) == 0); } static array* unwatchable_mounts() { FILE* mtab = setmntent(_PATH_MOUNTED, "r"); if (mtab == NULL && errno == ENOENT) { mtab = setmntent("/proc/mounts", "r"); } if (mtab == NULL) { userlog(LOG_ERR, "cannot open " _PATH_MOUNTED); return NULL; } array* mounts = array_create(20); CHECK_NULL(mounts, NULL); struct mntent* ent; while ((ent = getmntent(mtab)) != NULL) { userlog(LOG_DEBUG, "mtab: %s : %s", ent->mnt_dir, ent->mnt_type); if (strcmp(ent->mnt_type, MNTTYPE_IGNORE) != 0 && !is_watchable(ent->mnt_type)) { CHECK_NULL(array_push(mounts, strdup(ent->mnt_dir)), NULL); } } endmntent(mtab); return mounts; } static void inotify_callback(const char* path, int event) { if (event & (IN_CREATE | IN_MOVED_TO)) { report_event("CREATE", path); report_event("CHANGE", path); } else if (event & IN_MODIFY) { report_event("CHANGE", path); } else if (event & IN_ATTRIB) { report_event("STATS", path); } else if (event & (IN_DELETE | IN_MOVED_FROM)) { report_event("DELETE", path); } if (event & (IN_DELETE_SELF | IN_MOVE_SELF)) { check_root_removal(path); } else if (event & IN_UNMOUNT) { output("RESET\n"); userlog(LOG_DEBUG, "RESET"); } } static void report_event(const char* event, const char* path) { userlog(LOG_DEBUG, "%s: %s", event, path); #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wincompatible-pointer-types" char* copy = path, *p; for (p = copy; *p != '\0'; ++p) { if (*p == '\n') { if (copy == path) { copy = strdup(path); p = copy + (p - path); } *p = '\0'; } } #pragma clang diagnostic pop fputs(event, stdout); fputc('\n', stdout); fwrite(copy, (p - copy), 1, stdout); fputc('\n', stdout); if (copy != path) { free(copy); } fflush(stdout); } static void output(const char* format, ...) { if (self_test) { return; } va_list ap; va_start(ap, format); vprintf(format, ap); va_end(ap); fflush(stdout); } static void check_missing_roots() { struct stat st; for (int i=0; iid < 0) { char* unflattened = UNFLATTEN(root->path); if (stat(unflattened, &st) == 0) { root->id = watch(root->path, NULL); userlog(LOG_INFO, "root restored: %s\n", root->path); report_event("CREATE", unflattened); report_event("CHANGE", unflattened); } } } } static void check_root_removal(const char* path) { for (int i=0; iid >= 0 && strcmp(path, UNFLATTEN(root->path)) == 0) { unwatch(root->id); root->id = -1; userlog(LOG_INFO, "root deleted: %s\n", root->path); report_event("DELETE", path); } } }