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