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