op public repos

Blob

Date:: Sun Apr 24 12:14:54 2022 UTC
Message:: move load session stuff to session.c
Actions:: History | Blame | Raw File
1 /*
2  * Copyright (c) 2021 Omar Polo <op@omarpolo.com>
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #include "compat.h"
18 
19 #include <errno.h>
20 #include <fcntl.h>
21 #include <limits.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <time.h>
26 #include <unistd.h>
27 
28 #include "defaults.h"
29 #include "fs.h"
30 #include "minibuffer.h"
31 #include "session.h"
32 #include "ui.h"
33 
34 struct history	history;
35 
36 static struct event	 autosaveev;
37 
38 void
39 switch_to_tab(struct tab *tab)
40 {
41 	current_tab = tab;
42 	tab->flags &= ~TAB_URGENT;
43 
44 	if (operating && tab->flags & TAB_LAZY)
45 		load_url_in_tab(tab, tab->hist_cur->h, NULL, LU_MODE_NOHIST);
46 }
47 
48 unsigned int
49 tab_new_id(void)
50 {
51 	static uint32_t tab_counter;
52 
53 	return tab_counter++;
54 }
55 
56 struct tab *
57 new_tab(const char *url, const char *base, struct tab *after)
58 {
59 	struct tab	*tab;
60 
61 	ui_schedule_redraw();
62 	autosave_hook();
63 
64 	if ((tab = calloc(1, sizeof(*tab))) == NULL) {
65 		event_loopbreak();
66 		return NULL;
67 	}
68 
69 	TAILQ_INIT(&tab->hist.head);
70 	TAILQ_INIT(&tab->buffer.head);
71 	TAILQ_INIT(&tab->buffer.page.head);
72 	evtimer_set(&tab->loadingev, NULL, NULL);
73 
74 	tab->id = tab_new_id();
75 
76 	if (after != NULL)
77 		TAILQ_INSERT_AFTER(&tabshead, after, tab, tabs);
78 	else
79 		TAILQ_INSERT_TAIL(&tabshead, tab, tabs);
80 
81 	if (!operating)
82 		tab->flags |= TAB_LAZY;
83 	load_url_in_tab(tab, url, base, 0);
84 	switch_to_tab(tab);
85 	return tab;
86 }
87 
88 /*
89  * Move a tab from the tablist to the killed tab list and erase its
90  * contents.  Append should always be 0 to prepend tabs so unkill_tab
91  * can work correctly; appending is only useful during startup when
92  * receiving the list of killed tabs to keep the correct order.
93  * NB: doesn't update the current_tab.
94  */
95 void
96 kill_tab(struct tab *tab, int append)
97 {
98 	int count;
99 
100 	stop_tab(tab);
101 	erase_buffer(&tab->buffer);
102 	TAILQ_REMOVE(&tabshead, tab, tabs);
103 	ui_schedule_redraw();
104 	autosave_hook();
105 
106 	if (evtimer_pending(&tab->loadingev, NULL))
107 		evtimer_del(&tab->loadingev);
108 
109 	if (append)
110 		TAILQ_INSERT_TAIL(&ktabshead, tab, tabs);
111 	else
112 		TAILQ_INSERT_HEAD(&ktabshead, tab, tabs);
113 
114 	/* gc closed tabs */
115 	count = 0;
116 	TAILQ_FOREACH(tab, &ktabshead, tabs)
117 		count++;
118 	while (count > max_killed_tabs) {
119 		count--;
120 		free_tab(TAILQ_LAST(&ktabshead, tabshead));
121 	}
122 }
123 
124 /*
125  * Resurrects the lastest killed tab and returns it.  The tab is already
126  * added to the tab list with the TAB_LAZY flag set.  NB: this doesn't
127  * update current_tab.
128  */
129 struct tab *
130 unkill_tab(void)
131 {
132 	struct tab *t;
133 
134 	if (TAILQ_EMPTY(&ktabshead))
135 		return NULL;
136 
137 	ui_schedule_redraw();
138 	autosave_hook();
139 
140 	t = TAILQ_FIRST(&ktabshead);
141 	TAILQ_REMOVE(&ktabshead, t, tabs);
142 	TAILQ_INSERT_TAIL(&tabshead, t, tabs);
143 	t->flags |= TAB_LAZY;
144 	return t;
145 }
146 
147 /*
148  * Free every resource linked to the tab, including the tab itself, and
149  * removes it from the *killed* tablist.
150  */
151 void
152 free_tab(struct tab *tab)
153 {
154 	TAILQ_REMOVE(&ktabshead, tab, tabs);
155 	hist_clear(&tab->hist);
156 	free(tab);
157 }
158 
159 void
160 stop_tab(struct tab *tab)
161 {
162 	ui_send_net(IMSG_STOP, tab->id, NULL, 0);
163 }
164 
165 static inline void
166 savetab(FILE *fp, struct tab *tab, int killed)
167 {
168 	struct hist	*h;
169 	size_t		 top_line, current_line;
170 	int		 future;
171 
172 	get_scroll_position(tab, &top_line, &current_line);
173 
174 	fprintf(fp, "%s ", tab->hist_cur->h);
175 	if (tab == current_tab)
176 		fprintf(fp, "current,");
177 	if (killed)
178 		fprintf(fp, "killed,");
179 
180 	fprintf(fp, "top=%zu,cur=%zu %s\n", top_line, current_line,
181 	    tab->buffer.page.title);
182 
183 	future = 0;
184 	TAILQ_FOREACH(h, &tab->hist.head, entries) {
185 		if (h == tab->hist_cur) {
186 			future = 1;
187 			continue;
188 		}
189 
190 		fprintf(fp, "%s %s\n", future ? ">" : "<", h->h);
191 	}
192 }
193 
194 void
195 save_session(void)
196 {
197 	FILE		*tmp;
198 	struct tab	*tab;
199 	size_t		 i;
200 	int		 fd, err=  0;
201 	char		 sfn[PATH_MAX];
202 
203 	if (safe_mode)
204 		return;
205 
206 	strlcpy(sfn, session_file_tmp, sizeof(sfn));
207 	if ((fd = mkstemp(sfn)) == -1 ||
208 	    (tmp = fdopen(fd, "w")) == NULL) {
209 		if (fd != -1) {
210 			unlink(sfn);
211 			close(fd);
212 		}
213 		return;
214 	}
215 
216 	TAILQ_FOREACH(tab, &tabshead, tabs)
217 		savetab(tmp, tab, 0);
218 	TAILQ_FOREACH(tab, &ktabshead, tabs)
219 		savetab(tmp, tab, 1);
220 
221 	err = ferror(tmp);
222 	fclose(tmp);
223 
224 	if (err) {
225 		unlink(sfn);
226 		return;
227 	}
228 
229 	if (rename(sfn, session_file))
230 		return;
231 
232 	strlcpy(sfn, history_file_tmp, sizeof(sfn));
233 	if ((fd = mkstemp(sfn)) == -1 ||
234 	    (tmp = fdopen(fd, "w")) == NULL) {
235 		if (fd != -1) {
236 			unlink(sfn);
237 			close(fd);
238 		}
239 		return;
240 	}
241 
242 	if (history.dirty) {
243 		for (i = 0; i < history.len && history.dirty > 0; ++i) {
244 			if (!history.items[i].dirty)
245 				continue;
246 			history.dirty--;
247 			history.items[i].dirty = 0;
248 
249 			fprintf(tmp, "%lld %s\n",
250 			    (long long)history.items[i].ts,
251 			    history.items[i].uri);
252 		}
253 		history.dirty = 0;
254 	}
255 
256 	err = ferror(tmp);
257 	fclose(tmp);
258 
259 	if (err) {
260 		unlink(sfn);
261 		return;
262 	}
263 
264 	rename(sfn, history_file);
265 }
266 
267 void
268 history_push(struct histitem *hi)
269 {
270 	size_t		 i, oldest = 0;
271 	char		*uri;
272 
273 	for (i = 0; i < history.len; ++i) {
274 		if (history.items[i].ts < history.items[oldest].ts)
275 			oldest = i;
276 
277 		/* remove duplicates */
278 		if (!strcmp(history.items[i].uri, hi->uri))
279 			return;
280 	}
281 
282 	if ((uri = strdup(hi->uri)) == NULL)
283 		abort();
284 
285 	/* don't grow too much; replace the oldest */
286 	if (history.len == HISTORY_CAP) {
287 		history.items[oldest].ts = hi->ts;
288 		free(history.items[oldest].uri);
289 		history.items[oldest].uri = uri;
290 		return;
291 	}
292 
293 	history.items[history.len].ts = hi->ts;
294 	history.items[history.len].uri = uri;
295 	history.len++;
296 }
297 
298 static int
299 history_cmp(const void *a, const void *b)
300 {
301 	const struct history_item *i = a, *j = b;
302 	return strcmp(i->uri, j->uri);
303 }
304 
305 void
306 history_sort(void)
307 {
308 	qsort(history.items, history.len, sizeof(history.items[0]),
309 	    history_cmp);
310 }
311 
312 void
313 history_add(const char *uri)
314 {
315 	size_t	 i, j, insert = 0, oldest = 0;
316 	char	*u;
317 	int	 c;
318 
319 	for (i = 0; i < history.len; ++i) {
320 		if (history.items[i].ts < history.items[oldest].ts)
321 			oldest = i;
322 
323 		if (insert != 0 && insert < i)
324 			continue;
325 
326 		c = strcmp(uri, history.items[i].uri);
327 		if (c == 0) {
328 			history.items[i].ts = time(NULL);
329 			history.items[i].dirty = 1;
330 			history.dirty++;
331 			autosave_hook();
332 			return;
333 		}
334 
335 		if (c > 0)
336 			insert = i;
337 	}
338 
339 	if ((u = strdup(uri)) == NULL)
340 		return;
341 
342 	/* if history is full, replace the oldest one */
343 	if (history.len == HISTORY_CAP) {
344 		free(history.items[oldest].uri);
345 		history.items[oldest].uri = u;
346 		history.items[oldest].ts = time(NULL);
347 		history.items[oldest].dirty = 1;
348 		history.dirty++;
349 		history_sort();
350 		autosave_hook();
351 		return;
352 	}
353 
354 	/* otherwise just insert in the right spot */
355 
356 	for (j = history.len; j > insert; --j)
357 		memcpy(&history.items[j], &history.items[j-1],
358 		    sizeof(history.items[j]));
359 
360 	history.items[insert].ts = time(NULL);
361 	history.items[insert].uri = u;
362 	history.items[insert].dirty = 1;
363 	history.dirty++;
364 	history.len++;
365 	autosave_hook();
366 }
367 
368 void
369 autosave_init(void)
370 {
371 	evtimer_set(&autosaveev, autosave_timer, NULL);
372 }
373 
374 void
375 autosave_timer(int fd, short event, void *data)
376 {
377 	save_session();
378 }
379 
380 /*
381  * Function to be called in "interesting" places where we may want to
382  * schedule an autosave (like on new tab or before loading an url.)
383  */
384 void
385 autosave_hook(void)
386 {
387 	struct timeval tv;
388 
389 	if (autosave <= 0)
390 		return;
391 
392 	if (!evtimer_pending(&autosaveev, NULL)) {
393 		tv.tv_sec = autosave;
394 		tv.tv_usec = 0;
395 
396 		evtimer_add(&autosaveev, &tv);
397 	}
398 }
399 
400 static inline int
401 parse_khost_line(char *line, char *tmp[3])
402 {
403 	char **ap;
404 
405 	for (ap = tmp; ap < &tmp[3] &&
406 	    (*ap = strsep(&line, " \t\n")) != NULL;) {
407 		if (**ap != '\0')
408 			ap++;
409 	}
410 
411 	return ap == &tmp[3] && *line == '\0';
412 }
413 
414 static void
415 load_certs(struct ohash *certs)
416 {
417 	char		*tmp[3], *line = NULL;
418 	const char	*errstr;
419 	size_t		 lineno = 0, linesize = 0;
420 	ssize_t		 linelen;
421 	FILE		*f;
422 	struct tofu_entry *e;
423 
424 	if ((f = fopen(known_hosts_file, "r")) == NULL)
425 		return;
426 
427 	if ((e = calloc(1, sizeof(*e))) == NULL) {
428 		fclose(f);
429 		return;
430 	}
431 
432 	while ((linelen = getline(&line, &linesize, f)) != -1) {
433 		lineno++;
434 
435 		if (parse_khost_line(line, tmp)) {
436 			strlcpy(e->domain, tmp[0], sizeof(e->domain));
437 			strlcpy(e->hash, tmp[1], sizeof(e->hash));
438 
439 			e->verified = strtonum(tmp[2], 0, 1, &errstr);
440 			if (errstr != NULL)
441 				errx(1, "%s:%zu verification for %s is %s: %s",
442 				    known_hosts_file, lineno,
443 				    e->domain, errstr, tmp[2]);
444 
445 			tofu_add(certs, e);
446 		} else
447 			warnx("%s:%zu invalid entry",
448 			    known_hosts_file, lineno);
449 	}
450 
451 	free(line);
452 	fclose(f);
453 	return;
454 }
455 
456 
457 static void
458 load_hist(void)
459 {
460 	FILE		*hist;
461 	size_t		 linesize = 0;
462 	ssize_t		 linelen;
463 	char		*nl, *spc, *line = NULL;
464 	const char	*errstr;
465 	struct histitem	 hi;
466 
467 	if ((hist = fopen(history_file, "r")) == NULL)
468 		return;
469 
470 	while ((linelen = getline(&line, &linesize, hist)) != -1) {
471 		if ((nl = strchr(line, '\n')) != NULL)
472 			*nl = '\0';
473 		if ((spc = strchr(line, ' ')) == NULL)
474 			continue;
475 		*spc = '\0';
476 		spc++;
477 
478 		memset(&hi, 0, sizeof(hi));
479 		hi.ts = strtonum(line, INT64_MIN, INT64_MAX, &errstr);
480 		if (errstr != NULL)
481 			continue;
482 		if (strlcpy(hi.uri, spc, sizeof(hi.uri)) >= sizeof(hi.uri))
483 			continue;
484 
485 		history_push(&hi);
486 	}
487 
488 	fclose(hist);
489 	free(line);
490 
491 	history_sort();
492 }
493 
494 /*
495  * Check if the last time telescope crashed.  The check is done by
496  * looking at `crashed_file': if it exists then last time we crashed.
497  * Then, while here, touch the file too, it's removed during the
498  * teardown.
499  */
500 static int
501 last_time_crashed(void)
502 {
503 	int fd, crashed = 1;
504 
505 	if (safe_mode)
506 		return 0;
507 
508 	if (unlink(crashed_file) == -1 && errno == ENOENT)
509 		crashed = 0;
510 
511 	if ((fd = open(crashed_file, O_CREAT|O_WRONLY, 0600)) == -1)
512 		return crashed;
513 	close(fd);
514 
515 	return crashed;
516 }
517 
518 /*
519  * Parse and restore a tab from the session file.  The format is:
520  *
521  *	URL [flags,...] [title]\n
522  */
523 static inline struct tab *
524 parse_tab_line(char *line, struct tab **ct)
525 {
526 	struct tab *tab;
527 	char *s, *t, *ap;
528 	const char *uri, *title = "";
529 	int current = 0, killed = 0;
530 	size_t tline = 0, cline = 0;
531 
532 	uri = line;
533 	if ((s = strchr(line, ' ')) == NULL)
534 		return NULL;
535 	*s++ = '\0';
536 
537 	if ((t = strchr(s, ' ')) != NULL) {
538 		*t++ = '\0';
539 		title = t;
540 	}
541 
542 	while ((ap = strsep(&s, ",")) != NULL) {
543 		if (!strcmp(ap, "current"))
544 			current = 1;
545 		else if (!strcmp(ap, "killed"))
546 			killed = 1;
547 		else if (!strncmp(ap, "top=", 4))
548 			tline = strtonum(ap+4, 0, UINT32_MAX, NULL);
549 		else if (!strncmp(ap, "cur=", 4))
550 			cline = strtonum(ap + 4, 0, UINT32_MAX, NULL);
551 	}
552 
553 	if (tline > cline) {
554 		tline = 0;
555 		cline = 0;
556 	}
557 
558 	if ((tab = new_tab(uri, NULL, NULL)) == NULL)
559 		err(1, "new_tab");
560 	tab->hist_cur->line_off = tline;
561 	tab->hist_cur->current_off = cline;
562 	strlcpy(tab->buffer.page.title, title, sizeof(tab->buffer.page.title));
563 
564 	if (current)
565 		*ct = tab;
566 	else if (killed)
567 		kill_tab(tab, 1);
568 
569 	return tab;
570 }
571 
572 static void
573 load_tabs(void)
574 {
575 	struct tab	*tab = NULL, *ct = NULL;
576 	struct hist	*h;
577 	FILE		*session;
578 	size_t		 lineno = 0, linesize = 0;
579 	ssize_t		 linelen;
580 	char		*uri, *line = NULL;
581 
582 	if ((session = fopen(session_file, "r")) == NULL) {
583 		new_tab("about:new", NULL, NULL);
584 		new_tab("about:help", NULL, NULL);
585 		return;
586 	}
587 
588 	while ((linelen = getline(&line, &linesize, session)) != -1) {
589 		lineno++;
590 
591 		if (linelen > 0 && line[linelen-1] == '\n')
592 			line[linelen-1] = '\0';
593 
594 		if (*line == '<' || *line == '>') {
595 			uri = line + 1;
596 			if (*uri != ' ' || tab == NULL) {
597 				fprintf(stderr, "%s:%zu invalid line\n",
598 				    session_file, lineno);
599 				continue;
600 			}
601 			uri++;
602 
603 			if ((h = calloc(1, sizeof(*h))) == NULL)
604 				err(1, "calloc");
605 			strlcpy(h->h, uri, sizeof(h->h));
606 
607 			if (*line == '>') /* future hist */
608 				hist_push(&tab->hist, h);
609 			else
610 				hist_add_before(&tab->hist, tab->hist_cur, h);
611 		} else
612 			tab = parse_tab_line(line, &ct);
613 	}
614 
615 	fclose(session);
616 	free(line);
617 
618 	if (ct == NULL || TAILQ_EMPTY(&tabshead))
619 		ct = new_tab("about:new", NULL, NULL);
620 
621 	switch_to_tab(ct);
622 
623 	if (last_time_crashed())
624 		new_tab("about:crash", NULL, NULL);
625 }
626 
627 int
628 load_session(struct ohash *certs)
629 {
630 	load_certs(certs);
631 	load_hist();
632 	load_tabs();
633 	return 0;
634 }
635 
636 int
637 lock_session(void)
638 {
639 	struct flock	lock;
640 	int		fd;
641 
642 	if ((fd = open(lockfile_path, O_WRONLY|O_CREAT, 0600)) == -1)
643 		return -1;
644 
645 	lock.l_start = 0;
646 	lock.l_len = 0;
647 	lock.l_type = F_WRLCK;
648 	lock.l_whence = SEEK_SET;
649 
650 	if (fcntl(fd, F_SETLK, &lock) == -1) {
651 		close(fd);
652 		return -1;
653 	}
654 
655 	return fd;
656 }