Blob


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 */
17 /*
18 * Handles the data in ~/.telescope
19 *
20 * TODO: add some form of locking on the files
21 */
23 #include "compat.h"
25 #include <sys/stat.h>
26 #include <sys/types.h>
28 #include <dirent.h>
29 #include <errno.h>
30 #include <fcntl.h>
31 #include <limits.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <unistd.h>
37 #include "telescope.h"
38 #include "pages.h"
40 static void die(void) __attribute__((__noreturn__));
41 static void send_file(uint32_t, FILE *);
42 static void handle_get(struct imsg*, size_t);
43 static int select_non_dot(const struct dirent *);
44 static int select_non_dotdot(const struct dirent *);
45 static void handle_get_file(struct imsg*, size_t);
46 static void handle_quit(struct imsg*, size_t);
47 static void handle_bookmark_page(struct imsg*, size_t);
48 static void handle_save_cert(struct imsg*, size_t);
49 static void handle_update_cert(struct imsg*, size_t);
50 static void handle_file_open(struct imsg*, size_t);
51 static void handle_session_start(struct imsg*, size_t);
52 static void handle_session_tab(struct imsg*, size_t);
53 static void handle_session_tab_title(struct imsg*, size_t);
54 static void handle_session_end(struct imsg*, size_t);
55 static void handle_dispatch_imsg(int, short, void*);
56 static int fs_send_ui(int, uint32_t, int, const void *, uint16_t);
58 static struct imsgev *iev_ui;
59 static FILE *session;
61 static char base_path[PATH_MAX];
62 static char lockfile_path[PATH_MAX];
63 static char bookmark_file[PATH_MAX];
64 static char known_hosts_file[PATH_MAX], known_hosts_tmp[PATH_MAX];
65 static char crashed_file[PATH_MAX];
67 char session_file[PATH_MAX];
69 static imsg_handlerfn *handlers[] = {
70 [IMSG_GET] = handle_get,
71 [IMSG_GET_FILE] = handle_get_file,
72 [IMSG_QUIT] = handle_quit,
73 [IMSG_BOOKMARK_PAGE] = handle_bookmark_page,
74 [IMSG_SAVE_CERT] = handle_save_cert,
75 [IMSG_UPDATE_CERT] = handle_update_cert,
76 [IMSG_FILE_OPEN] = handle_file_open,
77 [IMSG_SESSION_START] = handle_session_start,
78 [IMSG_SESSION_TAB] = handle_session_tab,
79 [IMSG_SESSION_TAB_TITLE] = handle_session_tab_title,
80 [IMSG_SESSION_END] = handle_session_end,
81 };
83 static void __attribute__((__noreturn__))
84 die(void)
85 {
86 abort(); /* TODO */
87 }
89 static void
90 send_file(uint32_t peerid, FILE *f)
91 {
92 ssize_t r;
93 char buf[BUFSIZ];
95 for (;;) {
96 r = fread(buf, 1, sizeof(buf), f);
97 if (r != 0)
98 fs_send_ui(IMSG_BUF, peerid, -1, buf, r);
99 if (r != sizeof(buf))
100 break;
102 fs_send_ui(IMSG_EOF, peerid, -1, NULL, 0);
103 fclose(f);
106 static void
107 handle_get(struct imsg *imsg, size_t datalen)
109 const char *bpath = "bookmarks.gmi";
110 char path[PATH_MAX];
111 FILE *f;
112 const char *data, *p;
113 size_t i;
114 struct page {
115 const char *name;
116 const char *path;
117 const uint8_t *data;
118 size_t len;
119 } pages[] = {
120 {"about", NULL, about_about, about_about_len},
121 {"blank", NULL, about_blank, about_blank_len},
122 {"bookmarks", bpath, bookmarks, bookmarks_len},
123 {"crash", NULL, about_crash, about_crash_len},
124 {"help", NULL, about_help, about_help_len},
125 {"license", NULL, about_license, about_license_len},
126 {"new", NULL, about_new, about_new_len},
127 }, *page = NULL;
129 data = imsg->data;
130 if (data[datalen-1] != '\0') /* make sure it's NUL-terminated */
131 die();
132 if ((data = strchr(data, ':')) == NULL)
133 goto notfound;
134 data++;
136 for (i = 0; i < sizeof(pages)/sizeof(pages[0]); ++i)
137 if (!strcmp(data, pages[i].name)) {
138 page = &pages[i];
139 break;
142 if (page == NULL)
143 goto notfound;
145 strlcpy(path, base_path, sizeof(path));
146 strlcat(path, "/", sizeof(path));
147 if (page->path != NULL)
148 strlcat(path, page->path, sizeof(path));
149 else {
150 strlcat(path, "pages/about_", sizeof(path));
151 strlcat(path, page->name, sizeof(path));
152 strlcat(path, ".gmi", sizeof(path));
155 if ((f = fopen(path, "r")) == NULL) {
156 fs_send_ui(IMSG_BUF, imsg->hdr.peerid, -1,
157 page->data, page->len);
158 fs_send_ui(IMSG_EOF, imsg->hdr.peerid, -1,
159 NULL, 0);
160 return;
163 send_file(imsg->hdr.peerid, f);
164 return;
166 notfound:
167 p = "# not found!\n";
168 fs_send_ui(IMSG_BUF, imsg->hdr.peerid, -1, p, strlen(p));
169 fs_send_ui(IMSG_EOF, imsg->hdr.peerid, -1, NULL, 0);
172 static inline void
173 send_hdr(uint32_t peerid, int code, const char *meta)
175 fs_send_ui(IMSG_GOT_CODE, peerid, -1, &code, sizeof(code));
176 fs_send_ui(IMSG_GOT_META, peerid, -1, meta, strlen(meta)+1);
179 static inline void
180 send_errno(uint32_t peerid, int code, const char *str, int no)
182 char *s;
184 if (asprintf(&s, "%s: %s", str, strerror(no)) == -1)
185 s = NULL;
187 send_hdr(peerid, code, s == NULL ? str : s);
188 free(s);
191 static inline const char *
192 file_type(const char *path)
194 struct mapping {
195 const char *ext;
196 const char *mime;
197 } ms[] = {
198 {"diff", "text/x-patch"},
199 {"gemini", "text/gemini"},
200 {"gmi", "text/gemini"},
201 {"markdown", "text/plain"},
202 {"md", "text/plain"},
203 {"patch", "text/x-patch"},
204 {"txt", "text/plain"},
205 {NULL, NULL},
206 }, *m;
207 char *dot;
209 if ((dot = strrchr(path, '.')) == NULL)
210 return NULL;
212 dot++;
214 for (m = ms; m->ext != NULL; ++m)
215 if (!strcmp(m->ext, dot))
216 return m->mime;
218 return NULL;
221 static int
222 select_non_dot(const struct dirent *d)
224 return strcmp(d->d_name, ".");
227 static int
228 select_non_dotdot(const struct dirent *d)
230 return strcmp(d->d_name, ".") && strcmp(d->d_name, "..");
233 static inline void
234 send_dir(uint32_t peerid, const char *path)
236 struct dirent **names;
237 struct evbuffer *ev;
238 char *s;
239 int (*selector)(const struct dirent *) = select_non_dot;
240 int i, len, no;
242 if (!has_suffix(path, "/")) {
243 if (asprintf(&s, "%s/", path) == -1)
244 die();
245 send_hdr(peerid, 30, s);
246 free(s);
247 return;
250 if (!strcmp(path, "/"))
251 selector = select_non_dotdot;
253 if ((ev = evbuffer_new()) == NULL ||
254 (len = scandir(path, &names, selector, alphasort)) == -1) {
255 no = errno;
256 evbuffer_free(ev);
257 send_errno(peerid, 40, "failure reading the directory", no);
258 return;
261 evbuffer_add_printf(ev, "# Index of %s\n\n", path);
262 for (i = 0; i < len; ++i) {
263 evbuffer_add_printf(ev, "=> %s", names[i]->d_name);
264 if (names[i]->d_type == DT_DIR)
265 evbuffer_add(ev, "/", 1);
266 evbuffer_add(ev, "\n", 1);
269 send_hdr(peerid, 20, "text/gemini");
270 fs_send_ui(IMSG_BUF, peerid, -1,
271 EVBUFFER_DATA(ev), EVBUFFER_LENGTH(ev));
272 fs_send_ui(IMSG_EOF, peerid, -1, NULL, 0);
274 evbuffer_free(ev);
275 free(names);
278 static void
279 handle_get_file(struct imsg *imsg, size_t datalen)
281 struct stat sb;
282 FILE *f;
283 char *data;
284 const char *meta = NULL;
286 data = imsg->data;
287 data[datalen-1] = '\0';
289 if ((f = fopen(data, "r")) == NULL) {
290 send_errno(imsg->hdr.peerid, 51, "can't open", errno);
291 return;
294 if (fstat(fileno(f), &sb) == -1) {
295 send_errno(imsg->hdr.peerid, 40, "fstat", errno);
296 return;
299 if (S_ISDIR(sb.st_mode)) {
300 fclose(f);
301 send_dir(imsg->hdr.peerid, data);
302 return;
305 if ((meta = file_type(data)) == NULL) {
306 fclose(f);
307 send_hdr(imsg->hdr.peerid, 51,
308 "don't know how to visualize this file");
309 return;
312 send_hdr(imsg->hdr.peerid, 20, meta);
313 send_file(imsg->hdr.peerid, f);
316 static void
317 handle_quit(struct imsg *imsg, size_t datalen)
319 unlink(crashed_file);
321 event_loopbreak();
324 static void
325 handle_bookmark_page(struct imsg *imsg, size_t datalen)
327 char *data;
328 int res;
329 FILE *f;
331 data = imsg->data;
332 if (data[datalen-1] != '\0')
333 die();
335 if ((f = fopen(bookmark_file, "a")) == NULL) {
336 res = errno;
337 goto end;
339 fprintf(f, "=> %s\n", data);
340 fclose(f);
342 res = 0;
343 end:
344 fs_send_ui(IMSG_BOOKMARK_OK, 0, -1, &res, sizeof(res));
347 static void
348 handle_save_cert(struct imsg *imsg, size_t datalen)
350 struct tofu_entry e;
351 FILE *f;
352 int res;
354 /* TODO: traverse the file to avoid duplications? */
356 if (datalen != sizeof(e))
357 die();
358 memcpy(&e, imsg->data, datalen);
360 if ((f = fopen(known_hosts_file, "a")) == NULL) {
361 res = errno;
362 goto end;
364 fprintf(f, "%s %s %d\n", e.domain, e.hash, e.verified);
365 fclose(f);
367 res = 0;
368 end:
369 fs_send_ui(IMSG_SAVE_CERT_OK, imsg->hdr.peerid, -1,
370 &res, sizeof(res));
373 static void
374 handle_update_cert(struct imsg *imsg, size_t datalen)
376 FILE *tmp, *f;
377 struct tofu_entry entry;
378 char sfn[PATH_MAX], *line = NULL, *t;
379 size_t l, linesize = 0;
380 ssize_t linelen;
381 int fd, e, res = 0;
383 if (datalen != sizeof(entry))
384 die();
385 memcpy(&entry, imsg->data, datalen);
387 strlcpy(sfn, known_hosts_tmp, sizeof(sfn));
388 if ((fd = mkstemp(sfn)) == -1 ||
389 (tmp = fdopen(fd, "w")) == NULL) {
390 if (fd != -1) {
391 unlink(sfn);
392 close(fd);
394 res = 0;
395 goto end;
398 if ((f = fopen(known_hosts_file, "r")) == NULL) {
399 unlink(sfn);
400 fclose(tmp);
401 res = 0;
402 goto end;
405 l = strlen(entry.domain);
406 while ((linelen = getline(&line, &linesize, f)) != -1) {
407 if ((t = strstr(line, entry.domain)) != NULL &&
408 (line[l] == ' ' || line[l] == '\t'))
409 continue;
410 /* line has a trailing \n */
411 fprintf(tmp, "%s", line);
413 fprintf(tmp, "%s %s %d\n", entry.domain, entry.hash, entry.verified);
415 free(line);
416 e = ferror(tmp);
418 fclose(tmp);
419 fclose(f);
421 if (e) {
422 unlink(sfn);
423 res = 0;
424 goto end;
427 res = rename(sfn, known_hosts_file) != -1;
429 end:
430 fs_send_ui(IMSG_UPDATE_CERT_OK, imsg->hdr.peerid, -1,
431 &res, sizeof(res));
434 static void
435 handle_file_open(struct imsg *imsg, size_t datalen)
437 char *path, *e;
438 int fd;
440 path = imsg->data;
441 if (path[datalen-1] != '\0')
442 die();
444 if ((fd = open(path, O_WRONLY | O_TRUNC | O_CREAT, 0644)) == -1) {
445 e = strerror(errno);
446 fs_send_ui(IMSG_FILE_OPENED, imsg->hdr.peerid, -1,
447 e, strlen(e)+1);
448 } else
449 fs_send_ui(IMSG_FILE_OPENED, imsg->hdr.peerid, fd,
450 NULL, 0);
453 static void
454 handle_session_start(struct imsg *imsg, size_t datalen)
456 if (datalen != 0)
457 die();
459 if ((session = fopen(session_file, "w")) == NULL)
460 die();
463 static void
464 handle_session_tab(struct imsg *imsg, size_t datalen)
466 char *url;
467 uint32_t flags;
469 if (session == NULL)
470 die();
472 flags = imsg->hdr.peerid;
473 url = imsg->data;
474 if (datalen == 0 || url[datalen-1] != '\0')
475 die();
476 fprintf(session, "%s", url);
478 if (flags & TAB_CURRENT)
479 fprintf(session, " current ");
480 else
481 fprintf(session, " - ");
484 static void
485 handle_session_tab_title(struct imsg *imsg, size_t datalen)
487 const char *title;
489 title = imsg->data;
490 if (title == NULL) {
491 datalen = 1;
492 title = "";
495 if (title[datalen-1] != '\0')
496 die();
498 fprintf(session, "%s\n", title);
501 static void
502 handle_session_end(struct imsg *imsg, size_t datalen)
504 if (session == NULL)
505 die();
506 fclose(session);
507 session = NULL;
510 static void
511 handle_dispatch_imsg(int fd, short ev, void *d)
513 struct imsgev *iev = d;
514 int e;
516 if (dispatch_imsg(iev, ev, handlers, sizeof(handlers)) == -1) {
517 /*
518 * This should leave a ~/.telescope/crashed file to
519 * trigger about:crash on next run. Unfortunately, if
520 * the main process dies the fs sticks around and
521 * doesn't notice that the fd was closed. Why EV_READ
522 * is not triggered when a fd is closed on the other end?
523 */
524 e = errno;
525 if ((fd = open(crashed_file, O_CREAT|O_TRUNC|O_WRONLY, 0600))
526 == -1)
527 err(1, "open");
528 close(fd);
529 errx(1, "connection closed: %s", strerror(e));
533 static int
534 fs_send_ui(int type, uint32_t peerid, int fd, const void *data,
535 uint16_t datalen)
537 return imsg_compose_event(iev_ui, type, peerid, 0, fd,
538 data, datalen);
541 int
542 fs_init(void)
544 strlcpy(base_path, getenv("HOME"), sizeof(base_path));
545 strlcat(base_path, "/.telescope", sizeof(base_path));
546 mkdir(base_path, 0700);
548 strlcpy(lockfile_path, base_path, sizeof(lockfile_path));
549 strlcat(lockfile_path, "/lock", sizeof(lockfile_path));
551 strlcpy(bookmark_file, base_path, sizeof(bookmark_file));
552 strlcat(bookmark_file, "/bookmarks.gmi", sizeof(bookmark_file));
554 strlcpy(known_hosts_file, base_path, sizeof(known_hosts_file));
555 strlcat(known_hosts_file, "/known_hosts", sizeof(known_hosts_file));
557 strlcpy(known_hosts_tmp, base_path, sizeof(known_hosts_tmp));
558 strlcat(known_hosts_tmp, "/known_hosts.tmp.XXXXXXXXXX",
559 sizeof(known_hosts_file));
561 strlcpy(session_file, base_path, sizeof(session_file));
562 strlcat(session_file, "/session", sizeof(session_file));
564 strlcpy(crashed_file, base_path, sizeof(crashed_file));
565 strlcat(crashed_file, "/crashed", sizeof(crashed_file));
567 return 1;
570 int
571 fs_main(void)
573 setproctitle("fs");
575 fs_init();
577 event_init();
579 /* Setup pipe and event handler to the main process */
580 if ((iev_ui = malloc(sizeof(*iev_ui))) == NULL)
581 die();
582 imsg_init(&iev_ui->ibuf, 3);
583 iev_ui->handler = handle_dispatch_imsg;
584 iev_ui->events = EV_READ;
585 event_set(&iev_ui->ev, iev_ui->ibuf.fd, iev_ui->events,
586 iev_ui->handler, iev_ui);
587 event_add(&iev_ui->ev, NULL);
589 sandbox_fs_process();
591 event_dispatch();
592 return 0;
597 /*
598 * Check if the last time telescope crashed. The check is done by
599 * looking at `crashed_file': if it exists then last time we crashed.
600 * Then, while here, touch the file too. During IMSG_QUIT we'll
601 * remove it.
602 */
603 int
604 last_time_crashed(void)
606 int fd, crashed = 1;
608 if (unlink(crashed_file) == -1 && errno == ENOENT)
609 crashed = 0;
611 if ((fd = open(crashed_file, O_CREAT|O_WRONLY, 0600)) == -1)
612 return crashed;
613 close(fd);
615 return crashed;
618 int
619 lock_session(void)
621 struct flock lock;
622 int fd;
624 if ((fd = open(lockfile_path, O_WRONLY|O_CREAT, 0600)) == -1)
625 return -1;
627 lock.l_start = 0;
628 lock.l_len = 0;
629 lock.l_type = F_WRLCK;
630 lock.l_whence = SEEK_SET;
632 if (fcntl(fd, F_SETLK, &lock) == -1) {
633 close(fd);
634 return -1;
637 return fd;
640 static int
641 parse_khost_line(char *line, char *tmp[3])
643 char **ap;
645 for (ap = tmp; ap < &tmp[3] &&
646 (*ap = strsep(&line, " \t\n")) != NULL;) {
647 if (**ap != '\0')
648 ap++;
651 return ap == &tmp[3] && *line == '\0';
654 int
655 load_certs(struct ohash *h)
657 char *tmp[3], *line = NULL;
658 const char *errstr;
659 size_t lineno = 0, linesize = 0;
660 ssize_t linelen;
661 FILE *f;
662 struct tofu_entry *e;
664 if ((f = fopen(known_hosts_file, "r")) == NULL)
665 return 0;
667 while ((linelen = getline(&line, &linesize, f)) != -1) {
668 if ((e = calloc(1, sizeof(*e))) == NULL)
669 abort();
671 lineno++;
673 if (parse_khost_line(line, tmp)) {
674 strlcpy(e->domain, tmp[0], sizeof(e->domain));
675 strlcpy(e->hash, tmp[1], sizeof(e->hash));
677 e->verified = strtonum(tmp[2], 0, 1, &errstr);
678 if (errstr != NULL)
679 errx(1, "%s:%zu verification for %s is %s: %s",
680 known_hosts_file, lineno,
681 e->domain, errstr, tmp[2]);
682 tofu_add(h, e);
683 } else {
684 warnx("%s:%zu invalid entry",
685 known_hosts_file, lineno);
686 free(e);
690 free(line);
691 return ferror(f);