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 
111 /* for lines: mark as hidden */
112 #define L_HIDDEN	1
113 
114 /* for vlines: mark as continuation */
115 #define L_CONTINUATION	2
116 
117 struct line {
118 	enum line_type		 type;
119 	char			*line;
120 	char			*alt;
121 	void			*data;
122 	int			 flags;
123 	TAILQ_ENTRY(line)	 lines;
124 };
125 
126 struct vline {
127 	struct line		*parent;
128 	char			*line;
129 	int			 flags;
130 	TAILQ_ENTRY(vline)	 vlines;
131 };
132 
133 struct parser;
134 
135 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
136 typedef int	(*parserfreefn)(struct parser*);
137 
138 typedef void (imsg_handlerfn)(struct imsg*, size_t);
139 
140 struct parser {
141 	const char	*name;
142 	char		 title[128+1];
143 	char		*buf;
144 	size_t		 len;
145 	size_t		 cap;
146 
147 #define PARSER_IN_BODY	1
148 #define PARSER_IN_PRE	2
149 #define PARSER_IN_PATCH_HDR 4
150 	int		 flags;
151 	parsechunkfn	 parse;
152 	parserfreefn	 free;
153 
154 	TAILQ_HEAD(, line)	 head;
155 };
156 
157 /*
158  * differnt types of trust for a certificate.  Following
159  * gemini://thfr.info/gemini/modified-trust-verify.gmi
160  */
161 enum trust_state {
162 	TS_UNKNOWN,
163 	TS_UNTRUSTED,
164 	TS_TEMP_TRUSTED,
165 	TS_TRUSTED,
166 	TS_VERIFIED,
167 };
168 
169 struct tofu_entry {
170 	char	domain[GEMINI_URL_LEN];
171 
172 	/*
173 	 * enough space for ``PROTO:HASH''.  probably isn't a good
174 	 * idea tho.
175 	 */
176 	char	hash[128+1];
177 	int	verified;
178 };
179 
180 struct histhead {
181 	TAILQ_HEAD(mhisthead, hist)	head;
182 	size_t				len;
183 };
184 struct hist {
185 	char			h[1025];
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 
228 	int			 code;
229 	char			 meta[GEMINI_URL_LEN];
230 	int			 redirect_count;
231 
232 	struct buffer		 buffer;
233 
234 	short			 loading_anim;
235 	short			 loading_anim_step;
236 	struct event		 loadingev;
237 };
238 
239 extern TAILQ_HEAD(proxylist, proxy) proxies;
240 struct proxy {
241 	char	*match_proto;
242 
243 	char	*host;
244 	char	*port;
245 	int	 proto;
246 
247 	TAILQ_ENTRY(proxy) proxies;
248 };
249 
250 enum {
251 	PROTO_FINGER,
252 	PROTO_GEMINI,
253 	PROTO_GOPHER,
254 	/* ... */
255 };
256 
257 struct get_req {
258 	int		proto;
259 	char		host[254];
260 	char		port[16];
261 	char		req[1027];
262 };
263 
264 struct cmd {
265 	const char	*cmd;
266 	void		(*fn)(struct buffer *);
267 	const char	*descr;
268 };
269 extern struct cmd cmds[];
270 
271 /* defaults.c */
272 void		 config_init(void);
273 int		 config_setprfx(const char *, const char *, const char *);
274 int		 config_setvari(const char *, int);
275 int		 config_setvars(const char *, char *);
276 int		 config_setcolor(int, const char *, int, int, int);
277 int		 config_setattr(const char *, int, int, int);
278 void		 config_apply_style(void);
279 
280 /* downloads.c */
281 extern STAILQ_HEAD(downloads, download) downloads;
282 struct download {
283 	uint32_t		 id;
284 	int			 fd;
285 	size_t			 bytes;
286 	char			*path;
287 	STAILQ_ENTRY(download)	 entries;
288 };
289 
290 void		 recompute_downloads(void);
291 void		 enqueue_download(uint32_t, const char *);
292 struct download	*download_by_id(uint32_t);
293 
294 /* help.c */
295 void		 recompute_help(void);
296 
297 /* hist.c */
298 void		 hist_clear(struct histhead *);
299 void		 hist_clear_forward(struct histhead*, struct hist*);
300 void		 hist_push(struct histhead*, struct hist*);
301 void		 hist_add_before(struct histhead *, struct hist *, struct hist *);
302 struct hist	*hist_pop(struct histhead *);
303 
304 /* mime.c */
305 int		 setup_parser_for(struct tab*);
306 
307 /* net.c */
308 int		 net_main(void);
309 
310 /* parse.y */
311 void		 parseconfig(const char *, int);
312 
313 /* sandbox.c */
314 void		 sandbox_net_process(void);
315 void		 sandbox_ui_process(void);
316 void		 sandbox_fs_process(void);
317 
318 /* telescope.c */
319 extern int operating;
320 extern int safe_mode;
321 
322 void		 gopher_send_search_req(struct tab *, const char *);
323 void		 load_url(struct tab *, const char *, const char *, int);
324 void		 load_url_in_tab(struct tab *, const char *, const char *, int);
325 int		 load_previous_page(struct tab*);
326 int		 load_next_page(struct tab*);
327 void		 add_to_bookmarks(const char*);
328 void		 humanify_url(const char *, char *, size_t);
329 int		 ui_send_net(int, uint32_t, const void *, uint16_t);
330 int		 ui_send_fs(int, uint32_t, const void *, uint16_t);
331 
332 /* tofu.c */
333 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
334 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
335 void			 tofu_add(struct ohash*, struct tofu_entry*);
336 void			 tofu_update(struct ohash*, struct tofu_entry*);
337 void			 tofu_temp_trust(struct ohash *, const char *, const char *, const char *);
338 
339 /* util.c */
340 int		 mark_nonblock(int);
341 int		 has_prefix(const char*, const char*);
342 int		 has_suffix(const char *, const char *);
343 int		 unicode_isspace(uint32_t);
344 int		 unicode_isgraph(uint32_t);
345 int		 dispatch_imsg(struct imsgev *, short, imsg_handlerfn **, size_t);
346 int		 imsg_compose_event(struct imsgev *, uint16_t, uint32_t, pid_t, int, const void *, uint16_t);
347 
348 /* wrap.c */
349 void		 erase_buffer(struct buffer *);
350 void		 empty_linelist(struct buffer*);
351 void		 empty_vlist(struct buffer*);
352 int		 wrap_one(struct buffer *, const char *, struct line *, size_t);
353 int		 wrap_text(struct buffer*, const char*, struct line*, size_t);
354 int		 hardwrap_text(struct buffer*, struct line*, size_t);
355 int		 wrap_page(struct buffer *, int width);
356 
357 #endif /* TELESCOPE_H */