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