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 <limits.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 #define SIDE_WINDOW_LEFT	0x1
32 #define SIDE_WINDOW_BOTTOM	0x2
33 
34 struct imsgev {
35 	struct imsgbuf	 ibuf;
36 	void		(*handler)(int, short, void *);
37 	struct event	 ev;
38 	short		 events;
39 };
40 
41 enum imsg_type {
42 	/* ui <-> client/fs */
43 	IMSG_GET,		/* data is URL, peerid the tab id */
44 	IMSG_GET_FILE,		/* data is path, without \r\n or such */
45 	IMSG_GET_RAW,		/* get but with an explicit req str */
46 	IMSG_ERR,
47 	IMSG_CHECK_CERT,
48 	IMSG_CERT_STATUS,
49 	IMSG_GOT_CODE,
50 	IMSG_GOT_META,
51 	IMSG_PROCEED,
52 	IMSG_STOP,
53 	IMSG_BUF,
54 	IMSG_EOF,
55 	IMSG_QUIT,
56 
57 	/* ui <-> fs */
58 	IMSG_BOOKMARK_PAGE,
59 	IMSG_BOOKMARK_OK,
60 	IMSG_SAVE_CERT,
61 	IMSG_SAVE_CERT_OK,
62 	IMSG_UPDATE_CERT,
63 	IMSG_UPDATE_CERT_OK,
64 
65 	IMSG_FILE_OPEN,
66 	IMSG_FILE_OPENED,
67 
68 	IMSG_SESSION_START,
69 	IMSG_SESSION_TAB,
70 	IMSG_SESSION_TAB_TITLE,
71 	IMSG_SESSION_END,
72 };
73 
74 enum line_type {
75 	/* text/gemini */
76 	LINE_TEXT,
77 	LINE_LINK,
78 	LINE_TITLE_1,
79 	LINE_TITLE_2,
80 	LINE_TITLE_3,
81 	LINE_ITEM,
82 	LINE_QUOTE,
83 	LINE_PRE_START,
84 	LINE_PRE_CONTENT,
85 	LINE_PRE_END,
86 
87 	/* text/x-patch */
88 	LINE_PATCH,
89 	LINE_PATCH_HDR,
90 	LINE_PATCH_HUNK_HDR,
91 	LINE_PATCH_ADD,
92 	LINE_PATCH_DEL,
93 
94 	/* minibuffer */
95 	LINE_COMPL,
96 	LINE_COMPL_CURRENT,
97 
98 	/* help */
99 	LINE_HELP,
100 };
101 
102 /* for lines: mark as hidden */
103 #define L_HIDDEN	1
104 
105 /* for vlines: mark as continuation */
106 #define L_CONTINUATION	2
107 
108 struct line {
109 	enum line_type		 type;
110 	char			*line;
111 	char			*alt;
112 	void			*data;
113 	int			 flags;
114 	TAILQ_ENTRY(line)	 lines;
115 };
116 
117 struct vline {
118 	struct line		*parent;
119 	char			*line;
120 	int			 flags;
121 	TAILQ_ENTRY(vline)	 vlines;
122 };
123 
124 struct parser;
125 struct page;
126 
127 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
128 typedef int	(*parserfreefn)(struct parser*);
129 
130 typedef void (imsg_handlerfn)(struct imsg*, size_t);
131 
132 struct parser {
133 	const char	*name;
134 	char		 title[128+1];
135 	char		*buf;
136 	size_t		 len;
137 	size_t		 cap;
138 
139 #define PARSER_IN_BODY	1
140 #define PARSER_IN_PRE	2
141 #define PARSER_IN_PATCH_HDR 4
142 	int		 flags;
143 	parsechunkfn	 parse;
144 	parserfreefn	 free;
145 
146 	TAILQ_HEAD(, line)	 head;
147 };
148 
149 /*
150  * differnt types of trust for a certificate.  Following
151  * gemini://thfr.info/gemini/modified-trust-verify.gmi
152  */
153 enum trust_state {
154 	TS_UNKNOWN,
155 	TS_UNTRUSTED,
156 	TS_TEMP_TRUSTED,
157 	TS_TRUSTED,
158 	TS_VERIFIED,
159 };
160 
161 struct tofu_entry {
162 	char	domain[GEMINI_URL_LEN];
163 
164 	/*
165 	 * enough space for ``PROTO:HASH''.  probably isn't a good
166 	 * idea tho.
167 	 */
168 	char	hash[128+1];
169 	int	verified;
170 };
171 
172 struct histhead {
173 	TAILQ_HEAD(mhisthead, hist)	head;
174 	size_t				len;
175 };
176 struct hist {
177 	char			h[1025];
178 	TAILQ_ENTRY(hist)	entries;
179 };
180 
181 struct buffer {
182 	struct parser		 page;
183 
184 	size_t			 last_line_off;
185 	int			 force_redraw;
186 
187 	int			 curs_x;
188 	int			 curs_y;
189 	size_t			 line_off;
190 	size_t			 line_max;
191 	struct vline		*top_line;
192 	struct vline		*current_line;
193 	size_t			 cpoff;
194 	TAILQ_HEAD(vhead, vline) head;
195 };
196 
197 #define TAB_CURRENT	0x1	/* only for save_session */
198 #define TAB_URGENT	0x2
199 #define TAB_LAZY	0x4	/* to lazy load tabs */
200 
201 #define NEW_TAB_URL	"about:new"
202 
203 extern TAILQ_HEAD(tabshead, tab) tabshead;
204 struct tab {
205 	TAILQ_ENTRY(tab)	 tabs;
206 	uint32_t		 id;
207 	uint32_t		 flags;
208 
209 	char			*cert;
210 	enum trust_state	 trust;
211 	struct proxy		*proxy;
212 	struct phos_uri		 uri;
213 	struct histhead		 hist;
214 	struct hist		*hist_cur;
215 	size_t			 hist_off;
216 
217 	int			 code;
218 	char			 meta[GEMINI_URL_LEN];
219 	int			 redirect_count;
220 
221 	struct buffer		 buffer;
222 
223 	short			 loading_anim;
224 	short			 loading_anim_step;
225 	struct event		 loadingev;
226 
227 	int			 fd;
228 	size_t			 bytes;
229 	char			*path;
230 };
231 
232 extern TAILQ_HEAD(proxylist, proxy) proxies;
233 struct proxy {
234 	char	*match_proto;
235 
236 	char	*host;
237 	char	*port;
238 	int	 proto;
239 
240 	TAILQ_ENTRY(proxy) proxies;
241 };
242 
243 enum {
244 	PROTO_FINGER,
245 	PROTO_GEMINI,
246 	PROTO_GOPHER,
247 	/* ... */
248 };
249 
250 struct get_req {
251 	int		proto;
252 	char		host[254];
253 	char		port[16];
254 	char		req[1027];
255 };
256 
257 struct kmap {
258 	TAILQ_HEAD(map, keymap)	m;
259 	void			(*unhandled_input)(void);
260 };
261 extern struct kmap global_map, minibuffer_map;
262 
263 typedef void(interactivefn)(struct buffer *);
264 
265 struct keymap {
266 	int			 meta;
267 	int			 key;
268 	struct kmap		 map;
269 	interactivefn		 *fn;
270 
271 	TAILQ_ENTRY(keymap)	 keymaps;
272 };
273 
274 struct cmd {
275 	const char	*cmd;
276 	void		(*fn)(struct buffer *);
277 	const char	*descr;
278 };
279 extern struct cmd cmds[];
280 
281 /* defaults.c */
282 void		 config_init(void);
283 int		 config_setprfx(const char *, const char *, const char *);
284 int		 config_setvari(const char *, int);
285 int		 config_setvars(const char *, char *);
286 int		 config_setcolor(int, const char *, int, int, int);
287 int		 config_setattr(const char *, int, int, int);
288 void		 config_apply_style(void);
289 
290 /* downloads.c */
291 extern STAILQ_HEAD(downloads, download) downloads;
292 struct download {
293 	int			 fd;
294 	size_t			 bytes;
295 	char			*path;
296 	STAILQ_ENTRY(download)	 entries;
297 };
298 
299 void		 recompute_downloads(void);
300 
301 /* help.c */
302 void		 recompute_help(void);
303 
304 /* hist.c */
305 void		 hist_clear_forward(struct histhead*, struct hist*);
306 void		 hist_push(struct histhead*, struct hist*);
307 
308 /* keymap.c */
309 int		 kbd(const char*);
310 const char	*unkbd(int);
311 int		 kmap_define_key(struct kmap*, const char*, void(*)(struct buffer*));
312 
313 /* mime.c */
314 int		 setup_parser_for(struct tab*);
315 
316 /* net.c */
317 int		 net_main(void);
318 
319 /* parse.y */
320 void		 parseconfig(const char *, int);
321 
322 /* sandbox.c */
323 void		 sandbox_net_process(void);
324 void		 sandbox_ui_process(void);
325 void		 sandbox_fs_process(void);
326 
327 /* telescope.c */
328 extern int operating;
329 extern int safe_mode;
330 
331 void		 gopher_send_search_req(struct tab *, const char *);
332 void		 load_url(struct tab *, const char *, const char *, int);
333 void		 load_url_in_tab(struct tab *, const char *, const char *, int);
334 int		 load_previous_page(struct tab*);
335 int		 load_next_page(struct tab*);
336 void		 add_to_bookmarks(const char*);
337 void		 humanify_url(const char *, char *, size_t);
338 int		 ui_send_net(int, uint32_t, const void *, uint16_t);
339 int		 ui_send_fs(int, uint32_t, const void *, uint16_t);
340 
341 /* tofu.c */
342 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
343 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
344 void			 tofu_add(struct ohash*, struct tofu_entry*);
345 void			 tofu_update(struct ohash*, struct tofu_entry*);
346 void			 tofu_temp_trust(struct ohash *, const char *, const char *, const char *);
347 
348 /* util.c */
349 int		 mark_nonblock(int);
350 int		 has_prefix(const char*, const char*);
351 int		 has_suffix(const char *, const char *);
352 int		 unicode_isspace(uint32_t);
353 int		 unicode_isgraph(uint32_t);
354 int		 dispatch_imsg(struct imsgev *, short, imsg_handlerfn **, size_t);
355 int		 imsg_compose_event(struct imsgev *, uint16_t, uint32_t, pid_t, int, const void *, uint16_t);
356 
357 /* wrap.c */
358 void		 erase_buffer(struct buffer *);
359 void		 empty_linelist(struct buffer*);
360 void		 empty_vlist(struct buffer*);
361 int		 wrap_one(struct buffer *, const char *, struct line *, size_t);
362 int		 wrap_text(struct buffer*, const char*, struct line*, size_t);
363 int		 hardwrap_text(struct buffer*, struct line*, size_t);
364 int		 wrap_page(struct buffer *, int width);
365 
366 #endif /* TELESCOPE_H */