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 "compat.h"
21 
22 #include <limits.h>
23 
24 #include "cmd.h"
25 #include "phos.h"
26 
27 #define MIN(a, b) ((a) < (b) ? (a) : (b))
28 #define MAX(a, b) ((a) > (b) ? (a) : (b))
29 
30 #define GEMINI_URL_LEN 1024
31 #define TITLE_MAX 128+1		/* account for NUL too */
32 
33 #define SIDE_WINDOW_LEFT	0x1
34 #define SIDE_WINDOW_BOTTOM	0x2
35 
36 struct imsgev {
37 	struct imsgbuf	 ibuf;
38 	void		(*handler)(int, short, void *);
39 	struct event	 ev;
40 	short		 events;
41 };
42 
43 #define IMSG_DATA_SIZE(imsg)	((imsg).hdr.len - IMSG_HEADER_SIZE)
44 
45 enum imsg_type {
46 	/* ui <-> client/fs */
47 	IMSG_GET,		/* data is URL, peerid the tab id */
48 	IMSG_GET_FILE,		/* data is path, without \r\n or such */
49 	IMSG_GET_RAW,		/* get but with an explicit req str */
50 	IMSG_ERR,
51 	IMSG_CHECK_CERT,
52 	IMSG_CERT_STATUS,
53 	IMSG_GOT_CODE,
54 	IMSG_GOT_META,
55 	IMSG_PROCEED,
56 	IMSG_STOP,
57 	IMSG_BUF,
58 	IMSG_EOF,
59 	IMSG_QUIT,
60 
61 	/* ui <-> fs */
62 	IMSG_INIT,
63 	IMSG_TOFU,
64 	IMSG_BOOKMARK_PAGE,
65 	IMSG_BOOKMARK_OK,
66 	IMSG_SAVE_CERT,
67 	IMSG_SAVE_CERT_OK,
68 	IMSG_UPDATE_CERT,
69 	IMSG_UPDATE_CERT_OK,
70 
71 	IMSG_FILE_OPEN,
72 	IMSG_FILE_OPENED,
73 
74 	IMSG_SESSION_START,
75 	IMSG_SESSION_TAB,
76 	IMSG_SESSION_TAB_HIST,
77 	IMSG_SESSION_END,
78 
79 	IMSG_HIST_ITEM,		/* struct histitem */
80 	IMSG_HIST_END,		/* empty */
81 
82 	IMSG_CTL_OPEN_URL,
83 };
84 
85 enum line_type {
86 	/* text/gemini */
87 	LINE_TEXT,
88 	LINE_LINK,
89 	LINE_TITLE_1,
90 	LINE_TITLE_2,
91 	LINE_TITLE_3,
92 	LINE_ITEM,
93 	LINE_QUOTE,
94 	LINE_PRE_START,
95 	LINE_PRE_CONTENT,
96 	LINE_PRE_END,
97 
98 	/* text/x-patch */
99 	LINE_PATCH,
100 	LINE_PATCH_HDR,
101 	LINE_PATCH_HUNK_HDR,
102 	LINE_PATCH_ADD,
103 	LINE_PATCH_DEL,
104 
105 	/* minibuffer */
106 	LINE_COMPL,
107 	LINE_COMPL_CURRENT,
108 
109 	/* help */
110 	LINE_HELP,
111 
112 	/* download */
113 	LINE_DOWNLOAD,
114 	LINE_DOWNLOAD_DONE,
115 	LINE_DOWNLOAD_INFO,
116 
117 	/* misc ui */
118 	LINE_FRINGE,
119 };
120 
121 /* for lines: mark as hidden */
122 #define L_HIDDEN	1
123 
124 /* for vlines: mark as continuation */
125 #define L_CONTINUATION	2
126 
127 struct line {
128 	enum line_type		 type;
129 	char			*line;
130 	char			*alt;
131 	void			*data;
132 	int			 flags;
133 	TAILQ_ENTRY(line)	 lines;
134 };
135 
136 struct vline {
137 	struct line		*parent;
138 	char			*line;
139 	int			 flags;
140 	TAILQ_ENTRY(vline)	 vlines;
141 };
142 
143 struct parser;
144 
145 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
146 typedef int	(*parserfreefn)(struct parser*);
147 typedef int	(*parserserial)(struct parser*, struct evbuffer *);
148 
149 typedef void (imsg_handlerfn)(struct imsg*, size_t);
150 
151 struct parser {
152 	const char	*name;
153 	char		 title[128+1];
154 	char		*buf;
155 	size_t		 len;
156 	size_t		 cap;
157 
158 #define PARSER_IN_BODY	1
159 #define PARSER_IN_PRE	2
160 #define PARSER_IN_PATCH_HDR 4
161 	int		 flags;
162 	void		(*init)(struct parser *);
163 	parsechunkfn	 parse;
164 	parserfreefn	 free;
165 	parserserial	 serialize;
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 	size_t			line_off;
200 	size_t			current_off;
201 	TAILQ_ENTRY(hist)	entries;
202 };
203 
204 struct buffer {
205 	struct parser		 page;
206 
207 	size_t			 last_line_off;
208 	int			 force_redraw;
209 
210 	int			 curs_x;
211 	int			 curs_y;
212 	size_t			 line_off;
213 	size_t			 line_max;
214 	struct vline		*top_line;
215 	struct vline		*current_line;
216 	size_t			 cpoff;
217 	TAILQ_HEAD(vhead, vline) head;
218 };
219 
220 #define TAB_CURRENT	0x1	/* only for save_session */
221 #define TAB_KILLED	0x2	/* only for save_session */
222 #define TAB_URGENT	0x4
223 #define TAB_LAZY	0x8	/* to lazy load tabs */
224 
225 #define NEW_TAB_URL	"about:new"
226 
227 TAILQ_HEAD(tabshead, tab);
228 extern struct tabshead tabshead;
229 extern struct tabshead ktabshead;
230 struct tab {
231 	TAILQ_ENTRY(tab)	 tabs;
232 	uint32_t		 id;
233 	uint32_t		 flags;
234 
235 	char			*cert;
236 	enum trust_state	 trust;
237 	struct proxy		*proxy;
238 	struct phos_uri		 uri;
239 	struct histhead		 hist;
240 	struct hist		*hist_cur;
241 	size_t			 hist_off;
242 	char			*last_input_url;
243 
244 	int			 code;
245 	char			 meta[GEMINI_URL_LEN];
246 	int			 redirect_count;
247 
248 	struct buffer		 buffer;
249 
250 	short			 loading_anim;
251 	short			 loading_anim_step;
252 	struct event		 loadingev;
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_FINGER,
268 	PROTO_GEMINI,
269 	PROTO_GOPHER,
270 	/* ... */
271 };
272 
273 struct get_req {
274 	int		proto;
275 	char		host[254];
276 	char		port[16];
277 	char		req[1027];
278 };
279 
280 struct cmd {
281 	const char	*cmd;
282 	void		(*fn)(struct buffer *);
283 	const char	*descr;
284 };
285 extern struct cmd cmds[];
286 
287 /* defaults.c */
288 void		 config_init(void);
289 int		 config_setprfx(const char *, const char *, const char *);
290 int		 config_setvari(const char *, int);
291 int		 config_setvars(const char *, char *);
292 int		 config_setcolor(int, const char *, int, int, int);
293 int		 config_setattr(const char *, int, int, int);
294 void		 config_apply_style(void);
295 
296 /* downloads.c */
297 extern STAILQ_HEAD(downloads, download) downloads;
298 struct download {
299 	uint32_t		 id;
300 	int			 fd;
301 	size_t			 bytes;
302 	char			*path;
303 	STAILQ_ENTRY(download)	 entries;
304 };
305 
306 void		 recompute_downloads(void);
307 void		 enqueue_download(uint32_t, const char *);
308 struct download	*download_by_id(uint32_t);
309 
310 /* help.c */
311 void		 recompute_help(void);
312 
313 /* hist.c */
314 void		 hist_clear(struct histhead *);
315 void		 hist_clear_forward(struct histhead*, struct hist*);
316 void		 hist_push(struct histhead*, struct hist*);
317 void		 hist_add_before(struct histhead *, struct hist *, struct hist *);
318 struct hist	*hist_pop(struct histhead *);
319 
320 /* mime.c */
321 int		 setup_parser_for(struct tab*);
322 
323 /* net.c */
324 int		 net_main(void);
325 
326 /* parse.y */
327 void		 parseconfig(const char *, int);
328 
329 /* sandbox.c */
330 void		 sandbox_net_process(void);
331 void		 sandbox_ui_process(void);
332 void		 sandbox_fs_process(void);
333 
334 /* telescope.c */
335 extern int operating;
336 extern int safe_mode;
337 
338 #define LU_MODE_NONE	0x0
339 #define LU_MODE_NOHIST	0x1
340 #define LU_MODE_NOCACHE	0x2
341 
342 void		 gopher_send_search_req(struct tab *, const char *);
343 int		 load_page_from_str(struct tab *, const char *);
344 void		 load_url(struct tab *, const char *, const char *, int);
345 void		 load_url_in_tab(struct tab *, const char *, const char *, int);
346 int		 load_previous_page(struct tab*);
347 int		 load_next_page(struct tab*);
348 void		 add_to_bookmarks(const char*);
349 void		 humanify_url(const char *, char *, size_t);
350 int		 ui_send_net(int, uint32_t, const void *, uint16_t);
351 int		 ui_send_fs(int, uint32_t, const void *, uint16_t);
352 
353 /* tofu.c */
354 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
355 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
356 void			 tofu_add(struct ohash*, struct tofu_entry*);
357 void			 tofu_update(struct ohash*, struct tofu_entry*);
358 void			 tofu_temp_trust(struct ohash *, const char *, const char *, const char *);
359 
360 /* wrap.c */
361 void		 erase_buffer(struct buffer *);
362 void		 empty_linelist(struct buffer*);
363 void		 empty_vlist(struct buffer*);
364 int		 wrap_one(struct buffer *, const char *, struct line *, size_t);
365 int		 wrap_text(struct buffer*, const char*, struct line*, size_t);
366 int		 hardwrap_text(struct buffer*, struct line*, size_t);
367 int		 wrap_page(struct buffer *, int width);
368 
369 #endif /* TELESCOPE_H */