]> git.sur5r.net Git - i3/i3/blob - src/util.c
Merge branch 'fix-baf'
[i3/i3] / 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     char *dir = getenv("XDG_RUNTIME_DIR");
238     if (dir == NULL) {
239         struct passwd *pw = getpwuid(getuid());
240         const char *username = pw ? pw->pw_name : "unknown";
241         sasprintf(&dir, "/tmp/i3-%s", username);
242     } else {
243         char *tmp;
244         sasprintf(&tmp, "%s/i3", dir);
245         dir = tmp;
246     }
247     if (!path_exists(dir)) {
248         if (mkdir(dir, 0700) == -1) {
249             perror("mkdir()");
250             return NULL;
251         }
252     }
253     char *filename;
254     sasprintf(&filename, "%s/%s.%d", dir, prefix, getpid());
255     free(dir);
256     return filename;
257 }
258
259 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
260 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
261
262 char *store_restart_layout() {
263     setlocale(LC_NUMERIC, "C");
264 #if YAJL_MAJOR >= 2
265     yajl_gen gen = yajl_gen_alloc(NULL);
266 #else
267     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
268 #endif
269
270     dump_node(gen, croot, true);
271
272     setlocale(LC_NUMERIC, "");
273
274     const unsigned char *payload;
275 #if YAJL_MAJOR >= 2
276     size_t length;
277 #else
278     unsigned int length;
279 #endif
280     y(get_buf, &payload, &length);
281
282     /* create a temporary file if one hasn't been specified, or just
283      * resolve the tildes in the specified path */
284     char *filename;
285     if (config.restart_state_path == NULL) {
286         filename = get_process_filename("restart-state");
287         if (!filename)
288             return NULL;
289     } else {
290         filename = resolve_tilde(config.restart_state_path);
291     }
292
293     int fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
294     if (fd == -1) {
295         perror("open()");
296         free(filename);
297         return NULL;
298     }
299
300     int written = 0;
301     while (written < length) {
302         int n = write(fd, payload + written, length - written);
303         /* TODO: correct error-handling */
304         if (n == -1) {
305             perror("write()");
306             free(filename);
307             close(fd);
308             return NULL;
309         }
310         if (n == 0) {
311             printf("write == 0?\n");
312             free(filename);
313             close(fd);
314             return NULL;
315         }
316         written += n;
317 #if YAJL_MAJOR >= 2
318         printf("written: %d of %zd\n", written, length);
319 #else
320         printf("written: %d of %d\n", written, length);
321 #endif
322     }
323     close(fd);
324
325     if (length > 0) {
326         printf("layout: %.*s\n", (int)length, payload);
327     }
328
329     y(free);
330
331     return filename;
332 }
333
334 /*
335  * Restart i3 in-place
336  * appends -a to argument list to disable autostart
337  *
338  */
339 void i3_restart(bool forget_layout) {
340     char *restart_filename = forget_layout ? NULL : store_restart_layout();
341
342     kill_configerror_nagbar(true);
343
344     restore_geometry();
345
346     ipc_shutdown();
347
348     LOG("restarting \"%s\"...\n", start_argv[0]);
349     /* make sure -a is in the argument list or append it */
350     start_argv = append_argument(start_argv, "-a");
351
352     /* replace -r <file> so that the layout is restored */
353     if (restart_filename != NULL) {
354         /* create the new argv */
355         int num_args;
356         for (num_args = 0; start_argv[num_args] != NULL; num_args++);
357         char **new_argv = scalloc((num_args + 3) * sizeof(char*));
358
359         /* copy the arguments, but skip the ones we'll replace */
360         int write_index = 0;
361         bool skip_next = false;
362         for (int i = 0; i < num_args; ++i) {
363             if (skip_next)
364                 skip_next = false;
365             else if (!strcmp(start_argv[i], "-r") ||
366                      !strcmp(start_argv[i], "--restart"))
367                 skip_next = true;
368             else
369                 new_argv[write_index++] = start_argv[i];
370         }
371
372         /* add the arguments we'll replace */
373         new_argv[write_index++] = "--restart";
374         new_argv[write_index] = restart_filename;
375
376         /* swap the argvs */
377         start_argv = new_argv;
378     }
379
380     execvp(start_argv[0], start_argv);
381     /* not reached */
382 }
383
384 #if defined(__OpenBSD__) || defined(__APPLE__)
385
386 /*
387  * Taken from FreeBSD
388  * Find the first occurrence of the byte string s in byte string l.
389  *
390  */
391 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
392     register char *cur, *last;
393     const char *cl = (const char *)l;
394     const char *cs = (const char *)s;
395
396     /* we need something to compare */
397     if (l_len == 0 || s_len == 0)
398         return NULL;
399
400     /* "s" must be smaller or equal to "l" */
401     if (l_len < s_len)
402         return NULL;
403
404     /* special case where s_len == 1 */
405     if (s_len == 1)
406         return memchr(l, (int)*cs, l_len);
407
408     /* the last position where its possible to find "s" in "l" */
409     last = (char *)cl + l_len - s_len;
410
411     for (cur = (char *)cl; cur <= last; cur++)
412         if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)
413             return cur;
414
415     return NULL;
416 }
417
418 #endif