2 * Copyright (c) 2021 Omar Polo <op@omarpolo.com>
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.
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.
18 * Handles config and runtime files
24 #include <sys/types.h>
38 #include "telescope.h"
42 static void die(void) __attribute__((__noreturn__));
43 static void send_file(uint32_t, FILE *);
44 static void handle_get(struct imsg*, size_t);
45 static int select_non_dot(const struct dirent *);
46 static int select_non_dotdot(const struct dirent *);
47 static void handle_get_file(struct imsg*, size_t);
48 static void handle_misc(struct imsg *, size_t);
49 static void handle_bookmark_page(struct imsg*, size_t);
50 static void handle_save_cert(struct imsg*, size_t);
51 static void handle_update_cert(struct imsg*, size_t);
52 static void handle_file_open(struct imsg*, size_t);
53 static void handle_session_start(struct imsg*, size_t);
54 static void handle_session_tab(struct imsg*, size_t);
55 static void handle_session_tab_hist(struct imsg*, size_t);
56 static void handle_session_end(struct imsg*, size_t);
57 static void handle_dispatch_imsg(int, short, void*);
58 static int fs_send_ui(int, uint32_t, int, const void *, uint16_t);
59 static size_t join_path(char*, const char*, const char*, size_t);
60 static void getenv_default(char*, const char*, const char*, size_t);
61 static void mkdirs(const char*, mode_t);
62 static void init_paths(void);
63 static void load_last_session(void);
64 static int last_time_crashed(void);
65 static void load_certs(void);
67 static struct imsgev *iev_ui;
71 * Where to store user data. These are all equal to ~/.telescope if
74 char config_path_base[PATH_MAX];
75 char data_path_base[PATH_MAX];
76 char cache_path_base[PATH_MAX];
78 char ctlsock_path[PATH_MAX];
79 char config_path[PATH_MAX];
80 char lockfile_path[PATH_MAX];
81 char bookmark_file[PATH_MAX];
82 char known_hosts_file[PATH_MAX], known_hosts_tmp[PATH_MAX];
83 char crashed_file[PATH_MAX];
84 char session_file[PATH_MAX];
86 static imsg_handlerfn *handlers[] = {
87 [IMSG_GET] = handle_get,
88 [IMSG_GET_FILE] = handle_get_file,
89 [IMSG_QUIT] = handle_misc,
90 [IMSG_INIT] = handle_misc,
91 [IMSG_BOOKMARK_PAGE] = handle_bookmark_page,
92 [IMSG_SAVE_CERT] = handle_save_cert,
93 [IMSG_UPDATE_CERT] = handle_update_cert,
94 [IMSG_FILE_OPEN] = handle_file_open,
95 [IMSG_SESSION_START] = handle_session_start,
96 [IMSG_SESSION_TAB] = handle_session_tab,
97 [IMSG_SESSION_TAB_HIST] = handle_session_tab_hist,
98 [IMSG_SESSION_END] = handle_session_end,
101 static void __attribute__((__noreturn__))
108 send_file(uint32_t peerid, FILE *f)
114 r = fread(buf, 1, sizeof(buf), f);
116 fs_send_ui(IMSG_BUF, peerid, -1, buf, r);
117 if (r != sizeof(buf))
120 fs_send_ui(IMSG_EOF, peerid, -1, NULL, 0);
125 handle_get(struct imsg *imsg, size_t datalen)
127 const char *bpath = "bookmarks.gmi";
130 const char *data, *p;
138 {"about", NULL, about_about, about_about_len},
139 {"blank", NULL, about_blank, about_blank_len},
140 {"bookmarks", bpath, bookmarks, bookmarks_len},
141 {"crash", NULL, about_crash, about_crash_len},
142 {"help", NULL, about_help, about_help_len},
143 {"license", NULL, about_license, about_license_len},
144 {"new", NULL, about_new, about_new_len},
148 if (data[datalen-1] != '\0') /* make sure it's NUL-terminated */
150 if ((data = strchr(data, ':')) == NULL)
154 for (i = 0; i < sizeof(pages)/sizeof(pages[0]); ++i)
155 if (!strcmp(data, pages[i].name)) {
163 strlcpy(path, data_path_base, sizeof(path));
164 strlcat(path, "/", sizeof(path));
165 if (page->path != NULL)
166 strlcat(path, page->path, sizeof(path));
168 strlcat(path, "pages/about_", sizeof(path));
169 strlcat(path, page->name, sizeof(path));
170 strlcat(path, ".gmi", sizeof(path));
173 if ((f = fopen(path, "r")) == NULL) {
174 fs_send_ui(IMSG_BUF, imsg->hdr.peerid, -1,
175 page->data, page->len);
176 fs_send_ui(IMSG_EOF, imsg->hdr.peerid, -1,
181 send_file(imsg->hdr.peerid, f);
185 p = "# not found!\n";
186 fs_send_ui(IMSG_BUF, imsg->hdr.peerid, -1, p, strlen(p));
187 fs_send_ui(IMSG_EOF, imsg->hdr.peerid, -1, NULL, 0);
191 send_hdr(uint32_t peerid, int code, const char *meta)
193 fs_send_ui(IMSG_GOT_CODE, peerid, -1, &code, sizeof(code));
194 fs_send_ui(IMSG_GOT_META, peerid, -1, meta, strlen(meta)+1);
198 send_errno(uint32_t peerid, int code, const char *str, int no)
202 if (asprintf(&s, "%s: %s", str, strerror(no)) == -1)
205 send_hdr(peerid, code, s == NULL ? str : s);
209 static inline const char *
210 file_type(const char *path)
216 {"diff", "text/x-patch"},
217 {"gemini", "text/gemini"},
218 {"gmi", "text/gemini"},
219 {"markdown", "text/plain"},
220 {"md", "text/plain"},
221 {"patch", "text/x-patch"},
222 {"txt", "text/plain"},
227 if ((dot = strrchr(path, '.')) == NULL)
232 for (m = ms; m->ext != NULL; ++m)
233 if (!strcmp(m->ext, dot))
240 select_non_dot(const struct dirent *d)
242 return strcmp(d->d_name, ".");
246 select_non_dotdot(const struct dirent *d)
248 return strcmp(d->d_name, ".") && strcmp(d->d_name, "..");
252 send_dir(uint32_t peerid, const char *path)
254 struct dirent **names;
257 int (*selector)(const struct dirent *) = select_non_dot;
260 if (!has_suffix(path, "/")) {
261 if (asprintf(&s, "%s/", path) == -1)
263 send_hdr(peerid, 30, s);
268 if (!strcmp(path, "/"))
269 selector = select_non_dotdot;
271 if ((ev = evbuffer_new()) == NULL ||
272 (len = scandir(path, &names, selector, alphasort)) == -1) {
275 send_errno(peerid, 40, "failure reading the directory", no);
279 evbuffer_add_printf(ev, "# Index of %s\n\n", path);
280 for (i = 0; i < len; ++i) {
281 evbuffer_add_printf(ev, "=> %s", names[i]->d_name);
282 if (names[i]->d_type == DT_DIR)
283 evbuffer_add(ev, "/", 1);
284 evbuffer_add(ev, "\n", 1);
287 send_hdr(peerid, 20, "text/gemini");
288 fs_send_ui(IMSG_BUF, peerid, -1,
289 EVBUFFER_DATA(ev), EVBUFFER_LENGTH(ev));
290 fs_send_ui(IMSG_EOF, peerid, -1, NULL, 0);
297 handle_get_file(struct imsg *imsg, size_t datalen)
302 const char *meta = NULL;
305 data[datalen-1] = '\0';
307 if ((f = fopen(data, "r")) == NULL) {
308 send_errno(imsg->hdr.peerid, 51, "can't open", errno);
312 if (fstat(fileno(f), &sb) == -1) {
313 send_errno(imsg->hdr.peerid, 40, "fstat", errno);
317 if (S_ISDIR(sb.st_mode)) {
319 send_dir(imsg->hdr.peerid, data);
323 if ((meta = file_type(data)) == NULL) {
325 send_hdr(imsg->hdr.peerid, 51,
326 "don't know how to visualize this file");
330 send_hdr(imsg->hdr.peerid, 20, meta);
331 send_file(imsg->hdr.peerid, f);
335 handle_misc(struct imsg *imsg, size_t datalen)
337 switch (imsg->hdr.type) {
345 unlink(crashed_file);
355 handle_bookmark_page(struct imsg *imsg, size_t datalen)
362 if (data[datalen-1] != '\0')
365 if ((f = fopen(bookmark_file, "a")) == NULL) {
369 fprintf(f, "=> %s\n", data);
374 fs_send_ui(IMSG_BOOKMARK_OK, 0, -1, &res, sizeof(res));
378 handle_save_cert(struct imsg *imsg, size_t datalen)
384 /* TODO: traverse the file to avoid duplications? */
386 if (datalen != sizeof(e))
388 memcpy(&e, imsg->data, datalen);
390 if ((f = fopen(known_hosts_file, "a")) == NULL) {
394 fprintf(f, "%s %s %d\n", e.domain, e.hash, e.verified);
399 fs_send_ui(IMSG_SAVE_CERT_OK, imsg->hdr.peerid, -1,
404 handle_update_cert(struct imsg *imsg, size_t datalen)
407 struct tofu_entry entry;
408 char sfn[PATH_MAX], *line = NULL, *t;
409 size_t l, linesize = 0;
413 if (datalen != sizeof(entry))
415 memcpy(&entry, imsg->data, datalen);
417 strlcpy(sfn, known_hosts_tmp, sizeof(sfn));
418 if ((fd = mkstemp(sfn)) == -1 ||
419 (tmp = fdopen(fd, "w")) == NULL) {
428 if ((f = fopen(known_hosts_file, "r")) == NULL) {
435 l = strlen(entry.domain);
436 while ((linelen = getline(&line, &linesize, f)) != -1) {
437 if ((t = strstr(line, entry.domain)) != NULL &&
438 (line[l] == ' ' || line[l] == '\t'))
440 /* line has a trailing \n */
441 fprintf(tmp, "%s", line);
443 fprintf(tmp, "%s %s %d\n", entry.domain, entry.hash, entry.verified);
457 res = rename(sfn, known_hosts_file) != -1;
460 fs_send_ui(IMSG_UPDATE_CERT_OK, imsg->hdr.peerid, -1,
465 handle_file_open(struct imsg *imsg, size_t datalen)
471 if (path[datalen-1] != '\0')
474 if ((fd = open(path, O_WRONLY | O_TRUNC | O_CREAT, 0644)) == -1) {
476 fs_send_ui(IMSG_FILE_OPENED, imsg->hdr.peerid, -1,
479 fs_send_ui(IMSG_FILE_OPENED, imsg->hdr.peerid, fd,
484 handle_session_start(struct imsg *imsg, size_t datalen)
489 if ((session = fopen(session_file, "w")) == NULL)
494 handle_session_tab(struct imsg *imsg, size_t datalen)
496 struct session_tab tab;
501 if (datalen != sizeof(tab))
504 memcpy(&tab, imsg->data, sizeof(tab));
505 if (tab.uri[sizeof(tab.uri)-1] != '\0' ||
506 tab.title[sizeof(tab.title)-1] != '\0')
509 fprintf(session, "%s ", tab.uri);
511 if (tab.flags & TAB_CURRENT)
512 fprintf(session, "current,");
513 if (tab.flags & TAB_KILLED)
514 fprintf(session, "killed,");
516 fprintf(session, "top=%zu,cur=%zu %s\n", tab.top_line,
517 tab.current_line, tab.title);
521 handle_session_tab_hist(struct imsg *imsg, size_t datalen)
523 struct session_tab_hist th;
528 if (datalen != sizeof(th))
531 memcpy(&th, imsg->data, sizeof(th));
532 if (th.uri[sizeof(th.uri)-1] != '\0')
535 fprintf(session, "%s %s\n", th.future ? ">" : "<", th.uri);
539 handle_session_end(struct imsg *imsg, size_t datalen)
548 handle_dispatch_imsg(int fd, short ev, void *d)
550 struct imsgev *iev = d;
553 if (dispatch_imsg(iev, ev, handlers, sizeof(handlers)) == -1) {
555 * This should leave a ~/.cache/telescope/crashed file to
556 * trigger about:crash on next run. Unfortunately, if
557 * the main process dies the fs sticks around and
558 * doesn't notice that the fd was closed. Why EV_READ
559 * is not triggered when a fd is closed on the other end?
562 if ((fd = open(crashed_file, O_CREAT|O_TRUNC|O_WRONLY, 0600))
566 errx(1, "connection closed: %s", strerror(e));
571 fs_send_ui(int type, uint32_t peerid, int fd, const void *data,
574 return imsg_compose_event(iev_ui, type, peerid, 0, fd,
579 join_path(char *buf, const char *lhs, const char *rhs, size_t buflen)
581 strlcpy(buf, lhs, buflen);
582 return strlcat(buf, rhs, buflen);
586 getenv_default(char *buf, const char *name, const char *def, size_t buflen)
591 if ((home = getenv("HOME")) == NULL)
592 errx(1, "HOME is not defined");
594 if ((env = getenv(name)) != NULL)
595 ret = strlcpy(buf, env, buflen);
597 ret = join_path(buf, home, def, buflen);
600 errx(1, "buffer too small for %s", name);
604 mkdirs(const char *path, mode_t mode)
606 char copy[PATH_MAX+1], orig[PATH_MAX+1], *parent;
608 strlcpy(copy, path, sizeof(copy));
609 strlcpy(orig, path, sizeof(orig));
610 parent = dirname(copy);
611 if (!strcmp(parent, "/"))
613 mkdirs(parent, mode);
615 if (mkdir(orig, mode) != 0) {
618 err(1, "can't mkdir %s", orig);
625 char xdg_config_base[PATH_MAX];
626 char xdg_data_base[PATH_MAX];
627 char xdg_cache_base[PATH_MAX];
628 char old_path[PATH_MAX];
633 if ((home = getenv("HOME")) == NULL)
634 errx(1, "HOME is not defined");
635 join_path(old_path, home, "/.telescope", sizeof(old_path));
637 /* if ~/.telescope exists, use that instead of xdg dirs */
638 if (stat(old_path, &info) == 0 && S_ISDIR(info.st_mode)) {
639 join_path(config_path_base, home, "/.telescope",
640 sizeof(config_path_base));
641 join_path(data_path_base, home, "/.telescope",
642 sizeof(data_path_base));
643 join_path(cache_path_base, home, "/.telescope",
644 sizeof(cache_path_base));
649 getenv_default(xdg_config_base, "XDG_CONFIG_HOME", "/.config",
650 sizeof(xdg_config_base));
651 getenv_default(xdg_data_base, "XDG_DATA_HOME", "/.local/share",
652 sizeof(xdg_data_base));
653 getenv_default(xdg_cache_base, "XDG_CACHE_HOME", "/.cache",
654 sizeof(xdg_cache_base));
656 join_path(config_path_base, xdg_config_base, "/telescope",
657 sizeof(config_path_base));
658 join_path(data_path_base, xdg_data_base, "/telescope",
659 sizeof(data_path_base));
660 join_path(cache_path_base, xdg_cache_base, "/telescope",
661 sizeof(cache_path_base));
663 mkdirs(xdg_config_base, S_IRWXU);
664 mkdirs(xdg_data_base, S_IRWXU);
665 mkdirs(xdg_cache_base, S_IRWXU);
667 mkdirs(config_path_base, S_IRWXU);
668 mkdirs(data_path_base, S_IRWXU);
669 mkdirs(cache_path_base, S_IRWXU);
677 join_path(ctlsock_path, cache_path_base, "/ctl",
678 sizeof(ctlsock_path));
679 join_path(config_path, config_path_base, "/config",
680 sizeof(config_path));
681 join_path(lockfile_path, cache_path_base, "/lock",
682 sizeof(lockfile_path));
683 join_path(bookmark_file, data_path_base, "/bookmarks.gmi",
684 sizeof(bookmark_file));
685 join_path(known_hosts_file, data_path_base, "/known_hosts",
686 sizeof(known_hosts_file));
687 join_path(known_hosts_tmp, cache_path_base,
688 "/known_hosts.tmp.XXXXXXXXXX", sizeof(known_hosts_tmp));
689 join_path(session_file, cache_path_base, "/session",
690 sizeof(session_file));
691 join_path(crashed_file, cache_path_base, "/crashed",
692 sizeof(crashed_file));
698 * Parse a line of the session file. The format is:
700 * URL [flags,...] [title]\n
703 parse_session_line(char *line)
705 struct session_tab tab;
708 memset(&tab, 0, sizeof(tab));
710 if ((s = strchr(line, ' ')) == NULL)
715 if (strlcpy(tab.uri, line, sizeof(tab.uri)) >= sizeof(tab.uri))
718 if ((t = strchr(s, ' ')) != NULL) {
721 /* don't worry about cached title truncation */
722 strlcpy(tab.title, t, sizeof(tab.title));
725 while ((ap = strsep(&s, ",")) != NULL) {
726 if (!strcmp(ap, "current"))
727 tab.flags |= TAB_CURRENT;
728 else if (!strcmp(ap, "killed"))
729 tab.flags |= TAB_KILLED;
730 else if (has_prefix(ap, "top="))
731 tab.top_line = strtonum(ap+4, 0, UINT32_MAX, NULL);
732 else if (has_prefix(ap, "cur="))
733 tab.current_line = strtonum(ap+4, 0, UINT32_MAX, NULL);
736 if (tab.top_line > tab.current_line) {
738 tab.current_line = 0;
741 fs_send_ui(IMSG_SESSION_TAB, 0, -1, &tab, sizeof(tab));
745 sendhist(const char *uri, int future)
747 struct session_tab_hist sth;
749 memset(&sth, 0, sizeof(sth));
752 if (strlcpy(sth.uri, uri, sizeof(sth.uri)) >= sizeof(sth.uri))
755 fs_send_ui(IMSG_SESSION_TAB_HIST, 0, -1, &sth, sizeof(sth));
759 load_last_session(void)
766 char *nl, *s, *line = NULL;
768 if ((session = fopen(session_file, "r")) == NULL) {
774 while ((linelen = getline(&line, &linesize, session)) != -1) {
775 if ((nl = strchr(line, '\n')) != NULL)
778 if (*line == '<' || *line == '>') {
779 future = *line == '>';
783 sendhist(++s, future);
785 parse_session_line(line);
792 if (last_time_crashed()) {
793 struct session_tab tab;
794 memset(&tab, 0, sizeof(tab));
795 tab.flags = TAB_CURRENT;
796 strlcpy(tab.uri, "about:crash", sizeof(tab.uri));
797 fs_send_ui(IMSG_SESSION_TAB, 0, -1, &tab, sizeof(tab));
801 fs_send_ui(IMSG_SESSION_END, 0, -1, &first_time, sizeof(first_time));
813 /* Setup pipe and event handler to the main process */
814 if ((iev_ui = malloc(sizeof(*iev_ui))) == NULL)
816 imsg_init(&iev_ui->ibuf, 3);
817 iev_ui->handler = handle_dispatch_imsg;
818 iev_ui->events = EV_READ;
819 event_set(&iev_ui->ev, iev_ui->ibuf.fd, iev_ui->events,
820 iev_ui->handler, iev_ui);
821 event_add(&iev_ui->ev, NULL);
823 sandbox_fs_process();
830 * Check if the last time telescope crashed. The check is done by
831 * looking at `crashed_file': if it exists then last time we crashed.
832 * Then, while here, touch the file too. During IMSG_QUIT we'll
836 last_time_crashed(void)
843 if (unlink(crashed_file) == -1 && errno == ENOENT)
846 if ((fd = open(crashed_file, O_CREAT|O_WRONLY, 0600)) == -1)
859 if ((fd = open(lockfile_path, O_WRONLY|O_CREAT, 0600)) == -1)
864 lock.l_type = F_WRLCK;
865 lock.l_whence = SEEK_SET;
867 if (fcntl(fd, F_SETLK, &lock) == -1) {
876 parse_khost_line(char *line, char *tmp[3])
880 for (ap = tmp; ap < &tmp[3] &&
881 (*ap = strsep(&line, " \t\n")) != NULL;) {
886 return ap == &tmp[3] && *line == '\0';
892 char *tmp[3], *line = NULL;
894 size_t lineno = 0, linesize = 0;
899 if ((f = fopen(known_hosts_file, "r")) == NULL)
902 while ((linelen = getline(&line, &linesize, f)) != -1) {
905 memset(&e, 0, sizeof(e));
906 if (parse_khost_line(line, tmp)) {
907 strlcpy(e.domain, tmp[0], sizeof(e.domain));
908 strlcpy(e.hash, tmp[1], sizeof(e.hash));
910 e.verified = strtonum(tmp[2], 0, 1, &errstr);
912 errx(1, "%s:%zu verification for %s is %s: %s",
913 known_hosts_file, lineno,
914 e.domain, errstr, tmp[2]);
916 fs_send_ui(IMSG_TOFU, 0, -1, &e, sizeof(e));
918 warnx("%s:%zu invalid entry",
919 known_hosts_file, lineno);