]> git.sur5r.net Git - i3/i3/blobdiff - src/util.c
Add a safe wrapper for write and fix some warnings
[i3/i3] / src / util.c
index 70984f2b7d5bd6422780981f459030428fb18788..5760ae72588f52afc5cd6caf617a4b184e344ab9 100644 (file)
@@ -1,3 +1,5 @@
+#undef I3__FILE__
+#define I3__FILE__ "util.c"
 /*
  * vim:ts=4:sw=4:expandtab
  *
@@ -19,6 +21,7 @@
 #include <pwd.h>
 #include <yajl/yajl_version.h>
 #include <libgen.h>
+#include <ctype.h>
 
 #define SN_API_NOT_YET_FROZEN 1
 #include <libsn/sn-launcher.h>
@@ -45,6 +48,45 @@ Rect rect_add(Rect a, Rect b) {
                   a.height + b.height};
 }
 
+Rect rect_sub(Rect a, Rect b) {
+    return (Rect){a.x - b.x,
+                  a.y - b.y,
+                  a.width - b.width,
+                  a.height - b.height};
+}
+
+/*
+ * Returns true if the name consists of only digits.
+ *
+ */
+__attribute__((pure)) bool name_is_digits(const char *name) {
+    /* positive integers and zero are interpreted as numbers */
+    for (size_t i = 0; i < strlen(name); i++)
+        if (!isdigit(name[i]))
+            return false;
+
+    return true;
+}
+
+/*
+ * Parses the workspace name as a number. Returns -1 if the workspace should be
+ * interpreted as a "named workspace".
+ *
+ */
+long ws_name_to_number(const char *name) {
+    /* positive integers and zero are interpreted as numbers */
+    char *endptr = NULL;
+    long parsed_num = strtol(name, &endptr, 10);
+    if (parsed_num == LONG_MIN ||
+        parsed_num == LONG_MAX ||
+        parsed_num < 0 ||
+        endptr == name) {
+        parsed_num = -1;
+    }
+
+    return parsed_num;
+}
+
 /*
  * Updates *destination with new_value and returns true if it was changed or false
  * if it was the same
@@ -91,7 +133,7 @@ void exec_i3_utility(char *name, char *argv[]) {
     char buffer[BUFSIZ];
     if (readlink("/proc/self/exe", buffer, BUFSIZ) == -1) {
         warn("could not read /proc/self/exe");
-        exit(1);
+        _exit(1);
     }
     dir = dirname(buffer);
     sasprintf(&migratepath, "%s/%s", dir, name);
@@ -100,7 +142,7 @@ void exec_i3_utility(char *name, char *argv[]) {
 #endif
 
     warn("Could not start %s", name);
-    exit(2);
+    _exit(2);
 }
 
 /*
@@ -111,7 +153,7 @@ void exec_i3_utility(char *name, char *argv[]) {
 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
     xcb_generic_error_t *error = xcb_request_check(conn, cookie);
     if (error != NULL) {
-        fprintf(stderr, "ERROR: %s (X error %d)\n", err_message , error->error_code);
+        fprintf(stderr, "ERROR: %s (X error %d)\n", err_message, error->error_code);
         xcb_disconnect(conn);
         exit(-1);
     }
@@ -124,29 +166,29 @@ void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_mes
  *
  */
 char *resolve_tilde(const char *path) {
-        static glob_t globbuf;
-        char *head, *tail, *result;
-
-        tail = strchr(path, '/');
-        head = strndup(path, tail ? tail - path : strlen(path));
-
-        int res = glob(head, GLOB_TILDE, NULL, &globbuf);
-        free(head);
-        /* no match, or many wildcard matches are bad */
-        if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
-                result = sstrdup(path);
-        else if (res != 0) {
-                die("glob() failed");
-        } else {
-                head = globbuf.gl_pathv[0];
-                result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
-                strncpy(result, head, strlen(head));
-                if (tail)
-                    strncat(result, tail, strlen(tail));
-        }
-        globfree(&globbuf);
+    static glob_t globbuf;
+    char *head, *tail, *result;
+
+    tail = strchr(path, '/');
+    head = strndup(path, tail ? (size_t)(tail - path) : strlen(path));
+
+    int res = glob(head, GLOB_TILDE, NULL, &globbuf);
+    free(head);
+    /* no match, or many wildcard matches are bad */
+    if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
+        result = sstrdup(path);
+    else if (res != 0) {
+        die("glob() failed");
+    } else {
+        head = globbuf.gl_pathv[0];
+        result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
+        strncpy(result, head, strlen(head));
+        if (tail)
+            strncat(result, tail, strlen(tail));
+    }
+    globfree(&globbuf);
 
-        return result;
+    return result;
 }
 
 /*
@@ -154,8 +196,8 @@ char *resolve_tilde(const char *path) {
  *
  */
 bool path_exists(const char *path) {
-        struct stat buf;
-        return (stat(path, &buf) == 0);
+    struct stat buf;
+    return (stat(path, &buf) == 0);
 }
 
 /*
@@ -173,73 +215,27 @@ static char **append_argument(char **original, char *argument) {
             return original;
     }
     /* Copy the original array */
