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_CTL_OPEN_URL,
80 };
81 
82 enum line_type {
83 	/* text/gemini */
84 	LINE_TEXT,
85 	LINE_LINK,
86 	LINE_TITLE_1,
87 	LINE_TITLE_2,
88 	LINE_TITLE_3,
89 	LINE_ITEM,
90 	LINE_QUOTE,
91 	LINE_PRE_START,
92 	LINE_PRE_CONTENT,
93 	LINE_PRE_END,
94 
95 	/* text/x-patch */
96 	LINE_PATCH,
97 	LINE_PATCH_HDR,
98 	LINE_PATCH_HUNK_HDR,
99 	LINE_PATCH_ADD,
100 	LINE_PATCH_DEL,
101 
102 	/* minibuffer */
103 	LINE_COMPL,
104 	LINE_COMPL_CURRENT,
105 
106 	/* help */
107 	LINE_HELP,
108 
109 	/* download */
110 	LINE_DOWNLOAD,
111 	LINE_DOWNLOAD_DONE,
112 	LINE_DOWNLOAD_INFO,
113 
114 	/* misc ui */
115 	LINE_FRINGE,
116 };
117 
118 /* for lines: mark as hidden */
119 #define L_HIDDEN	1
120 
121 /* for vlines: mark as continuation */
122 #define L_CONTINUATION	2
123 
124 struct line {
125 	enum line_type		 type;
126 	char			*line;
127 	char			*alt;
128 	void			*data;
129 	int			 flags;
130 	TAILQ_ENTRY(line)	 lines;
131 };
132 
133 struct vline {
134 	struct line		*parent;
135 	char			*line;
136 	int			 flags;
137 	TAILQ_ENTRY(vline)	 vlines;
138 };
139 
140 struct parser;
141 
142 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
143 typedef int	(*parserfreefn)(struct parser*);
144 typedef int	(*parserserial)(struct parser*, struct evbuffer *);
145 
146 typedef void (imsg_handlerfn)(struct imsg*, size_t);
147 
148 struct parser {
149 	const char	*name;
150 	char		 title[128+1];
151 	char		*buf;
152 	size_t		 len;
153 	size_t		 cap;
154 
155 #define PARSER_IN_BODY	1
156 #define PARSER_IN_PRE	2
157 #define PARSER_IN_PATCH_HDR 4
158 	int		 flags;
159 	void		(*init)(struct parser *);
160 	parsechunkfn	 parse;
161 	parserfreefn	 free;
162 	parserserial	 serialize;
163 
164 	TAILQ_HEAD(, line)	 head;
165 };
166 
167 /*
168  * differnt types of trust for a certificate.  Following
169  * gemini://thfr.info/gemini/modified-trust-verify.gmi
170  */
171 enum trust_state {
172 	TS_UNKNOWN,
173 	TS_UNTRUSTED,
174 	TS_TEMP_TRUSTED,
175 	TS_TRUSTED,
176 	TS_VERIFIED,
177 };
178 
179 struct tofu_entry {
180 	char	domain[GEMINI_URL_LEN];
181 
182 	/*
183 	 * enough space for ``PROTO:HASH''.  probably isn't a good
184 	 * idea tho.
185 	 */
186 	char	hash[128+1];
187 	int	verified;
188 };
189 
190 struct histhead {
191 	TAILQ_HEAD(mhisthead, hist)	head;
192 	size_t				len;
193 };
194 struct hist {
195 	char			h[1025];
196 	size_t			line_off;
197 	size_t			current_off;
198 	TAILQ_ENTRY(hist)	entries;
199 };
200 
201 struct buffer {
202 	struct parser		 page;
203 
204 	size_t			 last_line_off;
205 	int			 force_redraw;
206 
207 	int			 curs_x;
208 	int			 curs_y;
209 	size_t			 line_off;
210 	size_t			 line_max;
211 	struct vline		*top_line;
212 	struct vline		*current_line;
213 	size_t			 cpoff;
214 	TAILQ_HEAD(vhead, vline) head;
215 };
216 
217 #define TAB_CURRENT	0x1	/* only for save_session */
218 #define TAB_KILLED	0x2	/* only for save_session */
219 #define TAB_URGENT	0x4
220 #define TAB_LAZY	0x8	/* to lazy load tabs */
221 
222 #define NEW_TAB_URL	"about:new"
223 
224 TAILQ_HEAD(tabshead, tab);
225 extern struct tabshead tabshead;
226 extern struct tabshead ktabshead;
227 struct tab {
228 	TAILQ_ENTRY(tab)	 tabs;
229 	uint32_t		 id;
230 	uint32_t		 flags;
231 
232 	char			*cert;
233 	enum trust_state	 trust;
234 	struct proxy		*proxy;
235 	struct phos_uri		 uri;
236 	struct histhead		 hist;
237 	struct hist		*hist_cur;
238 	size_t			 hist_off;
239 	char			*last_input_url;
240 
241 	int			 code;
242 	char			 meta[GEMINI_URL_LEN];
243 	int			 redirect_count;
244 
245 	struct buffer		 buffer;
246 
247 	short			 loading_anim;
248 	short			 loading_anim_step;
249 	struct event		 loadingev;
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_FINGER,
265 	PROTO_GEMINI,
266 	PROTO_GOPHER,
267 	/* ... */
268 };
269 
270 struct get_req {
271 	int		proto;
272 	char		host[254];
273 	char		port[16];
274 	char		req[1027];
275 };
276 
277 struct cmd {
278 	const char	*cmd;
279 	void		(*fn)(struct buffer *);
280 	const char	*descr;
281 };
282 extern struct cmd cmds[];
283 
284 /* defaults.c */
285 void		 config_init(void);
286 int		 config_setprfx(const char *, const char *, const char *);
287 int		 config_setvari(const char *, int);
288 int		 config_setvars(const char *, char *);
289 int		 config_setcolor(int, const char *, int, int, int);
290 int		 config_setattr(const char *, int, int, int);
291 void		 config_apply_style(void);
292 
293 /* downloads.c */
294 extern STAILQ_HEAD(downloads, download) downloads;
295 struct download {
296 	uint32_t		 id;
297 	int			 fd;
298 	size_t			 bytes;
299 	char			*path;
300 	STAILQ_ENTRY(download)	 entries;
301 };
302 
303 void		 recompute_downloads(void);
304 void		 enqueue_download(uint32_t, const char *);
305 struct download	*download_by_id(uint32_t);
306 
307 /* help.c */
308 void		 recompute_help(void);
309 
310 /* hist.c */
311 void		 hist_clear(struct histhead *);
312 void		 hist_clear_forward(struct histhead*, struct hist*);
313 void		 hist_push(struct histhead*, struct hist*);
314 void		 hist_add_before(struct histhead *, struct hist *, struct hist *);
315 struct hist	*hist_pop(struct histhead *);
316 
317 /* mime.c */
318 int		 setup_parser_for(struct tab*);
319 
320 /* net.c */
321 int		 net_main(void);
322 
323 /* parse.y */
324 void		 parseconfig(const char *, int);
325 
326 /* sandbox.c */
327 void		 sandbox_net_process(void);
328 void		 sandbox_ui_process(void);
329 void		 sandbox_fs_process(void);
330 
331 /* telescope.c */
332 extern int operating;
333 extern int safe_mode;
334 
335 #define LU_MODE_NONE	0x0
336 #define LU_MODE_NOHIST	0x1
337 #define LU_MODE_NOCACHE	0x2
338 
339 void		 gopher_send_search_req(struct tab *, const char *);
340 int		 load_page_from_str(struct tab *, const char *);
341 void		 load_url(struct tab *, const char *, const char *, int);
342 void		 load_url_in_tab(struct tab *, const char *, const char *, int);
343 int		 load_previous_page(struct tab*);
344 int		 load_next_page(struct tab*);
345 void		 add_to_bookmarks(const char*);
346 void		 humanify_url(const char *, char *, size_t);
347 int		 ui_send_net(int, uint32_t, const void *, uint16_t);
348 int		 ui_send_fs(int, uint32_t, const void *, uint16_t);
349 
350 /* tofu.c */
351 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
352 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
353 void			 tofu_add(struct ohash*, struct tofu_entry*);
354 void			 tofu_update(struct ohash*, struct tofu_entry*);
355 void			 tofu_temp_trust(struct ohash *, const char *, const char *, const char *);
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 */