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 #ifndef TELESCOPE_H
18 #define TELESCOPE_H
19 
20 #include "cmd.h"
21 #include "compat.h"
22 #include "phos/phos.h"
23 
24 #include <event.h>
25 
26 #define MIN(a, b) ((a) < (b) ? (a) : (b))
27 #define MAX(a, b) ((a) > (b) ? (a) : (b))
28 
29 #define GEMINI_URL_LEN 1024
30 
31 enum imsg_type {
32 	/* ui <-> client/fs */
33 	IMSG_GET,		/* data is URL, peerid the tab id */
34 	IMSG_GET_RAW,		/* get but with an explicit req str */
35 	IMSG_ERR,
36 	IMSG_CHECK_CERT,
37 	IMSG_CERT_STATUS,
38 	IMSG_GOT_CODE,
39 	IMSG_GOT_META,
40 	IMSG_PROCEED,
41 	IMSG_STOP,
42 	IMSG_BUF,
43 	IMSG_EOF,
44 	IMSG_QUIT,
45 
46 	/* ui <-> fs */
47 	IMSG_BOOKMARK_PAGE,
48 	IMSG_BOOKMARK_OK,
49 	IMSG_SAVE_CERT,
50 	IMSG_SAVE_CERT_OK,
51 	IMSG_UPDATE_CERT,
52 	IMSG_UPDATE_CERT_OK,
53 
54 	IMSG_FILE_OPEN,
55 	IMSG_FILE_OPENED,
56 
57 	IMSG_SESSION_START,
58 	IMSG_SESSION_TAB,
59 	IMSG_SESSION_END,
60 };
61 
62 extern char	*new_tab_url;
63 extern int	 fill_column;
64 extern int	 olivetti_mode;
65 extern int	 enable_colors;
66 
67 struct lineprefix {
68 	const char	*prfx1;
69 	const char	*prfx2;
70 };
71 extern struct lineprefix line_prefixes[];
72 
73 struct line_face {
74 	int prfx_pair, pair, trail_pair;
75 	int prfx_bg, bg, trail_bg;
76 	int prfx_fg, fg, trail_fg;
77 	int prfx_attr, attr, trail_attr;
78 
79 	int prefix, text, trail;
80 };
81 extern struct line_face line_faces[];
82 
83 struct tab_face  {
84 	int bg_attr, bg_bg, bg_fg;
85 	int t_attr, t_bg, t_fg;
86 	int c_attr, c_bg, c_fg;
87 
88 	int background, tab, current;
89 };
90 extern struct tab_face tab_face;
91 
92 struct body_face {
93 	int lbg, lfg;
94 	int bg, fg;
95 	int rbg, rfg;
96 
97 	int left, body, right;
98 };
99 extern struct body_face body_face;
100 
101 struct modeline_face {
102 	int bg, fg, attr;
103 	int background;
104 };
105 extern struct modeline_face modeline_face;
106 
107 struct minibuffer_face {
108 	int bg, fg, attr;
109 	int background;
110 };
111 extern struct minibuffer_face minibuffer_face;
112 
113 enum line_type {
114 	LINE_TEXT,
115 	LINE_LINK,
116 	LINE_TITLE_1,
117 	LINE_TITLE_2,
118 	LINE_TITLE_3,
119 	LINE_ITEM,
120 	LINE_QUOTE,
121 	LINE_PRE_START,
122 	LINE_PRE_CONTENT,
123 	LINE_PRE_END,
124 };
125 
126 struct line {
127 	enum line_type		 type;
128 	char			*line;
129 	char			*alt;
130 	int			 flags;
131 	TAILQ_ENTRY(line)	 lines;
132 };
133 
134 struct vline {
135 	const struct line	*parent;
136 	char			*line;
137 	int			 flags;
138 	TAILQ_ENTRY(vline)	 vlines;
139 };
140 
141 struct parser;
142 struct page;
143 
144 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
145 typedef int	(*parserfreefn)(struct parser*);
146 
147 typedef void (imsg_handlerfn)(struct imsg*, size_t);
148 
149 struct parser {
150 	const char	*name;
151 	char		 title[32+1];
152 	char		*buf;
153 	size_t		 len;
154 	size_t		 cap;
155 	int		 flags;
156 	parsechunkfn	 parse;
157 	parserfreefn	 free;
158 
159 	TAILQ_HEAD(, line)	 head;
160 };
161 
162 /*
163  * differnt types of trust for a certificate.  Following
164  * gemini://thfr.info/gemini/modified-trust-verify.gmi
165  */
166 enum trust_state {
167 	TS_UNKNOWN,
168 	TS_UNTRUSTED,
169 	TS_TRUSTED,
170 	TS_VERIFIED,
171 };
172 
173 struct tofu_entry {
174 	char	domain[GEMINI_URL_LEN];
175 
176 	/*
177 	 * enough space for ``PROTO:HASH''.  probably isn't a good
178 	 * idea tho.
179 	 */
180 	char	hash[128+1];
181 	int	verified;
182 };
183 
184 struct histhead {
185 	TAILQ_HEAD(mhisthead, hist)	head;
186 	size_t				len;
187 };
188 struct hist {
189 	char			h[1025];
190 	TAILQ_ENTRY(hist)	entries;
191 };
192 
193 struct buffer {
194 	struct parser		 page;
195 
196 	size_t			 last_line_off;
197 	int			 force_redraw;
198 
199 	int			 curs_x;
200 	int			 curs_y;
201 	size_t			 line_off;
202 	size_t			 line_max;
203 	struct vline		*top_line;
204 	struct vline		*current_line;
205 	size_t			 cpoff;
206 	TAILQ_HEAD(vhead, vline) head;
207 };
208 
209 #define TAB_CURRENT	0x1
210 #define TAB_URGENT	0x2
211 
212 #define NEW_TAB_URL	"about:new"
213 
214 extern TAILQ_HEAD(tabshead, tab) tabshead;
215 struct tab {
216 	TAILQ_ENTRY(tab)	 tabs;
217 	uint32_t		 id;
218 	uint32_t		 flags;
219 
220 	char			*cert;
221 	enum trust_state	 trust;
222 	struct proxy		*proxy;
223 	struct phos_uri		 uri;
224 	struct histhead		 hist;
225 	struct hist		*hist_cur;
226 	size_t			 hist_off;
227 
228 	int			 code;
229 	char			 meta[GEMINI_URL_LEN];
230 	int			 redirect_count;
231 
232 	struct buffer		 buffer;
233 
234 	short			 loading_anim;
235 	short			 loading_anim_step;
236 	struct event		 loadingev;
237 
238 	int			 fd;
239 	size_t			 bytes;
240 	char			*path;
241 };
242 
243 struct proto {
244 	const char	*schema;
245 
246 	/*
247 	 * should load the given url in the tab.  Optionally, it may
248 	 * consider the given url as relative to the one already
249 	 * present in tab.  It must set tab->urlstr to a serialized
250 	 * human-friendly URL.
251 	 */
252 	void		 (*loadfn)(struct tab*, const char*);
253 };
254 
255 extern TAILQ_HEAD(proxylist, proxy) proxies;
256 struct proxy {
257 	char	*match_proto;
258 
259 	char	*host;
260 	char	*port;
261 	int	 proto;
262 
263 	TAILQ_ENTRY(proxy) proxies;
264 };
265 
266 enum {
267 	PROTO_GEMINI,
268 	/* ... */
269 };
270 
271 struct get_req {
272 	int		proto;
273 	char		host[254];
274 	char		port[16];
275 	char		req[1027];
276 };
277 
278 struct kmap {
279 	TAILQ_HEAD(map, keymap)	m;
280 	void			(*unhandled_input)(void);
281 };
282 extern struct kmap global_map, minibuffer_map;
283 
284 typedef void(interactivefn)(struct buffer *);
285 
286 struct keymap {
287 	int			 meta;
288 	int			 key;
289 	struct kmap		 map;
290 	interactivefn		 *fn;
291 
292 	TAILQ_ENTRY(keymap)	 keymaps;
293 };
294 
295 struct cmd {
296 	const char	*cmd;
297 	void		(*fn)(struct buffer *);
298 };
299 extern struct cmd cmds[];
300 
301 /* defaults.c */
302 void		 config_init(void);
303 int		 config_setprfx(const char *, const char *, const char *);
304 int		 config_setvari(const char *, int);
305 int		 config_setvars(const char *, char *);
306 int		 config_setcolor(int, const char *, int, int, int);
307 int		 config_setattr(const char *, int, int, int);
308 void		 config_apply_style(void);
309 
310 /* fs.c */
311 int		 fs_init(void);
312 int		 fs_main(struct imsgbuf*);
313 int		 load_certs(struct ohash*);
314 int		 load_last_session(void(*)(const char*));
315 
316 /* gemini.c */
317 int		 client_main(struct imsgbuf*);
318 
319 /* gemtext.c */
320 void		 gemtext_initparser(struct parser*);
321 
322 /* hist.c */
323 void		 hist_clear_forward(struct histhead*, struct hist*);
324 void		 hist_push(struct histhead*, struct hist*);
325 
326 /* keymap.c */
327 int		 kbd(const char*);
328 const char	*unkbd(int);
329 int		 kmap_define_key(struct kmap*, const char*, void(*)(struct buffer*));
330 
331 /* mime.c */
332 int		 setup_parser_for(struct tab*);
333 
334 /* pages.c */
335 extern const char	*about_about;
336 extern const char	*about_blank;
337 extern const char	*about_help;
338 extern const char	*about_new;
339 
340 #define CANNOT_FETCH		0
341 #define TOO_MUCH_REDIRECTS	1
342 #define MALFORMED_RESPONSE	2
343 #define UNKNOWN_TYPE_OR_CSET	3
344 extern const char	*err_pages[70];
345 
346 /* parse.y */
347 void		 parseconfig(const char *, int);
348 
349 /* parser.c */
350 int		 parser_append(struct parser*, const char*, size_t);
351 int		 parser_set_buf(struct parser*, const char*, size_t);
352 int		 parser_foreach_line(struct parser*, const char*, size_t, parsechunkfn);
353 
354 /* sandbox.c */
355 void		 sandbox_network_process(void);
356 void		 sandbox_ui_process(void);
357 void		 sandbox_fs_process(void);
358 
359 /* telescope.c */
360 void		 load_about_url(struct tab*, const char*);
361 void		 load_gemini_url(struct tab*, const char*);
362 void		 load_via_proxy(struct tab *, const char *, struct proxy *);
363 void		 load_url(struct tab*, const char*);
364 int		 load_previous_page(struct tab*);
365 int		 load_next_page(struct tab*);
366 void		 stop_tab(struct tab*);
367 void		 add_to_bookmarks(const char*);
368 void		 save_session(void);
369 
370 /* textplain.c */
371 void		 textplain_initparser(struct parser*);
372 
373 /* tofu.c */
374 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
375 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
376 void			 tofu_add(struct ohash*, struct tofu_entry*);
377 void			 tofu_update(struct ohash*, struct tofu_entry*);
378 
379 /* ui.c */
380 extern int	 body_lines;
381 extern int	 body_cols;
382 extern int	 in_minibuffer;
383 
384 struct excursion {
385 	int		 curs_x, curs_y;
386 	size_t		 line_off;
387 	struct vline	*current_line;
388 	size_t		 cpoff;
389 };
390 
391 enum pairs {
392 	PTL_BG = 1,
393 	PTL_TAB,
394 	PTL_CURR,
395 
396 	PBODY,
397 	PBLEFT,
398 	PBRIGHT,
399 
400 	PT,
401 	PT_PRFX,
402 	PT_TRAIL,
403 	PL,
404 	PL_PRFX,
405 	PL_TRAIL,
406 	PT1,
407 	PT1_PRFX,
408 	PT1_TRAIL,
409 	PT2,
410 	PT2_PRFX,
411 	PT2_TRAIL,
412 	PT3,
413 	PT3_PRFX,
414 	PT3_TRAIL,
415 	PI,
416 	PI_PRFX,
417 	PI_TRAIL,
418 	PQ,
419 	PQ_PRFX,
420 	PQ_TRAIL,
421 	PPSTART,
422 	PPSTART_PRFX,
423 	PPSTART_TRAIL,
424 	PP,
425 	PP_PRFX,
426 	PP_TRAIL,
427 	PPEND,
428 	PPEND_PRFX,
429 	PPEND_TRAIL,
430 
431 	PMODELINE,
432 
433 	PMINIBUF,
434 };
435 
436 struct thiskey {
437 	short meta;
438 	int key;
439 	uint32_t cp;
440 };
441 extern struct thiskey thiskey;
442 
443 extern struct histhead eecmd_history,
444 	ir_history,
445 	lu_history,
446 	read_history;
447 
448 struct ministate {
449 	char		*curmesg;
450 
451 	char		 prompt[64];
452 	void		 (*donefn)(void);
453 	void		 (*abortfn)(void);
454 
455 	char		 buf[1025];
456 	struct line	 line;
457 	struct vline	 vline;
458 	struct buffer	 buffer;
459 
460 	struct histhead	*history;
461 	struct hist	*hist_cur;
462 	size_t		 hist_off;
463 };
464 extern struct ministate ministate;
465 
466 void		 save_excursion(struct excursion *, struct buffer *);
467 void		 restore_excursion(struct excursion *, struct buffer *);
468 void		 minibuffer_taint_hist(void);
469 void		 eecmd_self_insert(void);
470 void		 eecmd_select(void);
471 void		 ir_self_insert(void);
472 void		 ir_select(void);
473 void		 lu_self_insert(void);
474 void		 lu_select(void);
475 void		 bp_select(void);
476 void		 vmessage(const char*, va_list);
477 void		 message(const char*, ...) __attribute__((format(printf, 1, 2)));
478 void		 start_loading_anim(struct tab *tab);
479 void		 load_url_in_tab(struct tab *, const char *);
480 void		 enter_minibuffer(void(*)(void), void(*)(void), void(*)(void), struct histhead *);
481 void		 exit_minibuffer(void);
482 void		 switch_to_tab(struct tab *);
483 struct tab	*current_tab(void);
484 struct tab	*new_tab(const char *);
485 unsigned int	 tab_new_id(void);
486 int		 ui_init(int, char * const*);
487 void		 ui_on_tab_loaded(struct tab*);
488 void		 ui_on_tab_refresh(struct tab*);
489 const char	*ui_keyname(int);
490 void		 ui_toggle_side_window(void);
491 void		 ui_schedule_redraw(void);
492 void		 ui_require_input(struct tab*, int);
493 void		 ui_read(const char*, void(*)(const char*, unsigned int), unsigned int);
494 void		 ui_yornp(const char*, void (*)(int, unsigned int), unsigned int);
495 void		 ui_end(void);
496 
497 /* utf.8 */
498 uint32_t	 utf8_decode(uint32_t*restrict, uint32_t*restrict, uint8_t);
499 size_t		 utf8_encode(uint32_t, char*);
500 char		*utf8_nth(char*, size_t);
501 size_t		 utf8_cplen(char*);
502 size_t		 utf8_chwidth(uint32_t);
503 size_t		 utf8_snwidth(const char*, size_t);
504 size_t		 utf8_swidth(const char*);
505 size_t		 utf8_swidth_between(const char*, const char*);
506 char		*utf8_next_cp(const char*);
507 char		*utf8_prev_cp(const char*, const char*);
508 
509 /* util.c */
510 int		 mark_nonblock(int);
511 int		 has_prefix(const char*, const char*);
512 int		 unicode_isspace(uint32_t);
513 int		 unicode_isgraph(uint32_t);
514 void		 dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
515 
516 /* wrap.c */
517 void		 erase_buffer(struct buffer *);
518 void		 empty_linelist(struct buffer*);
519 void		 empty_vlist(struct buffer*);
520 int		 wrap_text(struct buffer*, const char*, struct line*, size_t);
521 int		 hardwrap_text(struct buffer*, struct line*, size_t);
522 
523 #endif /* TELESCOPE_H */