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 	char			*line;
118 	int			 flags;
119 	TAILQ_ENTRY(vline)	 vlines;
120 };
121 
122 struct parser;
123 
124 typedef int	(*printfn)(void *, const char *, ...);
125 
126 typedef void	(*parserinit)(struct parser *);
127 
128 typedef int	(*parsechunkfn)(struct parser *, const char *, size_t);
129 typedef int	(*parserfreefn)(struct parser *);
130 typedef int	(*parserserial)(struct parser *, FILE *);
131 
132 typedef void (imsg_handlerfn)(struct imsg*, size_t);
133 
134 struct parser {
135 	const char	*name;
136 	char		 title[128+1];
137 	char		*buf;
138 	size_t		 len;
139 	size_t		 cap;
140 
141 #define PARSER_IN_BODY	1
142 #define PARSER_IN_PRE	2
143 #define PARSER_IN_PATCH_HDR 4
144 	int		 flags;
145 	parserinit	 init;
146 	parsechunkfn	 parse;
147 	parserfreefn	 free;
148 	parserserial	 serialize;
149 
150 	TAILQ_HEAD(, line)	 head;
151 };
152 
153 /*
154  * differnt types of trust for a certificate.  Following
155  * gemini://thfr.info/gemini/modified-trust-verify.gmi
156  */
157 enum trust_state {
158 	TS_UNKNOWN,
159 	TS_UNTRUSTED,
160 	TS_TEMP_TRUSTED,
161 	TS_TRUSTED,
162 	TS_VERIFIED,
163 };
164 
165 struct tofu_entry {
166 	char	domain[GEMINI_URL_LEN];
167 
168 	/*
169 	 * enough space for ``PROTO:HASH''.  probably isn't a good
170 	 * idea tho.
171 	 */
172 	char	hash[128+1];
173 	int	verified;
174 };
175 
176 struct histhead {
177 	TAILQ_HEAD(mhisthead, hist)	head;
178 	size_t				len;
179 };
180 struct hist {
181 	char			h[1025];
182 	size_t			line_off;
183 	size_t			current_off;
184 	TAILQ_ENTRY(hist)	entries;
185 };
186 
187 struct buffer {
188 	struct parser		 page;
189 
190 	size_t			 last_line_off;
191 	int			 force_redraw;
192 
193 	int			 curs_x;
194 	int			 curs_y;
195 	size_t			 line_off;
196 	size_t			 line_max;
197 	struct vline		*top_line;
198 	struct vline		*current_line;
199 	size_t			 cpoff;
200 	TAILQ_HEAD(vhead, vline) head;
201 };
202 
203 #define TAB_CURRENT	0x1	/* only for save_session */
204 #define TAB_KILLED	0x2	/* only for save_session */
205 #define TAB_URGENT	0x4
206 #define TAB_LAZY	0x8	/* to lazy load tabs */
207 
208 #define NEW_TAB_URL	"about:new"
209 
210 TAILQ_HEAD(tabshead, tab);
211 extern struct tabshead tabshead;
212 extern struct tabshead ktabshead;
213 struct tab {
214 	TAILQ_ENTRY(tab)	 tabs;
215 	uint32_t		 id;
216 	uint32_t		 flags;
217 
218 	char			*cert;
219 	enum trust_state	 trust;
220 	struct proxy		*proxy;
221 	struct phos_uri		 uri;
222 	struct histhead		 hist;
223 	struct hist		*hist_cur;
224 	size_t			 hist_off;
225 	char			*last_input_url;
226 
227 	int			 code;
228 	char			 meta[GEMINI_URL_LEN];
229 	int			 redirect_count;
230 
231 	struct buffer		 buffer;
232 
233 	short			 loading_anim;
234 	short			 loading_anim_step;
235 	struct event		 loadingev;
236 };
237 
238 extern TAILQ_HEAD(proxylist, proxy) proxies;
239 struct proxy {
240 	char	*match_proto;
241 
242 	char	*host;
243 	char	*port;
244 	int	 proto;
245 
246 	TAILQ_ENTRY(proxy) proxies;
247 };
248 
249 enum {
250 	PROTO_FINGER,
251 	PROTO_GEMINI,
252 	PROTO_GOPHER,
253 	/* ... */
254 };
255 
256 struct get_req {
257 	int		proto;
258 	char		host[254];
259 	char		port[16];
260 	char		req[1027];
261 };
262 
263 struct cmd {
264 	const char	*cmd;
265 	void		(*fn)(struct buffer *);
266 	const char	*descr;
267 };
268 extern struct cmd cmds[];
269 
270 /* defaults.c */
271 void		 config_init(void);
272 int		 config_setprfx(const char *, const char *, const char *);
273 int		 config_setvari(const char *, int);
274 int		 config_setvars(const char *, char *);
275 int		 config_setcolor(int, const char *, int, int, int);
276 int		 config_setattr(const char *, int, int, int);
277 void		 config_apply_style(void);
278 
279 /* downloads.c */
280 extern STAILQ_HEAD(downloads, download) downloads;
281 struct download {
282 	uint32_t		 id;
283 	int			 fd;
284 	size_t			 bytes;
285 	char			*path;
286 	STAILQ_ENTRY(download)	 entries;
287 };
288 
289 void		 recompute_downloads(void);
290 struct download	*enqueue_download(uint32_t, const char *);
291 struct download	*download_by_id(uint32_t);
292 
293 /* help.c */
294 void		 recompute_help(void);
295 
296 /* hist.c */
297 void		 hist_clear(struct histhead *);
298 void		 hist_clear_forward(struct histhead*, struct hist*);
299 void		 hist_push(struct histhead*, struct hist*);
300 void		 hist_add_before(struct histhead *, struct hist *, struct hist *);
301 struct hist	*hist_pop(struct histhead *);
302 
303 /* mime.c */
304 int		 setup_parser_for(struct tab*);
305 
306 /* net.c */
307 int		 net_main(void);
308 
309 /* parse.y */
310 void		 parseconfig(const char *, int);
311 
312 /* sandbox.c */
313 void		 sandbox_net_process(void);
314 void		 sandbox_ui_process(void);
315 
316 /* telescope.c */
317 extern int operating;
318 extern int safe_mode;
319 
320 #define LU_MODE_NONE	0x0
321 #define LU_MODE_NOHIST	0x1
322 #define LU_MODE_NOCACHE	0x2
323 
324 void		 gopher_send_search_req(struct tab *, const char *);
325 int		 load_page_from_str(struct tab *, const char *);
326 void		 load_url(struct tab *, const char *, const char *, int);
327 void		 load_url_in_tab(struct tab *, const char *, const char *, int);
328 int		 load_previous_page(struct tab*);
329 int		 load_next_page(struct tab*);
330 void		 write_buffer(const char *, struct tab *);
331 void		 humanify_url(const char *, char *, size_t);
332 int		 bookmark_page(const char *);
333 int		 ui_send_net(int, uint32_t, const void *, uint16_t);
334 
335 /* tofu.c */
336 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
337 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
338 void			 tofu_add(struct ohash*, struct tofu_entry*);
339 int			 tofu_save(struct ohash *, struct tofu_entry *);
340 void			 tofu_update(struct ohash*, struct tofu_entry*);
341 int			 tofu_update_persist(struct ohash *, struct tofu_entry *);
342 void			 tofu_temp_trust(struct ohash *, const char *, const char *, const char *);
343 
344 /* wrap.c */
345 void		 erase_buffer(struct buffer *);
346 void		 empty_linelist(struct buffer*);
347 void		 empty_vlist(struct buffer*);
348 int		 wrap_text(struct buffer*, const char*, struct line*, size_t, int);
349 int		 wrap_page(struct buffer *, int width);
350 
351 #endif /* TELESCOPE_H */