i3
startup.c
Go to the documentation of this file.
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-2012 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 
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 is determined by looking for the SHELL environment variable. If it
127  * does not exist, /bin/sh is used.
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;
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(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 */
162  struct Startup_Sequence *sequence = scalloc(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;
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)
205  else
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)
250  else
252  }
253  break;
254  default:
255  /* ignore */
256  break;
257  }
258 }
259 
265  xcb_get_property_reply_t *startup_id_reply, bool ignore_mapped_leader) {
266  /* The _NET_STARTUP_ID is only needed during this function, so we get it
267  * here and don’t save it in the 'cwindow'. */
268  if (startup_id_reply == NULL || xcb_get_property_value_length(startup_id_reply) == 0) {
269  FREE(startup_id_reply);
270  DLOG("No _NET_STARTUP_ID set on window 0x%08x\n", cwindow->id);
271  if (cwindow->leader == XCB_NONE)
272  return NULL;
273 
274  /* This is a special case that causes the leader's startup sequence
275  * to only be returned if it has never been mapped, useful primarily
276  * when trying to delete a sequence.
277  *
278  * It's generally inappropriate to delete a leader's sequence when
279  * moving a child window, but if the leader has no container, it's
280  * likely permanently unmapped and the child is the "real" window. */
281  if (ignore_mapped_leader && con_by_window_id(cwindow->leader) != NULL) {
282  DLOG("Ignoring leader window 0x%08x\n", cwindow->leader);
283  return NULL;
284  }
285 
286  DLOG("Checking leader window 0x%08x\n", cwindow->leader);
287 
288  xcb_get_property_cookie_t cookie;
289 
290  cookie = xcb_get_property(conn, false, cwindow->leader,
291  A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
292  startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
293 
294  if (startup_id_reply == NULL ||
295  xcb_get_property_value_length(startup_id_reply) == 0) {
296  FREE(startup_id_reply);
297  DLOG("No _NET_STARTUP_ID set on the leader either\n");
298  return NULL;
299  }
300  }
301 
302  char *startup_id;
303  if (asprintf(&startup_id, "%.*s", xcb_get_property_value_length(startup_id_reply),
304  (char *)xcb_get_property_value(startup_id_reply)) == -1) {
305  perror("asprintf()");
306  DLOG("Could not get _NET_STARTUP_ID\n");
307  free(startup_id_reply);
308  return NULL;
309  }
310 
311  struct Startup_Sequence *current, *sequence = NULL;
312  TAILQ_FOREACH (current, &startup_sequences, sequences) {
313  if (strcmp(current->id, startup_id) != 0)
314  continue;
315 
316  sequence = current;
317  break;
318  }
319 
320  if (!sequence) {
321  DLOG("WARNING: This sequence (ID %s) was not found\n", startup_id);
322  free(startup_id);
323  free(startup_id_reply);
324  return NULL;
325  }
326 
327  free(startup_id);
328  free(startup_id_reply);
329 
330  return sequence;
331 }
332 
333 /*
334  * Checks if the given window belongs to a startup notification by checking if
335  * the _NET_STARTUP_ID property is set on the window (or on its leader, if it’s
336  * unset).
337  *
338  * If so, returns the workspace on which the startup was initiated.
339  * Returns NULL otherwise.
340  *
341  */
342 char *startup_workspace_for_window(i3Window *cwindow, xcb_get_property_reply_t *startup_id_reply) {
343  struct Startup_Sequence *sequence = startup_sequence_get(cwindow, startup_id_reply, false);
344  if (sequence == NULL)
345  return NULL;
346 
347  /* If the startup sequence's time span has elapsed, delete it. */
348  time_t current_time = time(NULL);
349  if (sequence->delete_at > 0 && current_time > sequence->delete_at) {
350  DLOG("Deleting expired startup sequence %s\n", sequence->id);
351  startup_sequence_delete(sequence);
352  return NULL;
353  }
354 
355  return sequence->workspace;
356 }
#define SD_LISTEN_FDS_START
Definition: sd-daemon.h:102
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
int listen_fds
The number of file descriptors passed via socket activation.
Definition: main.c:33
#define TAILQ_REMOVE(head, elm, field)
Definition: queue.h:386
xcb_connection_t * conn
Definition: main.c:47
SnDisplay * sndisplay
Definition: main.c:52
Con * con_get_workspace(Con *con)
Gets the workspace container this node is on.
Definition: con.c:317
static struct context * context
Definition: config_parser.c:47
#define LOG(fmt,...)
Definition: libi3.h:76
static int _prune_startup_sequences(void)
Definition: startup.c:72
time_t delete_at
time at which this sequence should be deleted (after it was marked as completed)
Definition: data.h:201
struct ev_loop * main_loop
Definition: main.c:69
#define TAILQ_FIRST(head)
Definition: queue.h:323
xcb_timestamp_t last_timestamp
The last timestamp we got from X11 (timestamps are included in some events and are used for some thin...
Definition: main.c:57
#define TAILQ_NEXT(elm, field)
Definition: queue.h:325
A &#39;Window&#39; is a type which contains an xcb_window_t and all the related information (hints like _NET_...
Definition: data.h:332
bool xcursor_supported
Definition: main.c:96
Con * con_by_window_id(xcb_window_t window)
Returns the container with the given client window ID or NULL if no such container exists...
Definition: con.c:461
#define DLOG(fmt,...)
Definition: libi3.h:86
void startup_sequence_delete(struct Startup_Sequence *sequence)
Deletes a startup sequence, ignoring whether its timeout has elapsed.
Definition: startup.c:104
struct Startup_Sequence * startup_sequence_get(i3Window *cwindow, xcb_get_property_reply_t *startup_id_reply, bool ignore_mapped_leader)
Gets the stored startup sequence for the _NET_STARTUP_ID of a given window.
Definition: startup.c:264
Con * focused
Definition: tree.c:15
char * name
Definition: data.h:520
void xcursor_set_root_cursor(int cursor_id)
Sets the cursor of the root window to the &#39;pointer&#39; cursor.
Definition: xcursor.c:57
char * startup_workspace_for_window(i3Window *cwindow, xcb_get_property_reply_t *startup_id_reply)
Checks if the given window belongs to a startup notification by checking if the _NET_STARTUP_ID prope...
Definition: startup.c:342
A &#39;Con&#39; represents everything from the X11 root window down to a single X11 window.
Definition: data.h:479
void xcb_set_root_cursor(int cursor)
Set the cursor of the root window to the given cursor id.
Definition: xcb.c:194
void * scalloc(size_t size)
Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory a...
#define TAILQ_END(head)
Definition: queue.h:324
#define TAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:362
void startup_monitor_event(SnMonitorEvent *event, void *userdata)
Called by libstartup-notification when something happens.
Definition: startup.c:214
#define TAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:311
void start_application(const char *command, bool no_startup_id)
Starts the given application by passing it through a shell.
Definition: startup.c:133
xcb_window_t id
Definition: data.h:333
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:334
char * id
startup ID for this sequence, generated by libstartup-notification
Definition: data.h:194
xcb_window_t leader
Holds the xcb_window_t (just an ID) for the leader window (logical parent for toolwindows and similar...
Definition: data.h:337
SnLauncherContext * context
libstartup-notification context for this launch
Definition: data.h:198
struct rlimit original_rlimit_core
The original value of RLIMIT_CORE when i3 was started.
Definition: main.c:30
#define FREE(pointer)
Definition: util.h:46
#define TAILQ_HEAD(name, type)
Definition: queue.h:305
char * workspace
workspace on which this startup was initiated
Definition: data.h:196
Stores internal information about a startup sequence, like the workspace it was initiated on...
Definition: data.h:192
int conn_screen
Definition: main.c:49