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 config and runtime files
19 */
21 #include "compat.h"
23 #include <sys/stat.h>
24 #include <sys/types.h>
26 #include <dirent.h>
27 #include <errno.h>
28 #include <fcntl.h>
29 #include <limits.h>
30 #include <libgen.h>
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <string.h>
34 #include <unistd.h>
36 #include "pages.h"
37 #include "parser.h"
38 #include "session.h"
39 #include "telescope.h"
40 #include "utils.h"
42 #include "fs.h"
44 #ifndef nitems
45 #define nitems(x) (sizeof(x) / sizeof(x[0]))
46 #endif
48 static void die(void) __attribute__((__noreturn__));
49 static int select_non_dot(const struct dirent *);
50 static int select_non_dotdot(const struct dirent *);
51 static size_t join_path(char*, const char*, const char*, size_t);
52 static void getenv_default(char*, const char*, const char*, size_t);
53 static void mkdirs(const char*, mode_t);
54 static void init_paths(void);
55 static void load_last_session(void);
56 static void load_hist(void);
57 static int last_time_crashed(void);
58 static void load_certs(struct ohash *);
60 /*
61 * Where to store user data. These are all equal to ~/.telescope if
62 * it exists.
63 */
64 char config_path_base[PATH_MAX];
65 char data_path_base[PATH_MAX];
66 char cache_path_base[PATH_MAX];
68 char ctlsock_path[PATH_MAX];
69 char config_path[PATH_MAX];
70 char lockfile_path[PATH_MAX];
71 char bookmark_file[PATH_MAX];
72 char known_hosts_file[PATH_MAX], known_hosts_tmp[PATH_MAX];
73 char crashed_file[PATH_MAX];
74 char session_file[PATH_MAX], session_file_tmp[PATH_MAX];
75 char history_file[PATH_MAX], history_file_tmp[PATH_MAX];
77 static void __attribute__((__noreturn__))
78 die(void)
79 {
80 abort(); /* TODO */
81 }
83 static int
84 select_non_dot(const struct dirent *d)
85 {
86 return strcmp(d->d_name, ".");
87 }
89 static int
90 select_non_dotdot(const struct dirent *d)
91 {
92 return strcmp(d->d_name, ".") && strcmp(d->d_name, "..");
93 }
95 static void
96 send_dir(struct tab *tab, const char *path)
97 {
98 struct dirent **names;
99 int (*selector)(const struct dirent *) = select_non_dot;
100 int i, len;
102 #if notyet
103 /*
104 * need something to fake a redirect
105 */
107 if (!has_suffix(path, "/")) {
108 if (asprintf(&s, "%s/", path) == -1)
109 die();
110 send_hdr(peerid, 30, s);
111 free(s);
112 return;
114 #endif
116 if (!strcmp(path, "/"))
117 selector = select_non_dotdot;
119 if ((len = scandir(path, &names, selector, alphasort)) == -1) {
120 load_page_from_str(tab, "# failure reading the directory\n");
121 return;
124 parser_init(tab, gemtext_initparser);
125 parser_parsef(tab, "# Index of %s\n\n", path);
127 for (i = 0; i < len; ++i) {
128 const char *sufx = "";
130 if (names[i]->d_type == DT_DIR)
131 sufx = "/";
133 parser_parsef(tab, "=> %s%s\n", names[i]->d_name, sufx);
136 parser_free(tab);
137 free(names);
140 static int
141 is_dir(FILE *fp)
143 struct stat sb;
145 if (fstat(fileno(fp), &sb) == -1)
146 return 0;
148 return S_ISDIR(sb.st_mode);
151 static parserinit
152 file_type(const char *path)
154 const struct mapping {
155 const char *ext;
156 parserinit fn;
157 } ms[] = {
158 {"diff", textpatch_initparser},
159 {"gemini", gemtext_initparser},
160 {"gmi", gemtext_initparser},
161 {"markdown", textplain_initparser},
162 {"md", textplain_initparser},
163 {"patch", gemtext_initparser},
164 {NULL, NULL},
165 }, *m;
166 const char *dot;
168 if ((dot = strrchr(path, '.')) == NULL)
169 return textplain_initparser;
171 dot++;
173 for (m = ms; m->ext != NULL; ++m)
174 if (!strcmp(m->ext, dot))
175 return m->fn;
177 return textplain_initparser;
180 void
181 fs_load_url(struct tab *tab, const char *url)
183 const char *bpath = "bookmarks.gmi", *fallback = "# Not found\n";
184 parserinit initfn = gemtext_initparser;
185 char path[PATH_MAX];
186 FILE *fp = NULL;
187 size_t i;
188 char buf[BUFSIZ];
189 struct page {
190 const char *name;
191 const char *path;
192 const uint8_t *data;
193 size_t len;
194 } pages[] = {
195 {"about", NULL, about_about, about_about_len},
196 {"blank", NULL, about_blank, about_blank_len},
197 {"bookmarks", bpath, bookmarks, bookmarks_len},
198 {"crash", NULL, about_crash, about_crash_len},
199 {"help", NULL, about_help, about_help_len},
200 {"license", NULL, about_license, about_license_len},
201 {"new", NULL, about_new, about_new_len},
202 }, *page = NULL;
204 if (!strncmp(url, "about:", 6)) {
205 url += 6;
207 for (i = 0; page == NULL && i < nitems(pages); ++i) {
208 if (!strcmp(url, pages[i].name))
209 page = &pages[i];
212 if (page == NULL)
213 goto done;
215 strlcpy(path, data_path_base, sizeof(path));
216 strlcat(path, "/", sizeof(path));
217 if (page->path != NULL)
218 strlcat(path, page->path, sizeof(path));
219 else {
220 strlcat(path, "page/about_", sizeof(path));
221 strlcat(path, page->name, sizeof(path));
222 strlcat(path, ".gmi", sizeof(path));
225 fallback = page->data;
226 } else if (!strncmp(url, "file://", 7)) {
227 url += 7;
228 strlcpy(path, url, sizeof(path));
229 initfn = file_type(url);
230 } else
231 goto done;
233 if ((fp = fopen(path, "r")) == NULL)
234 goto done;
236 if (is_dir(fp)) {
237 fclose(fp);
238 send_dir(tab, path);
239 goto done;
242 parser_init(tab, initfn);
243 for (;;) {
244 size_t r;
246 r = fread(buf, 1, sizeof(buf), fp);
247 if (!parser_parse(tab, buf, r))
248 break;
249 if (r != sizeof(buf))
250 break;
252 parser_free(tab);
254 done:
255 if (fp != NULL)
256 fclose(fp);
257 else
258 load_page_from_str(tab, fallback);
261 static size_t
262 join_path(char *buf, const char *lhs, const char *rhs, size_t buflen)
264 strlcpy(buf, lhs, buflen);
265 return strlcat(buf, rhs, buflen);
268 static void
269 getenv_default(char *buf, const char *name, const char *def, size_t buflen)
271 size_t ret;
272 char *home, *env;
274 if ((home = getenv("HOME")) == NULL)
275 errx(1, "HOME is not defined");
277 if ((env = getenv(name)) != NULL)
278 ret = strlcpy(buf, env, buflen);
279 else
280 ret = join_path(buf, home, def, buflen);
282 if (ret >= buflen)
283 errx(1, "buffer too small for %s", name);
286 static void
287 mkdirs(const char *path, mode_t mode)
289 char copy[PATH_MAX+1], orig[PATH_MAX+1], *parent;
291 strlcpy(copy, path, sizeof(copy));
292 strlcpy(orig, path, sizeof(orig));
293 parent = dirname(copy);
294 if (!strcmp(parent, "/"))
295 return;
296 mkdirs(parent, mode);
298 if (mkdir(orig, mode) != 0) {
299 if (errno == EEXIST)
300 return;
301 err(1, "can't mkdir %s", orig);
305 static void
306 init_paths(void)
308 char xdg_config_base[PATH_MAX];
309 char xdg_data_base[PATH_MAX];
310 char xdg_cache_base[PATH_MAX];
311 char old_path[PATH_MAX];
312 char *home;
313 struct stat info;
315 /* old path */
316 if ((home = getenv("HOME")) == NULL)
317 errx(1, "HOME is not defined");
318 join_path(old_path, home, "/.telescope", sizeof(old_path));
320 /* if ~/.telescope exists, use that instead of xdg dirs */
321 if (stat(old_path, &info) == 0 && S_ISDIR(info.st_mode)) {
322 join_path(config_path_base, home, "/.telescope",
323 sizeof(config_path_base));
324 join_path(data_path_base, home, "/.telescope",
325 sizeof(data_path_base));
326 join_path(cache_path_base, home, "/.telescope",
327 sizeof(cache_path_base));
328 return;
331 /* xdg paths */
332 getenv_default(xdg_config_base, "XDG_CONFIG_HOME", "/.config",
333 sizeof(xdg_config_base));
334 getenv_default(xdg_data_base, "XDG_DATA_HOME", "/.local/share",
335 sizeof(xdg_data_base));
336 getenv_default(xdg_cache_base, "XDG_CACHE_HOME", "/.cache",
337 sizeof(xdg_cache_base));
339 join_path(config_path_base, xdg_config_base, "/telescope",
340 sizeof(config_path_base));
341 join_path(data_path_base, xdg_data_base, "/telescope",
342 sizeof(data_path_base));
343 join_path(cache_path_base, xdg_cache_base, "/telescope",
344 sizeof(cache_path_base));
346 mkdirs(xdg_config_base, S_IRWXU);
347 mkdirs(xdg_data_base, S_IRWXU);
348 mkdirs(xdg_cache_base, S_IRWXU);
350 mkdirs(config_path_base, S_IRWXU);
351 mkdirs(data_path_base, S_IRWXU);
352 mkdirs(cache_path_base, S_IRWXU);
355 int
356 fs_init(void)
358 init_paths();
360 join_path(ctlsock_path, cache_path_base, "/ctl",
361 sizeof(ctlsock_path));
362 join_path(config_path, config_path_base, "/config",
363 sizeof(config_path));
364 join_path(lockfile_path, cache_path_base, "/lock",
365 sizeof(lockfile_path));
366 join_path(bookmark_file, data_path_base, "/bookmarks.gmi",
367 sizeof(bookmark_file));
368 join_path(known_hosts_file, data_path_base, "/known_hosts",
369 sizeof(known_hosts_file));
370 join_path(known_hosts_tmp, cache_path_base,
371 "/known_hosts.tmp.XXXXXXXXXX", sizeof(known_hosts_tmp));
372 join_path(session_file, cache_path_base, "/session",
373 sizeof(session_file));
374 join_path(session_file_tmp, cache_path_base, "/session.XXXXXXXXXX",
375 sizeof(session_file));
376 join_path(history_file, cache_path_base, "/history",
377 sizeof(history_file));
378 join_path(history_file_tmp, cache_path_base, "/history.XXXXXXXXXX",
379 sizeof(history_file));
380 join_path(crashed_file, cache_path_base, "/crashed",
381 sizeof(crashed_file));
383 return 1;
386 /*
387 * Parse a line of the session file and restores it. The format is:
389 * URL [flags,...] [title]\n
390 */
391 static inline struct tab *
392 parse_session_line(char *line, struct tab **ct)
394 struct tab *tab;
395 char *s, *t, *ap;
396 const char *uri, *title = "";
397 int current = 0, killed = 0;
398 size_t top_line = 0, current_line = 0;
400 uri = line;
401 if ((s = strchr(line, ' ')) == NULL)
402 return NULL;
404 *s++ = '\0';
406 if ((t = strchr(s, ' ')) != NULL) {
407 *t++ = '\0';
408 title = t;
411 while ((ap = strsep(&s, ",")) != NULL) {
412 if (!strcmp(ap, "current"))
413 current = 1;
414 else if (!strcmp(ap, "killed"))
415 killed = 1;
416 else if (has_prefix(ap, "top="))
417 top_line = strtonum(ap+4, 0, UINT32_MAX, NULL);
418 else if (has_prefix(ap, "cur="))
419 current_line = strtonum(ap+4, 0, UINT32_MAX, NULL);
422 if (top_line > current_line) {
423 top_line = 0;
424 current_line = 0;
427 if ((tab = new_tab(uri, NULL, NULL)) == NULL)
428 die();
429 tab->hist_cur->line_off = top_line;
430 tab->hist_cur->current_off = current_line;
431 strlcpy(tab->buffer.page.title, title, sizeof(tab->buffer.page.title));
433 if (current)
434 *ct = tab;
435 else if (killed)
436 kill_tab(tab, 1);
438 return tab;
441 static inline void
442 sendhist(struct tab *tab, const char *uri, int future)
444 struct hist *h;
446 if ((h = calloc(1, sizeof(*h))) == NULL)
447 die();
448 strlcpy(h->h, uri, sizeof(h->h));
450 if (future)
451 hist_push(&tab->hist, h);
452 else
453 hist_add_before(&tab->hist, tab->hist_cur, h);
456 static void
457 load_last_session(void)
459 struct tab *tab = NULL, *ct = NULL;
460 FILE *session;
461 size_t linesize = 0;
462 ssize_t linelen;
463 int future;
464 char *nl, *s, *line = NULL;
466 if ((session = fopen(session_file, "r")) == NULL) {
467 new_tab("about:new", NULL, NULL);
468 switch_to_tab(new_tab("about:help", NULL, NULL));
469 return;
472 while ((linelen = getline(&line, &linesize, session)) != -1) {
473 if ((nl = strchr(line, '\n')) != NULL)
474 *nl = '\0';
476 if (*line == '<' || *line == '>') {
477 future = *line == '>';
478 s = line+1;
479 if (*s != ' ' || tab == NULL)
480 continue;
481 sendhist(tab, ++s, future);
482 } else {
483 tab = parse_session_line(line, &ct);
487 fclose(session);
488 free(line);
490 if (ct != NULL)
491 switch_to_tab(ct);
493 if (last_time_crashed())
494 switch_to_tab(new_tab("about:crash", NULL, NULL));
497 static void
498 load_hist(void)
500 FILE *hist;
501 size_t linesize = 0;
502 ssize_t linelen;
503 char *nl, *spc, *line = NULL;
504 const char *errstr;
505 struct histitem hi;
507 if ((hist = fopen(history_file, "r")) == NULL)
508 return;
510 while ((linelen = getline(&line, &linesize, hist)) != -1) {
511 if ((nl = strchr(line, '\n')) != NULL)
512 *nl = '\0';
513 if ((spc = strchr(line, ' ')) == NULL)
514 continue;
515 *spc = '\0';
516 spc++;
518 memset(&hi, 0, sizeof(hi));
519 hi.ts = strtonum(line, INT64_MIN, INT64_MAX, &errstr);
520 if (errstr != NULL)
521 continue;
522 if (strlcpy(hi.uri, spc, sizeof(hi.uri)) >= sizeof(hi.uri))
523 continue;
525 history_push(&hi);
528 fclose(hist);
529 free(line);
531 history_sort();
534 int
535 fs_load_state(struct ohash *certs)
537 load_certs(certs);
538 load_hist();
539 load_last_session();
540 return 0;
543 /*
544 * Check if the last time telescope crashed. The check is done by
545 * looking at `crashed_file': if it exists then last time we crashed.
546 * Then, while here, touch the file too. During IMSG_QUIT we'll
547 * remove it.
548 */
549 static int
550 last_time_crashed(void)
552 int fd, crashed = 1;
554 if (safe_mode)
555 return 0;
557 if (unlink(crashed_file) == -1 && errno == ENOENT)
558 crashed = 0;
560 if ((fd = open(crashed_file, O_CREAT|O_WRONLY, 0600)) == -1)
561 return crashed;
562 close(fd);
564 return crashed;
567 int
568 lock_session(void)
570 struct flock lock;
571 int fd;
573 if ((fd = open(lockfile_path, O_WRONLY|O_CREAT, 0600)) == -1)
574 return -1;
576 lock.l_start = 0;
577 lock.l_len = 0;
578 lock.l_type = F_WRLCK;
579 lock.l_whence = SEEK_SET;
581 if (fcntl(fd, F_SETLK, &lock) == -1) {
582 close(fd);
583 return -1;
586 return fd;
589 static inline int
590 parse_khost_line(char *line, char *tmp[3])
592 char **ap;
594 for (ap = tmp; ap < &tmp[3] &&
595 (*ap = strsep(&line, " \t\n")) != NULL;) {
596 if (**ap != '\0')
597 ap++;
600 return ap == &tmp[3] && *line == '\0';
603 static void
604 load_certs(struct ohash *certs)
606 char *tmp[3], *line = NULL;
607 const char *errstr;
608 size_t lineno = 0, linesize = 0;
609 ssize_t linelen;
610 FILE *f;
611 struct tofu_entry *e;
613 if ((f = fopen(known_hosts_file, "r")) == NULL)
614 return;
616 if ((e = calloc(1, sizeof(*e))) == NULL) {
617 fclose(f);
618 return;
621 while ((linelen = getline(&line, &linesize, f)) != -1) {
622 lineno++;
624 if (parse_khost_line(line, tmp)) {
625 strlcpy(e->domain, tmp[0], sizeof(e->domain));
626 strlcpy(e->hash, tmp[1], sizeof(e->hash));
628 e->verified = strtonum(tmp[2], 0, 1, &errstr);
629 if (errstr != NULL)
630 errx(1, "%s:%zu verification for %s is %s: %s",
631 known_hosts_file, lineno,
632 e->domain, errstr, tmp[2]);
634 tofu_add(certs, e);
635 } else {
636 warnx("%s:%zu invalid entry",
637 known_hosts_file, lineno);
641 free(line);
642 fclose(f);
643 return;