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