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