-    char **result = smalloc((num_args+2) * sizeof(char*));
-    memcpy(result, original, num_args * sizeof(char*));
+    char **result = smalloc((num_args + 2) * sizeof(char *));
+    memcpy(result, original, num_args * sizeof(char *));
     result[num_args] = argument;
-    result[num_args+1] = NULL;
+    result[num_args + 1] = NULL;
 
     return result;
 }
 
-/*
- * Returns the name of a temporary file with the specified prefix.
- *
- */
-char *get_process_filename(const char *prefix) {
-    /* dir stores the directory path for this and all subsequent calls so that
-     * we only create a temporary directory once per i3 instance. */
-    static char *dir = NULL;
-    if (dir == NULL) {
-        /* Check if XDG_RUNTIME_DIR is set. If so, we use XDG_RUNTIME_DIR/i3 */
-        if ((dir = getenv("XDG_RUNTIME_DIR"))) {
-            char *tmp;
-            sasprintf(&tmp, "%s/i3", dir);
-            dir = tmp;
-            if (!path_exists(dir)) {
-                if (mkdir(dir, 0700) == -1) {
-                    perror("mkdir()");
-                    return NULL;
-                }
-            }
-        } else {
-            /* If not, we create a (secure) temp directory using the template
-             * /tmp/i3-<user>.XXXXXX */
-            struct passwd *pw = getpwuid(getuid());
-            const char *username = pw ? pw->pw_name : "unknown";
-            sasprintf(&dir, "/tmp/i3-%s.XXXXXX", username);
-            /* mkdtemp modifies dir */
-            if (mkdtemp(dir) == NULL) {
-                perror("mkdtemp()");
-                return NULL;
-            }
-        }
-    }
-    char *filename;
-    sasprintf(&filename, "%s/%s.%d", dir, prefix, getpid());
-    return filename;
-}
-
-#define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
-#define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
+#define y(x, ...) yajl_gen_##x(gen, ##__VA_ARGS__)
+#define ystr(str) yajl_gen_string(gen, (unsigned char *)str, strlen(str))
 
