]> git.sur5r.net Git - i3/i3/blob - src/startup.c
Merge pull request #2190 from jolange/userguide
[i3/i3] / src / startup.c
1 #undef I3__FILE__
2 #define I3__FILE__ "startup.c"
3 /*
4  * vim:ts=4:sw=4:expandtab
5  *
6  * i3 - an improved dynamic tiling window manager
7  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
8  *
9  * startup.c: Startup notification code. Ensures a startup notification context
10  *            is setup when launching applications. We store the current
11  *            workspace to open windows in that startup notification context on
12  *            the appropriate workspace.
13  *
14  */
15 #include "all.h"
16 #include "sd-daemon.h"
17
18 #include <sys/types.h>
19 #include <sys/wait.h>
20 #include <paths.h>
21
22 #define SN_API_NOT_YET_FROZEN 1
23 #include <libsn/sn-launcher.h>
24
25 static TAILQ_HEAD(startup_sequence_head, Startup_Sequence) startup_sequences =
26     TAILQ_HEAD_INITIALIZER(startup_sequences);
27
28 /*
29  * After 60 seconds, a timeout will be triggered for each startup sequence.
30  *
31  * The timeout will just trigger completion of the sequence, so the normal
32  * completion process takes place (startup_monitor_event will free it).
33  *
34  */
35 static void startup_timeout(EV_P_ ev_timer *w, int revents) {
36     const char *id = sn_launcher_context_get_startup_id(w->data);
37     DLOG("Timeout for startup sequence %s\n", id);
38
39     struct Startup_Sequence *current, *sequence = NULL;
40     TAILQ_FOREACH(current, &startup_sequences, sequences) {
41         if (strcmp(current->id, id) != 0)
42             continue;
43
44         sequence = current;
45         break;
46     }
47
48     /* Unref the context (for the timeout itself, see start_application) */
49     sn_launcher_context_unref(w->data);
50
51     if (!sequence) {
52         DLOG("Sequence already deleted, nevermind.\n");
53         return;
54     }
55
56     /* Complete the startup sequence, will trigger its deletion. */
57     sn_launcher_context_complete(w->data);
58     free(w);
59 }
60
61 /*
62  * Some applications (such as Firefox) mark a startup sequence as completed
63  * *before* they even map a window. Therefore, we cannot entirely delete the
64  * startup sequence once it’s marked as complete. Instead, we’ll mark it for
65  * deletion in 30 seconds and use that chance to delete old sequences.
66  *
67  * This function returns the number of active (!) startup notifications, that
68  * is, those which are not marked for deletion yet. This is used for changing
69  * the root window cursor.
70  *
71  */
72 static int _prune_startup_sequences(void) {
73     time_t current_time = time(NULL);
74     int active_sequences = 0;
75
76     /* Traverse the list and delete everything which was marked for deletion 30
77      * seconds ago or earlier. */
78     struct Startup_Sequence *current, *next;
79     for (next = TAILQ_FIRST(&startup_sequences);
80          next != TAILQ_END(&startup_sequences);) {
81         current = next;
82         next = TAILQ_NEXT(next, sequences);
83
84         if (current->delete_at == 0) {
85             active_sequences++;
86             continue;
87         }
88
89         if (current_time <= current->delete_at)
90             continue;
91
92         startup_sequence_delete(current);
93     }
94
95     return active_sequences;
96 }
97
98 /**
99  * Deletes a startup sequence, ignoring whether its timeout has elapsed.
100  * Useful when e.g. a window is moved between workspaces and its children
101  * shouldn't spawn on the original workspace.
102  *
103  */
104 void startup_sequence_delete(struct Startup_Sequence *sequence) {
105     assert(sequence != NULL);
106     DLOG("Deleting startup sequence %s, delete_at = %ld, current_time = %ld\n",
107          sequence->id, sequence->delete_at, time(NULL));
108
109     /* Unref the context, will be free()d */
110     sn_launcher_context_unref(sequence->context);
111
112     /* Delete our internal sequence */
113     TAILQ_REMOVE(&startup_sequences, sequence, sequences);
114
115     free(sequence->id);
116     free(sequence->workspace);
117     FREE(sequence);
118 }
119
120 /*
121  * Starts the given application by passing it through a shell. We use double fork
122  * to avoid zombie processes. As the started application’s parent exits (immediately),
123  * the application is reparented to init (process-id 1), which correctly handles
124  * childs, so we don’t have to do it :-).
125  *
126  * The shell used to start applications is the system's bourne shell (i.e.,
127  * /bin/sh).
128  *
129  * The no_startup_id flag determines whether a startup notification context
130  * (and ID) should be created, which is the default and encouraged behavior.
131  *
132  */
133 void start_application(const char *command, bool no_startup_id) {
134     SnLauncherContext *context = NULL;
135
136     if (!no_startup_id) {
137         /* Create a startup notification context to monitor the progress of this
138          * startup. */
139         context = sn_launcher_context_new(sndisplay, conn_screen);
140         sn_launcher_context_set_name(context, "i3");
141         sn_launcher_context_set_description(context, "exec command in i3");
142         /* Chop off everything starting from the first space (if there are any
143          * spaces in the command), since we don’t want the parameters. */
144         char *first_word = sstrdup(command);
145         char *space = strchr(first_word, ' ');
146         if (space)
147             *space = '\0';
148         sn_launcher_context_initiate(context, "i3", first_word, last_timestamp);
149         free(first_word);
150
151         /* Trigger a timeout after 60 seconds */
152         struct ev_timer *timeout = scalloc(1, sizeof(struct ev_timer));
153         ev_timer_init(timeout, startup_timeout, 60.0, 0.);
154         timeout->data = context;
155         ev_timer_start(main_loop, timeout);
156
157         LOG("startup id = %s\n", sn_launcher_context_get_startup_id(context));
158
159         /* Save the ID and current workspace in our internal list of startup
160          * sequences */
161         Con *ws = con_get_workspace(focused);
162         struct Startup_Sequence *sequence = scalloc(1, sizeof(struct Startup_Sequence));
163         sequence->id = sstrdup(sn_launcher_context_get_startup_id(context));
164         sequence->workspace = sstrdup(ws->name);
165         sequence->context = context;
166         TAILQ_INSERT_TAIL(&startup_sequences, sequence, sequences);
167
168         /* Increase the refcount once (it starts with 1, so it will be 2 now) for
169          * the timeout. Even if the sequence gets completed, the timeout still
170          * needs the context (but will unref it then) */
171         sn_launcher_context_ref(context);
172     }
173
174     LOG("executing: %s\n", command);
175     if (fork() == 0) {
176         /* Child process */
177         setsid();
178         setrlimit(RLIMIT_CORE, &original_rlimit_core);
179         /* Close all socket activation file descriptors explicitly, we disabled
180          * FD_CLOEXEC to keep them open when restarting i3. */
181         for (int fd = SD_LISTEN_FDS_START;
182              fd < (SD_LISTEN_FDS_START + listen_fds);
183              fd++) {
184             close(fd);
185         }
186         unsetenv("LISTEN_PID");
187         unsetenv("LISTEN_FDS");
188         signal(SIGPIPE, SIG_DFL);
189         if (fork() == 0) {
190             /* Setup the environment variable(s) */
191             if (!no_startup_id)
192                 sn_launcher_context_setup_child_process(context);
193
194             execl(_PATH_BSHELL, _PATH_BSHELL, "-c", command, (void *)NULL);
195             /* not reached */
196         }
197         _exit(0);
198     }
199     wait(0);
200
201     if (!no_startup_id) {
202         /* Change the pointer of the root window to indicate progress */
203         if (xcursor_supported)
204             xcursor_set_root_cursor(XCURSOR_CURSOR_WATCH);
205         else
206             xcb_set_root_cursor(XCURSOR_CURSOR_WATCH);
207     }
208 }
209
210 /*
211  * Called by libstartup-notification when something happens
212  *
213  */
214 void startup_monitor_event(SnMonitorEvent *event, void *userdata) {
215     SnStartupSequence *snsequence;
216
217     snsequence = sn_monitor_event_get_startup_sequence(event);
218
219     /* Get the corresponding internal startup sequence */
220     const char *id = sn_startup_sequence_get_id(snsequence);
221     struct Startup_Sequence *current, *sequence = NULL;
222     TAILQ_FOREACH(current, &startup_sequences, sequences) {
223         if (strcmp(current->id, id) != 0)
224             continue;
225
226         sequence = current;
227         break;
228     }
229
230     if (!sequence) {
231         DLOG("Got event for startup sequence that we did not initiate (ID = %s). Ignoring.\n", id);
232         return;
233     }
234
235     switch (sn_monitor_event_get_type(event)) {
236         case SN_MONITOR_EVENT_COMPLETED:
237             DLOG("startup sequence %s completed\n", sn_startup_sequence_get_id(snsequence));
238
239             /* Mark the given sequence for deletion in 30 seconds. */
240             time_t current_time = time(NULL);
241             sequence->delete_at = current_time + 30;
242             DLOG("Will delete startup sequence %s at timestamp %ld\n",
243                  sequence->id, sequence->delete_at);
244
245             if (_prune_startup_sequences() == 0) {
246                 DLOG("No more startup sequences running, changing root window cursor to default pointer.\n");
247                 /* Change the pointer of the root window to indicate progress */
248                 if (xcursor_supported)
249                     xcursor_set_root_cursor(XCURSOR_CURSOR_POINTER);
250                 else
251                     xcb_set_root_cursor(XCURSOR_CURSOR_POINTER);
252             }
253             break;
254         default:
255             /* ignore */
256             break;
257     }
258 }
259
260 /**
261  * Renames workspaces that are mentioned in the startup sequences.
262  *
263  */
264 void startup_sequence_rename_workspace(const char *old_name, const char *new_name) {
265     struct Startup_Sequence *current;
266     TAILQ_FOREACH(current, &startup_sequences, sequences) {
267         if (strcmp(current->workspace, old_name) != 0)
268             continue;
269         DLOG("Renaming workspace \"%s\" to \"%s\" in startup sequence %s.\n",
270              old_name, new_name, current->id);
271         free(current->workspace);
272         current->workspace = sstrdup(new_name);
273     }
274 }
275
276 /**
277  * Gets the stored startup sequence for the _NET_STARTUP_ID of a given window.
278  *
279  */
280 struct Startup_Sequence *startup_sequence_get(i3Window *cwindow,
281                                               xcb_get_property_reply_t *startup_id_reply, bool ignore_mapped_leader) {
282     /* The _NET_STARTUP_ID is only needed during this function, so we get it
283      * here and don’t save it in the 'cwindow'. */
284     if (startup_id_reply == NULL || xcb_get_property_value_length(startup_id_reply) == 0) {
285         FREE(startup_id_reply);
286         DLOG("No _NET_STARTUP_ID set on window 0x%08x\n", cwindow->id);
287         if (cwindow->leader == XCB_NONE)
288             return NULL;
289
290         /* This is a special case that causes the leader's startup sequence
291          * to only be returned if it has never been mapped, useful primarily
292          * when trying to delete a sequence.
293          *
294          * It's generally inappropriate to delete a leader's sequence when
295          * moving a child window, but if the leader has no container, it's
296          * likely permanently unmapped and the child is the "real" window. */
297         if (ignore_mapped_leader && con_by_window_id(cwindow->leader) != NULL) {
298             DLOG("Ignoring leader window 0x%08x\n", cwindow->leader);
299             return NULL;
300         }
301
302         DLOG("Checking leader window 0x%08x\n", cwindow->leader);
303
304         xcb_get_property_cookie_t cookie;
305
306         cookie = xcb_get_property(conn, false, cwindow->leader,
307                                   A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
308         startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
309
310         if (startup_id_reply == NULL ||
311             xcb_get_property_value_length(startup_id_reply) == 0) {
312             FREE(startup_id_reply);
313             DLOG("No _NET_STARTUP_ID set on the leader either\n");
314             return NULL;
315         }
316     }
317
318     char *startup_id;
319     sasprintf(&startup_id, "%.*s", xcb_get_property_value_length(startup_id_reply),
320               (char *)xcb_get_property_value(startup_id_reply));
321     struct Startup_Sequence *current, *sequence = NULL;
322     TAILQ_FOREACH(current, &startup_sequences, sequences) {
323         if (strcmp(current->id, startup_id) != 0)
324             continue;
325
326         sequence = current;
327         break;
328     }
329
330     if (!sequence) {
331         DLOG("WARNING: This sequence (ID %s) was not found\n", startup_id);
332         free(startup_id);
333         free(startup_id_reply);
334         return NULL;
335     }
336
337     free(startup_id);
338     free(startup_id_reply);
339
340     return sequence;
341 }
342
343 /*
344  * Checks if the given window belongs to a startup notification by checking if
345  * the _NET_STARTUP_ID property is set on the window (or on its leader, if it’s
346  * unset).
347  *
348  * If so, returns the workspace on which the startup was initiated.
349  * Returns NULL otherwise.
350  *
351  */
352 char *startup_workspace_for_window(i3Window *cwindow, xcb_get_property_reply_t *startup_id_reply) {
353     struct Startup_Sequence *sequence = startup_sequence_get(cwindow, startup_id_reply, false);
354     if (sequence == NULL)
355         return NULL;
356
357     /* If the startup sequence's time span has elapsed, delete it. */
358     time_t current_time = time(NULL);
359     if (sequence->delete_at > 0 && current_time > sequence->delete_at) {
360         DLOG("Deleting expired startup sequence %s\n", sequence->id);
361         startup_sequence_delete(sequence);
362         return NULL;
363     }
364
365     return sequence->workspace;
366 }