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