-char *store_restart_layout() {
+char *store_restart_layout(void) {
     setlocale(LC_NUMERIC, "C");
-#if YAJL_MAJOR >= 2
     yajl_gen gen = yajl_gen_alloc(NULL);
-#else
-    yajl_gen gen = yajl_gen_alloc(NULL, NULL);
-#endif
 
     dump_node(gen, croot, true);
 
     setlocale(LC_NUMERIC, "");
 
     const unsigned char *payload;
-#if YAJL_MAJOR >= 2
     size_t length;
-#else
-    unsigned int length;
-#endif
     y(get_buf, &payload, &length);
 
     /* create a temporary file if one hasn't been specified, or just
@@ -253,6 +249,15 @@ char *store_restart_layout() {
         filename = resolve_tilde(config.restart_state_path);
     }
 
+    /* create the directory, it could have been cleaned up before restarting or
+     * may not exist at all in case it was user-specified. */
+    char *filenamecopy = sstrdup(filename);
+    char *base = dirname(filenamecopy);
+    DLOG("Creating \"%s\" for storing the restart layout\n", base);
+    if (!mkdirp(base))
+        ELOG("Could not create \"%s\" for storing the restart layout, layout will be lost.\n", base);
+    free(filenamecopy);
+
     int fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
     if (fd == -1) {
         perror("open()");
@@ -260,33 +265,17 @@ char *store_restart_layout() {
         return NULL;
     }
 
-    int written = 0;
-    while (written < length) {
-        int n = write(fd, payload + written, length - written);
-        /* TODO: correct error-handling */
-        if (n == -1) {
-            perror("write()");
-            free(filename);
-            close(fd);
-            return NULL;
-        }
-        if (n == 0) {
-            printf("write == 0?\n");
-            free(filename);
-            close(fd);
-            return NULL;
-        }
-        written += n;
-#if YAJL_MAJOR >= 2
-        printf("written: %d of %zd\n", written, length);
-#else
-        printf("written: %d of %d\n", written, length);
-#endif
+    if (writeall(fd, payload, length) == -1) {
+        ELOG("Could not write restart layout to \"%s\", layout will be lost: %s\n", filename, strerror(errno));
+        free(filename);
+        close(fd);
+        return NULL;
     }
+
     close(fd);
 
     if (length > 0) {
-        printf("layout: %.*s\n", (int)length, payload);
+        DLOG("layout: %.*s\n", (int)length, payload);
     }
 
     y(free);
@@ -302,7 +291,8 @@ char *store_restart_layout() {
 void i3_restart(bool forget_layout) {
     char *restart_filename = forget_layout ? NULL : store_restart_layout();
 
-    kill_configerror_nagbar(true);
+    kill_nagbar(&config_error_nagbar_pid, true);
+    kill_nagbar(&command_error_nagbar_pid, true);
 
     restore_geometry();
 
@@ -316,8 +306,9 @@ void i3_restart(bool forget_layout) {
     if (restart_filename != NULL) {
         /* create the new argv */
         int num_args;
-        for (num_args = 0; start_argv[num_args] != NULL; num_args++);
-        char **new_argv = scalloc((num_args + 3) * sizeof(char*));
+        for (num_args = 0; start_argv[num_args] != NULL; num_args++)
+            ;
+        char **new_argv = scalloc((num_args + 3) * sizeof(char *));
 
         /* copy the arguments, but skip the ones we'll replace */
         int write_index = 0;
@@ -379,3 +370,103 @@ void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
 }
 
 #endif
+
+/*
+ * Handler which will be called when we get a SIGCHLD for the nagbar, meaning
+ * it exited (or could not be started, depending on the exit code).
+ *
+ */
+static void nagbar_exited(EV_P_ ev_child *watcher, int revents) {
+    ev_child_stop(EV_A_ watcher);
+
+    if (!WIFEXITED(watcher->rstatus)) {
+        ELOG("ERROR: i3-nagbar did not exit normally.\n");
+        return;
+    }
+
+    int exitcode = WEXITSTATUS(watcher->rstatus);
+    DLOG("i3-nagbar process exited with status %d\n", exitcode);
+    if (exitcode == 2) {
+        ELOG("ERROR: i3-nagbar could not be found. Is it correctly installed on your system?\n");
+    }
+
+    *((pid_t *)watcher->data) = -1;
+}
+
+/*
+ * Cleanup handler. Will be called when i3 exits. Kills i3-nagbar with signal
+ * SIGKILL (9) to make sure there are no left-over i3-nagbar processes.
+ *
+ */
+static void nagbar_cleanup(EV_P_ ev_cleanup *watcher, int revent) {
+    pid_t *nagbar_pid = (pid_t *)watcher->data;
+    if (*nagbar_pid != -1) {
+        LOG("Sending SIGKILL (%d) to i3-nagbar with PID %d\n", SIGKILL, *nagbar_pid);
+        kill(*nagbar_pid, SIGKILL);
+    }
+}
+
+/*
+ * Starts an i3-nagbar instance with the given parameters. Takes care of
+ * handling SIGCHLD and killing i3-nagbar when i3 exits.
+ *
+ * The resulting PID will be stored in *nagbar_pid and can be used with
+ * kill_nagbar() to kill the bar later on.
+ *
+ */
+void start_nagbar(pid_t *nagbar_pid, char *argv[]) {
+    if (*nagbar_pid != -1) {
+        DLOG("i3-nagbar already running (PID %d), not starting again.\n", *nagbar_pid);
+        return;
+    }
+
+    *nagbar_pid = fork();
+    if (*nagbar_pid == -1) {
+        warn("Could not fork()");
+        return;
+    }
+
+    /* child */
+    if (*nagbar_pid == 0)
+        exec_i3_utility("i3-nagbar", argv);
+
+    DLOG("Starting i3-nagbar with PID %d\n", *nagbar_pid);
+
+    /* parent */
+    /* install a child watcher */
+    ev_child *child = smalloc(sizeof(ev_child));
+    ev_child_init(child, &nagbar_exited, *nagbar_pid, 0);
+    child->data = nagbar_pid;
+    ev_child_start(main_loop, child);
+
+    /* install a cleanup watcher (will be called when i3 exits and i3-nagbar is
+     * still running) */
+    ev_cleanup *cleanup = smalloc(sizeof(ev_cleanup));
+    ev_cleanup_init(cleanup, nagbar_cleanup);
+    cleanup->data = nagbar_pid;
+    ev_cleanup_start(main_loop, cleanup);
+}
+
+/*
+ * Kills the i3-nagbar process, if *nagbar_pid != -1.
+ *
+ * If wait_for_it is set (restarting i3), this function will waitpid(),
+ * otherwise, ev is assumed to handle it (reloading).
+ *
+ */
+void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it) {
+    if (*nagbar_pid == -1)
+        return;
+
+    if (kill(*nagbar_pid, SIGTERM) == -1)
+        warn("kill(configerror_nagbar) failed");
+
+    if (!wait_for_it)
+        return;
+
+    /* When restarting, we don’t enter the ev main loop anymore and after the
+     * exec(), our old pid is no longer watched. So, ev won’t handle SIGCHLD
+     * for us and we would end up with a <defunct> process. Therefore we
+     * waitpid() here. */
+    waitpid(*nagbar_pid, NULL, 0);
+}