git.sur5r.net Git - i3/i3/blob - src/util.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * util.c: Utility functions, which can be useful everywhere within i3 (see
   8  *         also libi3).
   9  *
  10  */
  11 #include "all.h"
  12
  13 #include <sys/wait.h>
  14 #include <stdarg.h>
  15 #include <iconv.h>
  16 #if defined(__OpenBSD__)
  17 #include <sys/cdefs.h>
  18 #endif
  19 #include <fcntl.h>
  20 #include <pwd.h>
  21 #include <yajl/yajl_version.h>
  22 #include <libgen.h>
  23
  24 #define SN_API_NOT_YET_FROZEN 1
  25 #include <libsn/sn-launcher.h>
  26
  27 static iconv_t conversion_descriptor = 0;
  28
  29 int min(int a, int b) {
  30     return (a < b ? a : b);
  31 }
  32
  33 int max(int a, int b) {
  34     return (a > b ? a : b);
  35 }
  36
  37 bool rect_contains(Rect rect, uint32_t x, uint32_t y) {
  38     return (x >= rect.x &&
  39             x <= (rect.x + rect.width) &&
  40             y >= rect.y &&
  41             y <= (rect.y + rect.height));
  42 }
  43
  44 Rect rect_add(Rect a, Rect b) {
  45     return (Rect){a.x + b.x,
  46                   a.y + b.y,
  47                   a.width + b.width,
  48                   a.height + b.height};
  49 }
  50
  51 /*
  52  * Updates *destination with new_value and returns true if it was changed or false
  53  * if it was the same
  54  *
  55  */
  56 bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
  57     uint32_t old_value = *destination;
  58
  59     return ((*destination = new_value) != old_value);
  60 }
  61
  62 /*
  63  * exec()s an i3 utility, for example the config file migration script or
  64  * i3-nagbar. This function first searches $PATH for the given utility named,
  65  * then falls back to the dirname() of the i3 executable path and then falls
  66  * back to the dirname() of the target of /proc/self/exe (on linux).
  67  *
  68  * This function should be called after fork()ing.
  69  *
  70  * The first argument of the given argv vector will be overwritten with the
  71  * executable name, so pass NULL.
  72  *
  73  * If the utility cannot be found in any of these locations, it exits with
  74  * return code 2.
  75  *
  76  */
  77 void exec_i3_utility(char *name, char *argv[]) {
  78     /* start the migration script, search PATH first */
  79     char *migratepath = name;
  80     argv[0] = migratepath;
  81     execvp(migratepath, argv);
  82
  83     /* if the script is not in path, maybe the user installed to a strange
  84      * location and runs the i3 binary with an absolute path. We use
  85      * argv[0]’s dirname */
  86     char *pathbuf = strdup(start_argv[0]);
  87     char *dir = dirname(pathbuf);
  88     sasprintf(&migratepath, "%s/%s", dir, name);
  89     argv[0] = migratepath;
  90     execvp(migratepath, argv);
  91
  92 #if defined(__linux__)
  93     /* on linux, we have one more fall-back: dirname(/proc/self/exe) */
  94     char buffer[BUFSIZ];
  95     if (readlink("/proc/self/exe", buffer, BUFSIZ) == -1) {
  96         warn("could not read /proc/self/exe");
  97         exit(1);
  98     }
  99     dir = dirname(buffer);
 100     sasprintf(&migratepath, "%s/%s", dir, name);
 101     argv[0] = migratepath;
 102     execvp(migratepath, argv);
 103 #endif
 104
 105     warn("Could not start %s", name);
 106     exit(2);
 107 }
 108
 109 /*
 110  * Checks a generic cookie for errors and quits with the given message if there
 111  * was an error.
 112  *
 113  */
 114 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
 115     xcb_generic_error_t *error = xcb_request_check(conn, cookie);
 116     if (error != NULL) {
 117         fprintf(stderr, "ERROR: %s (X error %d)\n", err_message , error->error_code);
 118         xcb_disconnect(conn);
 119         exit(-1);
 120     }
 121 }
 122
 123 /*
 124  * Converts the given string to UCS-2 big endian for use with
 125  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
 126  * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
 127  * returned. It has to be freed when done.
 128  *
 129  */
 130 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
 131     size_t input_size = strlen(input) + 1;
 132     /* UCS-2 consumes exactly two bytes for each glyph */
 133     int buffer_size = input_size * 2;
 134
 135     char *buffer = smalloc(buffer_size);
 136     size_t output_size = buffer_size;
 137     /* We need to use an additional pointer, because iconv() modifies it */
 138     char *output = buffer;
 139
 140     /* We convert the input into UCS-2 big endian */
 141     if (conversion_descriptor == 0) {
 142         conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
 143         if (conversion_descriptor == 0) {
 144             fprintf(stderr, "error opening the conversion context\n");
 145             exit(1);
 146         }
 147     }
 148
 149     /* Get the conversion descriptor back to original state */
 150     iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
 151
 152     /* Convert our text */
 153     int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
 154     if (rc == (size_t)-1) {
 155         perror("Converting to UCS-2 failed");
 156         FREE(buffer);
 157         if (real_strlen != NULL)
 158             *real_strlen = 0;
 159         return NULL;
 160     }
 161
 162     if (real_strlen != NULL)
 163         *real_strlen = ((buffer_size - output_size) / 2) - 1;
 164
 165     return buffer;
 166 }
 167
 168 /*
 169  * This function resolves ~ in pathnames.
 170  * It may resolve wildcards in the first part of the path, but if no match
 171  * or multiple matches are found, it just returns a copy of path as given.
 172  *
 173  */
 174 char *resolve_tilde(const char *path) {
 175         static glob_t globbuf;
 176         char *head, *tail, *result;
 177
 178         tail = strchr(path, '/');
 179         head = strndup(path, tail ? tail - path : strlen(path));
 180
 181         int res = glob(head, GLOB_TILDE, NULL, &globbuf);
 182         free(head);
 183         /* no match, or many wildcard matches are bad */
 184         if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
 185                 result = sstrdup(path);
 186         else if (res != 0) {
 187                 die("glob() failed");
 188         } else {
 189                 head = globbuf.gl_pathv[0];
 190                 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
 191                 strncpy(result, head, strlen(head));
 192                 if (tail)
 193                     strncat(result, tail, strlen(tail));
 194         }
 195         globfree(&globbuf);
 196
 197         return result;
 198 }
 199
 200 /*
 201  * Checks if the given path exists by calling stat().
 202  *
 203  */
 204 bool path_exists(const char *path) {
 205         struct stat buf;
 206         return (stat(path, &buf) == 0);
 207 }
 208
 209 /*
 210  * Goes through the list of arguments (for exec()) and checks if the given argument
 211  * is present. If not, it copies the arguments (because we cannot realloc it) and
 212  * appends the given argument.
 213  *
 214  */
 215 static char **append_argument(char **original, char *argument) {
 216     int num_args;
 217     for (num_args = 0; original[num_args] != NULL; num_args++) {
 218         DLOG("original argument: \"%s\"\n", original[num_args]);
 219         /* If the argument is already present we return the original pointer */
 220         if (strcmp(original[num_args], argument) == 0)
 221             return original;
 222     }
 223     /* Copy the original array */
 224     char **result = smalloc((num_args+2) * sizeof(char*));
 225     memcpy(result, original, num_args * sizeof(char*));
 226     result[num_args] = argument;
 227     result[num_args+1] = NULL;
 228
 229     return result;
 230 }
 231
 232 /*
 233  * Returns the name of a temporary file with the specified prefix.
 234  *
 235  */
 236 char *get_process_filename(const char *prefix) {
 237     /* dir stores the directory path for this and all subsequent calls so that
 238      * we only create a temporary directory once per i3 instance. */
 239     static char *dir = NULL;
 240     if (dir == NULL) {
 241         /* Check if XDG_RUNTIME_DIR is set. If so, we use XDG_RUNTIME_DIR/i3 */
 242         if ((dir = getenv("XDG_RUNTIME_DIR"))) {
 243             char *tmp;
 244             sasprintf(&tmp, "%s/i3", dir);
 245             dir = tmp;
 246             if (!path_exists(dir)) {
 247                 if (mkdir(dir, 0700) == -1) {
 248                     perror("mkdir()");
 249                     return NULL;
 250                 }
 251             }
 252         } else {
 253             /* If not, we create a (secure) temp directory using the template
 254              * /tmp/i3-<user>.XXXXXX */
 255             struct passwd *pw = getpwuid(getuid());
 256             const char *username = pw ? pw->pw_name : "unknown";
 257             sasprintf(&dir, "/tmp/i3-%s.XXXXXX", username);
 258             /* mkdtemp modifies dir */
 259             if (mkdtemp(dir) == NULL) {
 260                 perror("mkdtemp()");
 261                 return NULL;
 262             }
 263         }
 264     }
 265     char *filename;
 266     sasprintf(&filename, "%s/%s.%d", dir, prefix, getpid());
 267     return filename;
 268 }
 269
 270 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
 271 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
 272
 273 char *store_restart_layout() {
 274     setlocale(LC_NUMERIC, "C");
 275 #if YAJL_MAJOR >= 2
 276     yajl_gen gen = yajl_gen_alloc(NULL);
 277 #else
 278     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 279 #endif
 280
 281     dump_node(gen, croot, true);
 282
 283     setlocale(LC_NUMERIC, "");
 284
 285     const unsigned char *payload;
 286 #if YAJL_MAJOR >= 2
 287     size_t length;
 288 #else
 289     unsigned int length;
 290 #endif
 291     y(get_buf, &payload, &length);
 292
 293     /* create a temporary file if one hasn't been specified, or just
 294      * resolve the tildes in the specified path */
 295     char *filename;
 296     if (config.restart_state_path == NULL) {
 297         filename = get_process_filename("restart-state");
 298         if (!filename)
 299             return NULL;
 300     } else {
 301         filename = resolve_tilde(config.restart_state_path);
 302     }
 303
 304     int fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
 305     if (fd == -1) {
 306         perror("open()");
 307         free(filename);
 308         return NULL;
 309     }
 310
 311     int written = 0;
 312     while (written < length) {
 313         int n = write(fd, payload + written, length - written);
 314         /* TODO: correct error-handling */
 315         if (n == -1) {
 316             perror("write()");
 317             free(filename);
 318             close(fd);
 319             return NULL;
 320         }
 321         if (n == 0) {
 322             printf("write == 0?\n");
 323             free(filename);
 324             close(fd);
 325             return NULL;
 326         }
 327         written += n;
 328 #if YAJL_MAJOR >= 2
 329         printf("written: %d of %zd\n", written, length);
 330 #else
 331         printf("written: %d of %d\n", written, length);
 332 #endif
 333     }
 334     close(fd);
 335
 336     if (length > 0) {
 337         printf("layout: %.*s\n", (int)length, payload);
 338     }
 339
 340     y(free);
 341
 342     return filename;
 343 }
 344
 345 /*
 346  * Restart i3 in-place
 347  * appends -a to argument list to disable autostart
 348  *
 349  */
 350 void i3_restart(bool forget_layout) {
 351     char *restart_filename = forget_layout ? NULL : store_restart_layout();
 352
 353     kill_configerror_nagbar(true);
 354
 355     restore_geometry();
 356
 357     ipc_shutdown();
 358
 359     LOG("restarting \"%s\"...\n", start_argv[0]);
 360     /* make sure -a is in the argument list or append it */
 361     start_argv = append_argument(start_argv, "-a");
 362
 363     /* replace -r <file> so that the layout is restored */
 364     if (restart_filename != NULL) {
 365         /* create the new argv */
 366         int num_args;
 367         for (num_args = 0; start_argv[num_args] != NULL; num_args++);
 368         char **new_argv = scalloc((num_args + 3) * sizeof(char*));
 369
 370         /* copy the arguments, but skip the ones we'll replace */
 371         int write_index = 0;
 372         bool skip_next = false;
 373         for (int i = 0; i < num_args; ++i) {
 374             if (skip_next)
 375                 skip_next = false;
 376             else if (!strcmp(start_argv[i], "-r") ||
 377                      !strcmp(start_argv[i], "--restart"))
 378                 skip_next = true;
 379             else
 380                 new_argv[write_index++] = start_argv[i];
 381         }
 382
 383         /* add the arguments we'll replace */
 384         new_argv[write_index++] = "--restart";
 385         new_argv[write_index] = restart_filename;
 386
 387         /* swap the argvs */
 388         start_argv = new_argv;
 389     }
 390
 391     execvp(start_argv[0], start_argv);
 392     /* not reached */
 393 }
 394
 395 #if defined(__OpenBSD__) || defined(__APPLE__)
 396
 397 /*
 398  * Taken from FreeBSD
 399  * Find the first occurrence of the byte string s in byte string l.
 400  *
 401  */
 402 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
 403     register char *cur, *last;
 404     const char *cl = (const char *)l;
 405     const char *cs = (const char *)s;
 406
 407     /* we need something to compare */
 408     if (l_len == 0 || s_len == 0)
 409         return NULL;
 410
 411     /* "s" must be smaller or equal to "l" */
 412     if (l_len < s_len)
 413         return NULL;
 414
 415     /* special case where s_len == 1 */
 416     if (s_len == 1)
 417         return memchr(l, (int)*cs, l_len);
 418
 419     /* the last position where its possible to find "s" in "l" */
 420     last = (char *)cl + l_len - s_len;
 421
 422     for (cur = (char *)cl; cur <= last; cur++)
 423         if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)
 424             return cur;
 425
 426     return NULL;
 427 }
 428
 429 #endif