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