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_ERR,
35 	IMSG_CHECK_CERT,
36 	IMSG_CERT_STATUS,
37 	IMSG_GOT_CODE,
38 	IMSG_GOT_META,
39 	IMSG_PROCEED,
40 	IMSG_STOP,
41 	IMSG_BUF,
42 	IMSG_EOF,
43 	IMSG_QUIT,
44 
45 	/* ui <-> fs */
46 	IMSG_BOOKMARK_PAGE,
47 	IMSG_BOOKMARK_OK,
48 	IMSG_SAVE_CERT,
49 	IMSG_SAVE_CERT_OK,
50 	IMSG_UPDATE_CERT,
51 	IMSG_UPDATE_CERT_OK,
52 
53 	IMSG_FILE_OPEN,
54 	IMSG_FILE_OPENED,
55 
56 	IMSG_SESSION_START,
57 	IMSG_SESSION_TAB,
58 	IMSG_SESSION_END,
59 };
60 
61 extern char	*new_tab_url;
62 extern int	 fill_column;
63 extern int	 olivetti_mode;
64 extern int	 enable_colors;
65 
66 struct lineprefix {
67 	const char	*prfx1;
68 	const char	*prfx2;
69 };
70 extern struct lineprefix line_prefixes[];
71 
72 struct line_face {
73 	int prefix_prop;
74 	int text_prop;
75 };
76 extern struct line_face line_faces[];
77 
78 struct tab_face  {
79 	int background, tab, current_tab;
80 };
81 extern struct tab_face tab_face;
82 
83 struct modeline_face {
84 	int background;
85 };
86 extern struct modeline_face modeline_face;
87 
88 struct minibuffer_face {
89 	int background;
90 };
91 extern struct minibuffer_face minibuffer_face;
92 
93 enum line_type {
94 	LINE_TEXT,
95 	LINE_LINK,
96 	LINE_TITLE_1,
97 	LINE_TITLE_2,
98 	LINE_TITLE_3,
99 	LINE_ITEM,
100 	LINE_QUOTE,
101 	LINE_PRE_START,
102 	LINE_PRE_CONTENT,
103 	LINE_PRE_END,
104 };
105 
106 struct line {
107 	enum line_type		 type;
108 	char			*line;
109 	char			*alt;
110 	int			 flags;
111 	TAILQ_ENTRY(line)	 lines;
112 };
113 
114 struct vline {
115 	const struct line	*parent;
116 	char			*line;
117 	int			 flags;
118 	TAILQ_ENTRY(vline)	 vlines;
119 };
120 
121 struct parser;
122 struct page;
123 
124 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
125 typedef int	(*parserfreefn)(struct parser*);
126 
127 typedef void (imsg_handlerfn)(struct imsg*, size_t);
128 
129 struct parser {
130 	const char	*name;
131 	char		 title[32+1];
132 	char		*buf;
133 	size_t		 len;
134 	size_t		 cap;
135 	int		 flags;
136 	parsechunkfn	 parse;
137 	parserfreefn	 free;
138 
139 	TAILQ_HEAD(, line)	 head;
140 };
141 
142 /*
143  * differnt types of trust for a certificate.  Following
144  * gemini://thfr.info/gemini/modified-trust-verify.gmi
145  */
146 enum trust_state {
147 	TS_UNKNOWN,
148 	TS_UNTRUSTED,
149 	TS_TRUSTED,
150 	TS_VERIFIED,
151 };
152 
153 struct tofu_entry {
154 	char	domain[GEMINI_URL_LEN];
155 
156 	/*
157 	 * enough space for ``PROTO:HASH''.  probably isn't a good
158 	 * idea tho.
159 	 */
160 	char	hash[128+1];
161 	int	verified;
162 };
163 
164 struct histhead {
165 	TAILQ_HEAD(mhisthead, hist)	head;
166 	size_t				len;
167 };
168 struct hist {
169 	char			h[1025];
170 	TAILQ_ENTRY(hist)	entries;
171 };
172 
173 struct buffer {
174 	struct parser		 page;
175 
176 	size_t			 last_line_off;
177 	int			 force_redraw;
178 
179 	int			 curs_x;
180 	int			 curs_y;
181 	size_t			 line_off;
182 	size_t			 line_max;
183 	struct vline		*current_line;
184 	size_t			 cpoff;
185 	TAILQ_HEAD(vhead, vline) head;
186 };
187 
188 
189 #define TAB_CURRENT	0x1
190 #define TAB_URGENT	0x2
191 
192 #define NEW_TAB_URL	"about:new"
193 
194 extern TAILQ_HEAD(tabshead, tab) tabshead;
195 struct tab {
196 	TAILQ_ENTRY(tab)	 tabs;
197 	uint32_t		 id;
198 	uint32_t		 flags;
199 
200 	char			*cert;
201 	enum trust_state	 trust;
202 	struct phos_uri		 uri;
203 	struct histhead		 hist;
204 	struct hist		*hist_cur;
205 	size_t			 hist_off;
206 
207 	int			 code;
208 	char			 meta[GEMINI_URL_LEN];
209 	int			 redirect_count;
210 
211 	struct buffer		 buffer;
212 
213 	short			 loading_anim;
214 	short			 loading_anim_step;
215 	struct event		 loadingev;
216 
217 	int			 fd;
218 	size_t			 bytes;
219 	char			*path;
220 };
221 
222 struct proto {
223 	const char	*schema;
224 
225 	/*
226 	 * should load the given url in the tab.  Optionally, it may
227 	 * consider the given url as relative to the one already
228 	 * present in tab.  It must set tab->urlstr to a serialized
229 	 * human-friendly URL.
230 	 */
231 	void		 (*loadfn)(struct tab*, const char*);
232 };
233 
234 struct kmap {
235 	TAILQ_HEAD(map, keymap)	m;
236 	void			(*unhandled_input)(void);
237 };
238 
239 struct keymap {
240 	int			 meta;
241 	int			 key;
242 	struct kmap		 map;
243 	void			(*fn)(struct buffer*);
244 
245 	TAILQ_ENTRY(keymap)	 keymaps;
246 };
247 
248 /* defaults.c */
249 int		 config_setprfx(const char *, int, const char *);
250 int		 config_setvari(const char *, int);
251 int		 config_setvars(const char *, char *);
252 
253 /* fs.c */
254 int		 fs_init(void);
255 int		 fs_main(struct imsgbuf*);
256 int		 load_certs(struct ohash*);
257 int		 load_last_session(void(*)(const char*));
258 
259 /* gemini.c */
260 int		 client_main(struct imsgbuf*);
261 
262 /* gemtext.c */
263 void		 gemtext_initparser(struct parser*);
264 
265 /* hist.c */
266 void		 hist_clear_forward(struct histhead*, struct hist*);
267 void		 hist_push(struct histhead*, struct hist*);
268 
269 /* keymap.c */
270 int		 kbd(const char*);
271 const char	*unkbd(int);
272 int		 kmap_define_key(struct kmap*, const char*, void(*)(struct buffer*));
273 
274 /* mime.c */
275 int		 setup_parser_for(struct tab*);
276 
277 /* pages.c */
278 extern const char	*about_about;
279 extern const char	*about_blank;
280 extern const char	*about_help;
281 extern const char	*about_new;
282 
283 #define CANNOT_FETCH		0
284 #define TOO_MUCH_REDIRECTS	1
285 #define MALFORMED_RESPONSE	2
286 #define UNKNOWN_TYPE_OR_CSET	3
287 extern const char	*err_pages[70];
288 
289 /* parse.y */
290 void		 parseconfig(const char *, int);
291 
292 /* parser.c */
293 int		 parser_append(struct parser*, const char*, size_t);
294 int		 parser_set_buf(struct parser*, const char*, size_t);
295 int		 parser_foreach_line(struct parser*, const char*, size_t, parsechunkfn);
296 
297 /* sandbox.c */
298 void		 sandbox_network_process(void);
299 void		 sandbox_ui_process(void);
300 void		 sandbox_fs_process(void);
301 
302 /* telescope.c */
303 void		 load_about_url(struct tab*, const char*);
304 void		 load_gemini_url(struct tab*, const char*);
305 void		 load_url(struct tab*, const char*);
306 int		 load_previous_page(struct tab*);
307 int		 load_next_page(struct tab*);
308 void		 stop_tab(struct tab*);
309 void		 add_to_bookmarks(const char*);
310 void		 save_session(void);
311 
312 /* textplain.c */
313 void		 textplain_initparser(struct parser*);
314 
315 /* tofu.c */
316 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
317 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
318 void			 tofu_add(struct ohash*, struct tofu_entry*);
319 void			 tofu_update(struct ohash*, struct tofu_entry*);
320 
321 /* ui.c */
322 extern int	 body_lines;
323 extern int	 body_cols;
324 extern int	 in_minibuffer;
325 
326 struct thiskey {
327 	short meta;
328 	int key;
329 	uint32_t cp;
330 };
331 extern struct thiskey thiskey;
332 
333 extern struct histhead eecmd_history,
334 	ir_history,
335 	lu_history,
336 	read_history;
337 
338 struct ministate {
339 	char		*curmesg;
340 
341 	char		 prompt[64];
342 	void		 (*donefn)(void);
343 	void		 (*abortfn)(void);
344 
345 	char		 buf[1025];
346 	struct line	 line;
347 	struct vline	 vline;
348 	struct buffer	 buffer;
349 
350 	struct histhead	*history;
351 	struct hist	*hist_cur;
352 	size_t		 hist_off;
353 };
354 extern struct ministate ministate;
355 
356 void		 restore_cursor(struct buffer *);
357 void		 minibuffer_taint_hist(void);
358 void		 eecmd_self_insert(void);
359 void		 eecmd_select(void);
360 void		 ir_self_insert(void);
361 void		 ir_select(void);
362 void		 lu_self_insert(void);
363 void		 lu_select(void);
364 void		 bp_select(void);
365 void		 vmessage(const char*, va_list);
366 void		 message(const char*, ...) __attribute__((format(printf, 1, 2)));
367 void		 start_loading_anim(struct tab *tab);
368 void		 load_url_in_tab(struct tab *, const char *);
369 void		 enter_minibuffer(void(*)(void), void(*)(void), void(*)(void), struct histhead *);
370 void		 exit_minibuffer(void);
371 void		 switch_to_tab(struct tab *);
372 struct tab	*current_tab(void);
373 struct tab	*new_tab(const char *);
374 unsigned int	 tab_new_id(void);
375 int		 ui_init(int, char * const*);
376 void		 ui_on_tab_loaded(struct tab*);
377 void		 ui_on_tab_refresh(struct tab*);
378 const char	*ui_keyname(int);
379 void		 ui_toggle_side_window(void);
380 void		 ui_schedule_redraw(void);
381 void		 ui_require_input(struct tab*, int);
382 void		 ui_read(const char*, void(*)(const char*, unsigned int), unsigned int);
383 void		 ui_yornp(const char*, void (*)(int, unsigned int), unsigned int);
384 void		 ui_end(void);
385 
386 /* utf.8 */
387 uint32_t	 utf8_decode(uint32_t*restrict, uint32_t*restrict, uint8_t);
388 size_t		 utf8_encode(uint32_t, char*);
389 char		*utf8_nth(char*, size_t);
390 size_t		 utf8_cplen(char*);
391 size_t		 utf8_chwidth(uint32_t);
392 size_t		 utf8_snwidth(const char*, size_t);
393 size_t		 utf8_swidth(const char*);
394 size_t		 utf8_swidth_between(const char*, const char*);
395 char		*utf8_next_cp(const char*);
396 char		*utf8_prev_cp(const char*, const char*);
397 
398 /* util.c */
399 int		 mark_nonblock(int);
400 int		 has_prefix(const char*, const char*);
401 int		 unicode_isspace(uint32_t);
402 int		 unicode_isgraph(uint32_t);
403 void		 dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
404 
405 /* wrap.c */
406 void		 empty_linelist(struct buffer*);
407 void		 empty_vlist(struct buffer*);
408 int		 wrap_text(struct buffer*, const char*, struct line*, size_t);
409 int		 hardwrap_text(struct buffer*, struct line*, size_t);
410 
411 #endif /* TELESCOPE_H */