1 /* $OpenBSD$ */
2
3 /*
4 * Copyright (c) 2011 Nicholas Marriott <nicholas.marriott@gmail.com>
5 *
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19 #include <sys/types.h>
20 #include <sys/param.h>
21 #include <sys/wait.h>
22
23 #include <ctype.h>
24 #include <errno.h>
25 #include <libgen.h>
26 #include <netdb.h>
27 #include <stdarg.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <time.h>
31 #include <unistd.h>
32
33 #include "tmux.h"
34
35 /*
36 * Build a list of key-value pairs and use them to expand #{key} entries in a
37 * string.
38 */
39
40 struct format_entry;
41 typedef void (*format_cb)(struct format_tree *, struct format_entry *);
42
43 void format_job_callback(struct job *);
44 char *format_job_get(struct format_tree *, const char *);
45 void format_job_timer(int, short, void *);
46
47 void format_cb_host(struct format_tree *, struct format_entry *);
48 void format_cb_host_short(struct format_tree *, struct format_entry *);
49 void format_cb_pid(struct format_tree *, struct format_entry *);
50 void format_cb_session_alerts(struct format_tree *, struct format_entry *);
51 void format_cb_window_layout(struct format_tree *, struct format_entry *);
52 void format_cb_window_visible_layout(struct format_tree *,
53 struct format_entry *);
54 void format_cb_start_command(struct format_tree *, struct format_entry *);
55 void format_cb_current_command(struct format_tree *, struct format_entry *);
56 void format_cb_current_path(struct format_tree *, struct format_entry *);
57 void format_cb_history_bytes(struct format_tree *, struct format_entry *);
58 void format_cb_pane_tabs(struct format_tree *, struct format_entry *);
59
60 char *format_find(struct format_tree *, const char *, int);
61 void format_add_cb(struct format_tree *, const char *, format_cb);
62 void format_add_tv(struct format_tree *, const char *, struct timeval *);
63 int format_replace(struct format_tree *, const char *, size_t, char **,
64 size_t *, size_t *);
65 char *format_time_string(time_t);
66
67 void format_defaults_pane_tabs(struct format_tree *, struct window_pane *);
68 void format_defaults_session(struct format_tree *, struct session *);
69 void format_defaults_client(struct format_tree *, struct client *);
70 void format_defaults_winlink(struct format_tree *, struct session *,
71 struct winlink *);
72
73 /* Entry in format job tree. */
74 struct format_job {
75 const char *cmd;
76
77 time_t last;
78 char *out;
79
80 struct job *job;
81 int status;
82
83 RB_ENTRY(format_job) entry;
84 };
85
86 /* Format job tree. */
87 struct event format_job_event;
88 int format_job_cmp(struct format_job *, struct format_job *);
89 RB_HEAD(format_job_tree, format_job) format_jobs = RB_INITIALIZER();
90 RB_PROTOTYPE(format_job_tree, format_job, entry, format_job_cmp);
91 RB_GENERATE(format_job_tree, format_job, entry, format_job_cmp);
92
93 /* Format job tree comparison function. */
94 int
format_job_cmp(struct format_job * fj1,struct format_job * fj2)95 format_job_cmp(struct format_job *fj1, struct format_job *fj2)
96 {
97 return (strcmp(fj1->cmd, fj2->cmd));
98 }
99
100 /* Format modifiers. */
101 #define FORMAT_TIMESTRING 0x1
102 #define FORMAT_BASENAME 0x2
103 #define FORMAT_DIRNAME 0x4
104 #define FORMAT_SUBSTITUTE 0x8
105
106 /* Entry in format tree. */
107 struct format_entry {
108 char *key;
109 char *value;
110 time_t t;
111 format_cb cb;
112 RB_ENTRY(format_entry) entry;
113 };
114
115 /* Format entry tree. */
116 struct format_tree {
117 struct window *w;
118 struct session *s;
119 struct window_pane *wp;
120
121 int flags;
122
123 RB_HEAD(format_entry_tree, format_entry) tree;
124 };
125 int format_entry_cmp(struct format_entry *, struct format_entry *);
126 RB_PROTOTYPE(format_entry_tree, format_entry, entry, format_entry_cmp);
127 RB_GENERATE(format_entry_tree, format_entry, entry, format_entry_cmp);
128
129 /* Format entry tree comparison function. */
130 int
format_entry_cmp(struct format_entry * fe1,struct format_entry * fe2)131 format_entry_cmp(struct format_entry *fe1, struct format_entry *fe2)
132 {
133 return (strcmp(fe1->key, fe2->key));
134 }
135
136 /* Single-character uppercase aliases. */
137 const char *format_upper[] = {
138 NULL, /* A */
139 NULL, /* B */
140 NULL, /* C */
141 "pane_id", /* D */
142 NULL, /* E */
143 "window_flags", /* F */
144 NULL, /* G */
145 "host", /* H */
146 "window_index", /* I */
147 NULL, /* J */
148 NULL, /* K */
149 NULL, /* L */
150 NULL, /* M */
151 NULL, /* N */
152 NULL, /* O */
153 "pane_index", /* P */
154 NULL, /* Q */
155 NULL, /* R */
156 "session_name", /* S */
157 "pane_title", /* T */
158 NULL, /* U */
159 NULL, /* V */
160 "window_name", /* W */
161 NULL, /* X */
162 NULL, /* Y */
163 NULL /* Z */
164 };
165
166 /* Single-character lowercase aliases. */
167 const char *format_lower[] = {
168 NULL, /* a */
169 NULL, /* b */
170 NULL, /* c */
171 NULL, /* d */
172 NULL, /* e */
173 NULL, /* f */
174 NULL, /* g */
175 "host_short", /* h */
176 NULL, /* i */
177 NULL, /* j */
178 NULL, /* k */
179 NULL, /* l */
180 NULL, /* m */
181 NULL, /* n */
182 NULL, /* o */
183 NULL, /* p */
184 NULL, /* q */
185 NULL, /* r */
186 NULL, /* s */
187 NULL, /* t */
188 NULL, /* u */
189 NULL, /* v */
190 NULL, /* w */
191 NULL, /* x */
192 NULL, /* y */
193 NULL /* z */
194 };
195
196 /* Format job callback. */
197 void
format_job_callback(struct job * job)198 format_job_callback(struct job *job)
199 {
200 struct format_job *fj = job->data;
201 char *line, *buf;
202 size_t len;
203 struct client *c;
204
205 fj->job = NULL;
206 free(fj->out);
207
208 buf = NULL;
209 if ((line = evbuffer_readline(job->event->input)) == NULL) {
210 len = EVBUFFER_LENGTH(job->event->input);
211 buf = xmalloc(len + 1);
212 if (len != 0)
213 memcpy(buf, EVBUFFER_DATA(job->event->input), len);
214 buf[len] = '\0';
215 } else
216 buf = line;
217 fj->out = buf;
218
219 if (fj->status) {
220 TAILQ_FOREACH(c, &clients, entry)
221 server_status_client(c);
222 fj->status = 0;
223 }
224
225 log_debug("%s: %s: %s", __func__, fj->cmd, fj->out);
226 }
227
228 /* Find a job. */
229 char *
format_job_get(struct format_tree * ft,const char * cmd)230 format_job_get(struct format_tree *ft, const char *cmd)
231 {
232 struct format_job fj0, *fj;
233 time_t t;
234
235 fj0.cmd = cmd;
236 if ((fj = RB_FIND(format_job_tree, &format_jobs, &fj0)) == NULL) {
237 fj = xcalloc(1, sizeof *fj);
238 fj->cmd = xstrdup(cmd);
239
240 xasprintf(&fj->out, "<'%s' not ready>", fj->cmd);
241
242 RB_INSERT(format_job_tree, &format_jobs, fj);
243 }
244
245 t = time(NULL);
246 if (fj->job == NULL && ((ft->flags & FORMAT_FORCE) || fj->last != t)) {
247 fj->job = job_run(fj->cmd, NULL, NULL, format_job_callback,
248 NULL, fj);
249 if (fj->job == NULL) {
250 free(fj->out);
251 xasprintf(&fj->out, "<'%s' didn't start>", fj->cmd);
252 }
253 fj->last = t;
254 }
255
256 if (ft->flags & FORMAT_STATUS)
257 fj->status = 1;
258
259 return (format_expand(ft, fj->out));
260 }
261
262 /* Remove old jobs. */
263 void
format_job_timer(__unused int fd,__unused short events,__unused void * arg)264 format_job_timer(__unused int fd, __unused short events, __unused void *arg)
265 {
266 struct format_job *fj, *fj1;
267 time_t now;
268 struct timeval tv = { .tv_sec = 60 };
269
270 now = time(NULL);
271 RB_FOREACH_SAFE(fj, format_job_tree, &format_jobs, fj1) {
272 if (fj->last > now || now - fj->last < 3600)
273 continue;
274 RB_REMOVE(format_job_tree, &format_jobs, fj);
275
276 log_debug("%s: %s", __func__, fj->cmd);
277
278 if (fj->job != NULL)
279 job_free(fj->job);
280
281 free((void *)fj->cmd);
282 free(fj->out);
283
284 free(fj);
285 }
286
287 evtimer_del(&format_job_event);
288 evtimer_add(&format_job_event, &tv);
289 }
290
291 /* Callback for host. */
292 void
format_cb_host(__unused struct format_tree * ft,struct format_entry * fe)293 format_cb_host(__unused struct format_tree *ft, struct format_entry *fe)
294 {
295 char host[HOST_NAME_MAX + 1];
296
297 if (gethostname(host, sizeof host) != 0)
298 fe->value = xstrdup("");
299 else
300 fe->value = xstrdup(host);
301 }
302
303 /* Callback for host_short. */
304 void
format_cb_host_short(__unused struct format_tree * ft,struct format_entry * fe)305 format_cb_host_short(__unused struct format_tree *ft, struct format_entry *fe)
306 {
307 char host[HOST_NAME_MAX + 1], *cp;
308
309 if (gethostname(host, sizeof host) != 0)
310 fe->value = xstrdup("");
311 else {
312 if ((cp = strchr(host, '.')) != NULL)
313 *cp = '\0';
314 fe->value = xstrdup(host);
315 }
316 }
317
318 /* Callback for pid. */
319 void
format_cb_pid(__unused struct format_tree * ft,struct format_entry * fe)320 format_cb_pid(__unused struct format_tree *ft, struct format_entry *fe)
321 {
322 xasprintf(&fe->value, "%ld", (long)getpid());
323 }
324
325 /* Callback for session_alerts. */
326 void
format_cb_session_alerts(struct format_tree * ft,struct format_entry * fe)327 format_cb_session_alerts(struct format_tree *ft, struct format_entry *fe)
328 {
329 struct session *s = ft->s;
330 struct winlink *wl;
331 char alerts[256], tmp[16];
332
333 if (s == NULL)
334 return;
335
336 *alerts = '\0';
337 RB_FOREACH(wl, winlinks, &s->windows) {
338 if ((wl->flags & WINLINK_ALERTFLAGS) == 0)
339 continue;
340 xsnprintf(tmp, sizeof tmp, "%u", wl->idx);
341
342 if (*alerts != '\0')
343 strlcat(alerts, ",", sizeof alerts);
344 strlcat(alerts, tmp, sizeof alerts);
345 if (wl->flags & WINLINK_ACTIVITY)
346 strlcat(alerts, "#", sizeof alerts);
347 if (wl->flags & WINLINK_BELL)
348 strlcat(alerts, "!", sizeof alerts);
349 if (wl->flags & WINLINK_SILENCE)
350 strlcat(alerts, "~", sizeof alerts);
351 }
352 fe->value = xstrdup(alerts);
353 }
354
355 /* Callback for window_layout. */
356 void
format_cb_window_layout(struct format_tree * ft,struct format_entry * fe)357 format_cb_window_layout(struct format_tree *ft, struct format_entry *fe)
358 {
359 struct window *w = ft->w;
360
361 if (w == NULL)
362 return;
363
364 if (w->saved_layout_root != NULL)
365 fe->value = layout_dump(w->saved_layout_root);
366 else
367 fe->value = layout_dump(w->layout_root);
368 }
369
370 /* Callback for window_visible_layout. */
371 void
format_cb_window_visible_layout(struct format_tree * ft,struct format_entry * fe)372 format_cb_window_visible_layout(struct format_tree *ft, struct format_entry *fe)
373 {
374 struct window *w = ft->w;
375
376 if (w == NULL)
377 return;
378
379 fe->value = layout_dump(w->layout_root);
380 }
381
382 /* Callback for pane_start_command. */
383 void
format_cb_start_command(struct format_tree * ft,struct format_entry * fe)384 format_cb_start_command(struct format_tree *ft, struct format_entry *fe)
385 {
386 struct window_pane *wp = ft->wp;
387
388 if (wp == NULL)
389 return;
390
391 fe->value = cmd_stringify_argv(wp->argc, wp->argv);
392 }
393
394 /* Callback for pane_current_command. */
395 void
format_cb_current_command(struct format_tree * ft,struct format_entry * fe)396 format_cb_current_command(struct format_tree *ft, struct format_entry *fe)
397 {
398 struct window_pane *wp = ft->wp;
399 char *cmd;
400
401 if (wp == NULL)
402 return;
403
404 cmd = osdep_get_name(wp->fd, wp->tty);
405 if (cmd == NULL || *cmd == '\0') {
406 free(cmd);
407 cmd = cmd_stringify_argv(wp->argc, wp->argv);
408 if (cmd == NULL || *cmd == '\0') {
409 free(cmd);
410 cmd = xstrdup(wp->shell);
411 }
412 }
413 fe->value = parse_window_name(cmd);
414 free(cmd);
415 }
416
417 /* Callback for pane_current_path. */
418 void
format_cb_current_path(struct format_tree * ft,struct format_entry * fe)419 format_cb_current_path(struct format_tree *ft, struct format_entry *fe)
420 {
421 struct window_pane *wp = ft->wp;
422 char *cwd;
423
424 if (wp == NULL)
425 return;
426
427 cwd = osdep_get_cwd(wp->fd);
428 if (cwd != NULL)
429 fe->value = xstrdup(cwd);
430 }
431
432 /* Callback for history_bytes. */
433 void
format_cb_history_bytes(struct format_tree * ft,struct format_entry * fe)434 format_cb_history_bytes(struct format_tree *ft, struct format_entry *fe)
435 {
436 struct window_pane *wp = ft->wp;
437 struct grid *gd;
438 struct grid_line *gl;
439 unsigned long long size;
440 u_int i;
441
442 if (wp == NULL)
443 return;
444 gd = wp->base.grid;
445
446 size = 0;
447 for (i = 0; i < gd->hsize; i++) {
448 gl = &gd->linedata[i];
449 size += gl->cellsize * sizeof *gl->celldata;
450 size += gl->extdsize * sizeof *gl->extddata;
451 }
452 size += gd->hsize * sizeof *gd->linedata;
453
454 xasprintf(&fe->value, "%llu", size);
455 }
456
457 /* Callback for pane_tabs. */
458 void
format_cb_pane_tabs(struct format_tree * ft,struct format_entry * fe)459 format_cb_pane_tabs(struct format_tree *ft, struct format_entry *fe)
460 {
461 struct window_pane *wp = ft->wp;
462 struct evbuffer *buffer;
463 u_int i;
464 int size;
465
466 if (wp == NULL)
467 return;
468
469 buffer = evbuffer_new();
470 for (i = 0; i < wp->base.grid->sx; i++) {
471 if (!bit_test(wp->base.tabs, i))
472 continue;
473
474 if (EVBUFFER_LENGTH(buffer) > 0)
475 evbuffer_add(buffer, ",", 1);
476 evbuffer_add_printf(buffer, "%u", i);
477 }
478 size = EVBUFFER_LENGTH(buffer);
479 xasprintf(&fe->value, "%.*s", size, EVBUFFER_DATA(buffer));
480 evbuffer_free(buffer);
481 }
482
483 /* Create a new tree. */
484 struct format_tree *
format_create(struct cmd_q * cmdq,int flags)485 format_create(struct cmd_q *cmdq, int flags)
486 {
487 struct format_tree *ft;
488 struct cmd *cmd;
489
490 if (!event_initialized(&format_job_event)) {
491 evtimer_set(&format_job_event, format_job_timer, NULL);
492 format_job_timer(-1, 0, NULL);
493 }
494
495 ft = xcalloc(1, sizeof *ft);
496 RB_INIT(&ft->tree);
497 ft->flags = flags;
498
499 format_add_cb(ft, "host", format_cb_host);
500 format_add_cb(ft, "host_short", format_cb_host_short);
501 format_add_cb(ft, "pid", format_cb_pid);
502 format_add(ft, "socket_path", "%s", socket_path);
503 format_add_tv(ft, "start_time", &start_time);
504
505 if (cmdq != NULL && cmdq->cmd != NULL)
506 format_add(ft, "command_name", "%s", cmdq->cmd->entry->name);
507 if (cmdq != NULL && cmdq->parent != NULL) {
508 cmd = cmdq->parent->cmd;
509 format_add(ft, "command_hooked", "%s", cmd->entry->name);
510 }
511
512 return (ft);
513 }
514
515 /* Free a tree. */
516 void
format_free(struct format_tree * ft)517 format_free(struct format_tree *ft)
518 {
519 struct format_entry *fe, *fe1;
520
521 RB_FOREACH_SAFE(fe, format_entry_tree, &ft->tree, fe1) {
522 RB_REMOVE(format_entry_tree, &ft->tree, fe);
523 free(fe->value);
524 free(fe->key);
525 free(fe);
526 }
527
528 free(ft);
529 }
530
531 /* Add a key-value pair. */
532 void
format_add(struct format_tree * ft,const char * key,const char * fmt,...)533 format_add(struct format_tree *ft, const char *key, const char *fmt, ...)
534 {
535 struct format_entry *fe;
536 struct format_entry *fe_now;
537 va_list ap;
538
539 fe = xmalloc(sizeof *fe);
540 fe->key = xstrdup(key);
541
542 fe_now = RB_INSERT(format_entry_tree, &ft->tree, fe);
543 if (fe_now != NULL) {
544 free(fe->key);
545 free(fe);
546 free(fe_now->value);
547 fe = fe_now;
548 }
549
550 fe->cb = NULL;
551 fe->t = 0;
552
553 va_start(ap, fmt);
554 xvasprintf(&fe->value, fmt, ap);
555 va_end(ap);
556 }
557
558 /* Add a key and time. */
559 void
format_add_tv(struct format_tree * ft,const char * key,struct timeval * tv)560 format_add_tv(struct format_tree *ft, const char *key, struct timeval *tv)
561 {
562 struct format_entry *fe;
563 struct format_entry *fe_now;
564
565 fe = xmalloc(sizeof *fe);
566 fe->key = xstrdup(key);
567
568 fe_now = RB_INSERT(format_entry_tree, &ft->tree, fe);
569 if (fe_now != NULL) {
570 free(fe->key);
571 free(fe);
572 free(fe_now->value);
573 fe = fe_now;
574 }
575
576 fe->cb = NULL;
577 fe->t = tv->tv_sec;
578
579 fe->value = NULL;
580 }
581
582 /* Add a key and function. */
583 void
format_add_cb(struct format_tree * ft,const char * key,format_cb cb)584 format_add_cb(struct format_tree *ft, const char *key, format_cb cb)
585 {
586 struct format_entry *fe;
587 struct format_entry *fe_now;
588
589 fe = xmalloc(sizeof *fe);
590 fe->key = xstrdup(key);
591
592 fe_now = RB_INSERT(format_entry_tree, &ft->tree, fe);
593 if (fe_now != NULL) {
594 free(fe->key);
595 free(fe);
596 free(fe_now->value);
597 fe = fe_now;
598 }
599
600 fe->cb = cb;
601 fe->t = 0;
602
603 fe->value = NULL;
604 }
605
606 /* Find a format entry. */
607 char *
format_find(struct format_tree * ft,const char * key,int modifiers)608 format_find(struct format_tree *ft, const char *key, int modifiers)
609 {
610 struct format_entry *fe, fe_find;
611 struct options_entry *o;
612 struct environ_entry *envent;
613 static char s[64];
614 const char *found;
615 char *copy, *saved;
616
617 found = NULL;
618
619 if (~modifiers & FORMAT_TIMESTRING) {
620 o = options_find(global_options, key);
621 if (o == NULL && ft->w != NULL)
622 o = options_find(ft->w->options, key);
623 if (o == NULL)
624 o = options_find(global_w_options, key);
625 if (o == NULL && ft->s != NULL)
626 o = options_find(ft->s->options, key);
627 if (o == NULL)
628 o = options_find(global_s_options, key);
629 if (o != NULL) {
630 switch (o->type) {
631 case OPTIONS_STRING:
632 found = o->str;
633 goto found;
634 case OPTIONS_NUMBER:
635 xsnprintf(s, sizeof s, "%lld", o->num);
636 found = s;
637 goto found;
638 case OPTIONS_STYLE:
639 found = style_tostring(&o->style);
640 goto found;
641 }
642 }
643 }
644
645 fe_find.key = (char *) key;
646 fe = RB_FIND(format_entry_tree, &ft->tree, &fe_find);
647 if (fe != NULL) {
648 if (modifiers & FORMAT_TIMESTRING) {
649 if (fe->t == 0)
650 return (NULL);
651 ctime_r(&fe->t, s);
652 s[strcspn(s, "\n")] = '\0';
653 found = s;
654 goto found;
655 }
656 if (fe->t != 0) {
657 xsnprintf(s, sizeof s, "%lld", (long long)fe->t);
658 found = s;
659 goto found;
660 }
661 if (fe->value == NULL && fe->cb != NULL)
662 fe->cb(ft, fe);
663 found = fe->value;
664 goto found;
665 }
666
667 if (~modifiers & FORMAT_TIMESTRING) {
668 envent = NULL;
669 if (ft->s != NULL)
670 envent = environ_find(ft->s->environ, key);
671 if (envent == NULL)
672 envent = environ_find(global_environ, key);
673 if (envent != NULL) {
674 found = envent->value;
675 goto found;
676 }
677 }
678
679 return (NULL);
680
681 found:
682 if (found == NULL)
683 return (NULL);
684 copy = xstrdup(found);
685 if (modifiers & FORMAT_BASENAME) {
686 saved = copy;
687 copy = xstrdup(basename(saved));
688 free(saved);
689 }
690 if (modifiers & FORMAT_DIRNAME) {
691 saved = copy;
692 copy = xstrdup(dirname(saved));
693 free(saved);
694 }
695 return (copy);
696 }
697
698 /*
699 * Replace a key/value pair in buffer. #{blah} is expanded directly,
700 * #{?blah,a,b} is replace with a if blah exists and is nonzero else b.
701 */
702 int
format_replace(struct format_tree * ft,const char * key,size_t keylen,char ** buf,size_t * len,size_t * off)703 format_replace(struct format_tree *ft, const char *key, size_t keylen,
704 char **buf, size_t *len, size_t *off)
705 {
706 char *copy, *copy0, *endptr, *ptr, *found, *new, *value;
707 char *from = NULL, *to = NULL;
708 size_t valuelen, newlen, fromlen, tolen, used;
709 long limit = 0;
710 int modifiers = 0, brackets;
711
712 /* Make a copy of the key. */
713 copy0 = copy = xmalloc(keylen + 1);
714 memcpy(copy, key, keylen);
715 copy[keylen] = '\0';
716
717 /* Is there a length limit or whatnot? */
718 switch (copy[0]) {
719 case '=':
720 errno = 0;
721 limit = strtol(copy + 1, &endptr, 10);
722 if (errno == ERANGE && (limit == LONG_MIN || limit == LONG_MAX))
723 break;
724 if (*endptr != ':')
725 break;
726 copy = endptr + 1;
727 break;
728 case 'b':
729 if (copy[1] != ':')
730 break;
731 modifiers |= FORMAT_BASENAME;
732 copy += 2;
733 break;
734 case 'd':
735 if (copy[1] != ':')
736 break;
737 modifiers |= FORMAT_DIRNAME;
738 copy += 2;
739 break;
740 case 't':
741 if (copy[1] != ':')
742 break;
743 modifiers |= FORMAT_TIMESTRING;
744 copy += 2;
745 break;
746 case 's':
747 if (copy[1] != '/')
748 break;
749 from = copy + 2;
750 for (copy = from; *copy != '\0' && *copy != '/'; copy++)
751 /* nothing */;
752 if (copy[0] != '/' || copy == from) {
753 copy = copy0;
754 break;
755 }
756 copy[0] = '\0';
757 to = copy + 1;
758 for (copy = to; *copy != '\0' && *copy != '/'; copy++)
759 /* nothing */;
760 if (copy[0] != '/' || copy[1] != ':') {
761 copy = copy0;
762 break;
763 }
764 copy[0] = '\0';
765
766 modifiers |= FORMAT_SUBSTITUTE;
767 copy += 2;
768 break;
769 }
770
771 /*
772 * Is this a conditional? If so, check it exists and extract either the
773 * first or second element. If not, look up the key directly.
774 */
775 if (*copy == '?') {
776 ptr = strchr(copy, ',');
777 if (ptr == NULL)
778 goto fail;
779 *ptr = '\0';
780
781 value = ptr + 1;
782 found = format_find(ft, copy + 1, modifiers);
783
784 brackets = 0;
785 for (ptr = ptr + 1; *ptr != '\0'; ptr++) {
786 if (*ptr == '{')
787 brackets++;
788 if (*ptr == '}')
789 brackets--;
790 if (*ptr == ',' && brackets == 0)
791 break;
792 }
793 if (*ptr == '\0')
794 goto fail;
795
796 if (found != NULL && *found != '\0' &&
797 (found[0] != '0' || found[1] != '\0')) {
798 *ptr = '\0';
799 } else
800 value = ptr + 1;
801 value = format_expand(ft, value);
802 free(found);
803 } else {
804 value = format_find(ft, copy, modifiers);
805 if (value == NULL)
806 value = xstrdup("");
807 }
808
809 /* Perform substitution if any. */
810 if (modifiers & FORMAT_SUBSTITUTE) {
811 fromlen = strlen(from);
812 tolen = strlen(to);
813
814 newlen = strlen(value) + 1;
815 copy = new = xmalloc(newlen);
816 for (ptr = value; *ptr != '\0'; /* nothing */) {
817 if (strncmp(ptr, from, fromlen) != 0) {
818 *new++ = *ptr++;
819 continue;
820 }
821 used = new - copy;
822
823 newlen += tolen;
824 copy = xrealloc(copy, newlen);
825
826 new = copy + used;
827 memcpy(new, to, tolen);
828
829 new += tolen;
830 ptr += fromlen;
831 }
832 *new = '\0';
833 free(value);
834 value = copy;
835 }
836
837 /* Truncate the value if needed. */
838 if (limit > 0) {
839 new = utf8_trimcstr(value, limit);
840 free(value);
841 value = new;
842 } else if (limit < 0) {
843 new = utf8_rtrimcstr(value, -limit);
844 free(value);
845 value = new;
846 }
847
848 /* Expand the buffer and copy in the value. */
849 valuelen = strlen(value);
850 while (*len - *off < valuelen + 1) {
851 *buf = xreallocarray(*buf, 2, *len);
852 *len *= 2;
853 }
854 memcpy(*buf + *off, value, valuelen);
855 *off += valuelen;
856
857 free(value);
858 free(copy0);
859 return (0);
860
861 fail:
862 free(copy0);
863 return (-1);
864 }
865
866 /* Expand keys in a template, passing through strftime first. */
867 char *
format_expand_time(struct format_tree * ft,const char * fmt,time_t t)868 format_expand_time(struct format_tree *ft, const char *fmt, time_t t)
869 {
870 struct tm *tm;
871 char s[2048];
872
873 if (fmt == NULL || *fmt == '\0')
874 return (xstrdup(""));
875
876 tm = localtime(&t);
877
878 if (strftime(s, sizeof s, fmt, tm) == 0)
879 return (xstrdup(""));
880
881 return (format_expand(ft, s));
882 }
883
884 /* Expand keys in a template. */
885 char *
format_expand(struct format_tree * ft,const char * fmt)886 format_expand(struct format_tree *ft, const char *fmt)
887 {
888 char *buf, *tmp, *cmd, *out;
889 const char *ptr, *s, *saved = fmt;
890 size_t off, len, n, outlen;
891 int ch, brackets;
892
893 if (fmt == NULL)
894 return (xstrdup(""));
895
896 len = 64;
897 buf = xmalloc(len);
898 off = 0;
899
900 while (*fmt != '\0') {
901 if (*fmt != '#') {
902 while (len - off < 2) {
903 buf = xreallocarray(buf, 2, len);
904 len *= 2;
905 }
906 buf[off++] = *fmt++;
907 continue;
908 }
909 fmt++;
910
911 ch = (u_char) *fmt++;
912 switch (ch) {
913 case '(':
914 brackets = 1;
915 for (ptr = fmt; *ptr != '\0'; ptr++) {
916 if (*ptr == '(')
917 brackets++;
918 if (*ptr == ')' && --brackets == 0)
919 break;
920 }
921 if (*ptr != ')' || brackets != 0)
922 break;
923 n = ptr - fmt;
924
925 tmp = xmalloc(n + 1);
926 memcpy(tmp, fmt, n);
927 tmp[n] = '\0';
928 cmd = format_expand(ft, tmp);
929
930 out = format_job_get(ft, cmd);
931 outlen = strlen(out);
932
933 free(cmd);
934 free(tmp);
935
936 while (len - off < outlen + 1) {
937 buf = xreallocarray(buf, 2, len);
938 len *= 2;
939 }
940 memcpy(buf + off, out, outlen);
941 off += outlen;
942
943 free(out);
944
945 fmt += n + 1;
946 continue;
947 case '{':
948 brackets = 1;
949 for (ptr = fmt; *ptr != '\0'; ptr++) {
950 if (*ptr == '{')
951 brackets++;
952 if (*ptr == '}' && --brackets == 0)
953 break;
954 }
955 if (*ptr != '}' || brackets != 0)
956 break;
957 n = ptr - fmt;
958
959 if (format_replace(ft, fmt, n, &buf, &len, &off) != 0)
960 break;
961 fmt += n + 1;
962 continue;
963 case '#':
964 while (len - off < 2) {
965 buf = xreallocarray(buf, 2, len);
966 len *= 2;
967 }
968 buf[off++] = '#';
969 continue;
970 default:
971 s = NULL;
972 if (ch >= 'A' && ch <= 'Z')
973 s = format_upper[ch - 'A'];
974 else if (ch >= 'a' && ch <= 'z')
975 s = format_lower[ch - 'a'];
976 if (s == NULL) {
977 while (len - off < 3) {
978 buf = xreallocarray(buf, 2, len);
979 len *= 2;
980 }
981 buf[off++] = '#';
982 buf[off++] = ch;
983 continue;
984 }
985 n = strlen(s);
986 if (format_replace(ft, s, n, &buf, &len, &off) != 0)
987 break;
988 continue;
989 }
990
991 break;
992 }
993 buf[off] = '\0';
994
995 log_debug("format '%s' -> '%s'", saved, buf);
996 return (buf);
997 }
998
999 /* Set defaults for any of arguments that are not NULL. */
1000 void
format_defaults(struct format_tree * ft,struct client * c,struct session * s,struct winlink * wl,struct window_pane * wp)1001 format_defaults(struct format_tree *ft, struct client *c, struct session *s,
1002 struct winlink *wl, struct window_pane *wp)
1003 {
1004 if (s == NULL && c != NULL)
1005 s = c->session;
1006 if (wl == NULL && s != NULL)
1007 wl = s->curw;
1008 if (wp == NULL && wl != NULL)
1009 wp = wl->window->active;
1010
1011 if (c != NULL)
1012 format_defaults_client(ft, c);
1013 if (s != NULL)
1014 format_defaults_session(ft, s);
1015 if (s != NULL && wl != NULL)
1016 format_defaults_winlink(ft, s, wl);
1017 if (wp != NULL)
1018 format_defaults_pane(ft, wp);
1019 }
1020
1021 /* Set default format keys for a session. */
1022 void
format_defaults_session(struct format_tree * ft,struct session * s)1023 format_defaults_session(struct format_tree *ft, struct session *s)
1024 {
1025 struct session_group *sg;
1026
1027 ft->s = s;
1028
1029 format_add(ft, "session_name", "%s", s->name);
1030 format_add(ft, "session_windows", "%u", winlink_count(&s->windows));
1031 format_add(ft, "session_width", "%u", s->sx);
1032 format_add(ft, "session_height", "%u", s->sy);
1033 format_add(ft, "session_id", "$%u", s->id);
1034
1035 sg = session_group_find(s);
1036 format_add(ft, "session_grouped", "%d", sg != NULL);
1037 if (sg != NULL)
1038 format_add(ft, "session_group", "%u", session_group_index(sg));
1039
1040 format_add_tv(ft, "session_created", &s->creation_time);
1041 format_add_tv(ft, "session_last_attached", &s->last_attached_time);
1042 format_add_tv(ft, "session_activity", &s->activity_time);
1043
1044 format_add(ft, "session_attached", "%u", s->attached);
1045 format_add(ft, "session_many_attached", "%d", s->attached > 1);
1046
1047 format_add_cb(ft, "session_alerts", format_cb_session_alerts);
1048 }
1049
1050 /* Set default format keys for a client. */
1051 void
format_defaults_client(struct format_tree * ft,struct client * c)1052 format_defaults_client(struct format_tree *ft, struct client *c)
1053 {
1054 struct session *s;
1055 const char *name;
1056
1057 if (ft->s == NULL)
1058 ft->s = c->session;
1059
1060 format_add(ft, "client_pid", "%ld", (long) c->pid);
1061 format_add(ft, "client_height", "%u", c->tty.sy);
1062 format_add(ft, "client_width", "%u", c->tty.sx);
1063 if (c->tty.path != NULL)
1064 format_add(ft, "client_tty", "%s", c->tty.path);
1065 if (c->tty.termname != NULL)
1066 format_add(ft, "client_termname", "%s", c->tty.termname);
1067 format_add(ft, "client_control_mode", "%d",
1068 !!(c->flags & CLIENT_CONTROL));
1069
1070 format_add_tv(ft, "client_created", &c->creation_time);
1071 format_add_tv(ft, "client_activity", &c->activity_time);
1072
1073 name = server_client_get_key_table(c);
1074 if (strcmp(c->keytable->name, name) == 0)
1075 format_add(ft, "client_prefix", "%d", 0);
1076 else
1077 format_add(ft, "client_prefix", "%d", 1);
1078 format_add(ft, "client_key_table", "%s", c->keytable->name);
1079
1080 if (c->tty.flags & TTY_UTF8)
1081 format_add(ft, "client_utf8", "%d", 1);
1082 else
1083 format_add(ft, "client_utf8", "%d", 0);
1084
1085 if (c->flags & CLIENT_READONLY)
1086 format_add(ft, "client_readonly", "%d", 1);
1087 else
1088 format_add(ft, "client_readonly", "%d", 0);
1089
1090 s = c->session;
1091 if (s != NULL)
1092 format_add(ft, "client_session", "%s", s->name);
1093 s = c->last_session;
1094 if (s != NULL && session_alive(s))
1095 format_add(ft, "client_last_session", "%s", s->name);
1096 }
1097
1098 /* Set default format keys for a window. */
1099 void
format_defaults_window(struct format_tree * ft,struct window * w)1100 format_defaults_window(struct format_tree *ft, struct window *w)
1101 {
1102 ft->w = w;
1103
1104 format_add_tv(ft, "window_activity", &w->activity_time);
1105 format_add(ft, "window_id", "@%u", w->id);
1106 format_add(ft, "window_name", "%s", w->name);
1107 format_add(ft, "window_width", "%u", w->sx);
1108 format_add(ft, "window_height", "%u", w->sy);
1109 format_add_cb(ft, "window_layout", format_cb_window_layout);
1110 format_add_cb(ft, "window_visible_layout",
1111 format_cb_window_visible_layout);
1112 format_add(ft, "window_panes", "%u", window_count_panes(w));
1113 format_add(ft, "window_zoomed_flag", "%d",
1114 !!(w->flags & WINDOW_ZOOMED));
1115 }
1116
1117 /* Set default format keys for a winlink. */
1118 void
format_defaults_winlink(struct format_tree * ft,struct session * s,struct winlink * wl)1119 format_defaults_winlink(struct format_tree *ft, struct session *s,
1120 struct winlink *wl)
1121 {
1122 struct window *w = wl->window;
1123 char *flags;
1124
1125 if (ft->w == NULL)
1126 ft->w = wl->window;
1127
1128 flags = window_printable_flags(s, wl);
1129
1130 format_defaults_window(ft, w);
1131
1132 format_add(ft, "window_index", "%d", wl->idx);
1133 format_add(ft, "window_flags", "%s", flags);
1134 format_add(ft, "window_active", "%d", wl == s->curw);
1135
1136 format_add(ft, "window_bell_flag", "%d",
1137 !!(wl->flags & WINLINK_BELL));
1138 format_add(ft, "window_activity_flag", "%d",
1139 !!(wl->flags & WINLINK_ACTIVITY));
1140 format_add(ft, "window_silence_flag", "%d",
1141 !!(wl->flags & WINLINK_SILENCE));
1142 format_add(ft, "window_last_flag", "%d",
1143 !!(wl == TAILQ_FIRST(&s->lastw)));
1144 format_add(ft, "window_linked", "%d", session_is_linked(s, wl->window));
1145
1146 free(flags);
1147 }
1148
1149 /* Set default format keys for a window pane. */
1150 void
format_defaults_pane(struct format_tree * ft,struct window_pane * wp)1151 format_defaults_pane(struct format_tree *ft, struct window_pane *wp)
1152 {
1153 struct grid *gd = wp->base.grid;
1154 u_int idx;
1155 int status, scroll_position;
1156
1157 if (ft->w == NULL)
1158 ft->w = wp->window;
1159 ft->wp = wp;
1160
1161 format_add(ft, "history_size", "%u", gd->hsize);
1162 format_add(ft, "history_limit", "%u", gd->hlimit);
1163 format_add_cb(ft, "history_bytes", format_cb_history_bytes);
1164
1165 if (window_pane_index(wp, &idx) != 0)
1166 fatalx("index not found");
1167 format_add(ft, "pane_index", "%u", idx);
1168
1169 format_add(ft, "pane_width", "%u", wp->sx);
1170 format_add(ft, "pane_height", "%u", wp->sy);
1171 format_add(ft, "pane_title", "%s", wp->base.title);
1172 format_add(ft, "pane_id", "%%%u", wp->id);
1173 format_add(ft, "pane_active", "%d", wp == wp->window->active);
1174 format_add(ft, "pane_input_off", "%d", !!(wp->flags & PANE_INPUTOFF));
1175
1176 status = wp->status;
1177 if (wp->fd == -1 && WIFEXITED(status))
1178 format_add(ft, "pane_dead_status", "%d", WEXITSTATUS(status));
1179 format_add(ft, "pane_dead", "%d", wp->fd == -1);
1180
1181 if (window_pane_visible(wp)) {
1182 format_add(ft, "pane_left", "%u", wp->xoff);
1183 format_add(ft, "pane_top", "%u", wp->yoff);
1184 format_add(ft, "pane_right", "%u", wp->xoff + wp->sx - 1);
1185 format_add(ft, "pane_bottom", "%u", wp->yoff + wp->sy - 1);
1186 }
1187
1188 format_add(ft, "pane_in_mode", "%d", wp->screen != &wp->base);
1189 format_add(ft, "pane_synchronized", "%d",
1190 !!options_get_number(wp->window->options, "synchronize-panes"));
1191
1192 format_add(ft, "pane_tty", "%s", wp->tty);
1193 format_add(ft, "pane_pid", "%ld", (long) wp->pid);
1194 format_add_cb(ft, "pane_start_command", format_cb_start_command);
1195 format_add_cb(ft, "pane_current_command", format_cb_current_command);
1196 format_add_cb(ft, "pane_current_path", format_cb_current_path);
1197
1198 format_add(ft, "cursor_x", "%u", wp->base.cx);
1199 format_add(ft, "cursor_y", "%u", wp->base.cy);
1200 format_add(ft, "scroll_region_upper", "%u", wp->base.rupper);
1201 format_add(ft, "scroll_region_lower", "%u", wp->base.rlower);
1202
1203 scroll_position = window_copy_scroll_position(wp);
1204 if (scroll_position != -1)
1205 format_add(ft, "scroll_position", "%d", scroll_position);
1206
1207 format_add(ft, "alternate_on", "%d", wp->saved_grid ? 1 : 0);
1208 format_add(ft, "alternate_saved_x", "%u", wp->saved_cx);
1209 format_add(ft, "alternate_saved_y", "%u", wp->saved_cy);
1210
1211 format_add(ft, "cursor_flag", "%d",
1212 !!(wp->base.mode & MODE_CURSOR));
1213 format_add(ft, "insert_flag", "%d",
1214 !!(wp->base.mode & MODE_INSERT));
1215 format_add(ft, "keypad_cursor_flag", "%d",
1216 !!(wp->base.mode & MODE_KCURSOR));
1217 format_add(ft, "keypad_flag", "%d",
1218 !!(wp->base.mode & MODE_KKEYPAD));
1219 format_add(ft, "wrap_flag", "%d",
1220 !!(wp->base.mode & MODE_WRAP));
1221
1222 format_add(ft, "mouse_any_flag", "%d",
1223 !!(wp->base.mode & (MODE_MOUSE_STANDARD|MODE_MOUSE_BUTTON)));
1224 format_add(ft, "mouse_standard_flag", "%d",
1225 !!(wp->base.mode & MODE_MOUSE_STANDARD));
1226 format_add(ft, "mouse_button_flag", "%d",
1227 !!(wp->base.mode & MODE_MOUSE_BUTTON));
1228
1229 format_add_cb(ft, "pane_tabs", format_cb_pane_tabs);
1230 }
1231
1232 /* Set default format keys for paste buffer. */
1233 void
format_defaults_paste_buffer(struct format_tree * ft,struct paste_buffer * pb)1234 format_defaults_paste_buffer(struct format_tree *ft, struct paste_buffer *pb)
1235 {
1236 size_t bufsize;
1237 char *s;
1238
1239 paste_buffer_data(pb, &bufsize);
1240 format_add(ft, "buffer_size", "%zu", bufsize);
1241 format_add(ft, "buffer_name", "%s", paste_buffer_name(pb));
1242
1243 s = paste_make_sample(pb);
1244 format_add(ft, "buffer_sample", "%s", s);
1245 free(s);
1246 }
1247