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 
32 #define SIDE_WINDOW_LEFT	0x1
33 #define SIDE_WINDOW_BOTTOM	0x2
34 
35 struct imsgev {
36 	struct imsgbuf	 ibuf;
37 	void		(*handler)(int, short, void *);
38 	struct event	 ev;
39 	short		 events;
40 };
41 
42 enum imsg_type {
43 	/* ui <-> client/fs */
44 	IMSG_GET,		/* data is URL, peerid the tab id */
45 	IMSG_GET_FILE,		/* data is path, without \r\n or such */
46 	IMSG_GET_RAW,		/* get but with an explicit req str */
47 	IMSG_ERR,
48 	IMSG_CHECK_CERT,
49 	IMSG_CERT_STATUS,
50 	IMSG_GOT_CODE,
51 	IMSG_GOT_META,
52 	IMSG_PROCEED,
53 	IMSG_STOP,
54 	IMSG_BUF,
55 	IMSG_EOF,
56 	IMSG_QUIT,
57 
58 	/* ui <-> fs */
59 	IMSG_BOOKMARK_PAGE,
60 	IMSG_BOOKMARK_OK,
61 	IMSG_SAVE_CERT,
62 	IMSG_SAVE_CERT_OK,
63 	IMSG_UPDATE_CERT,
64 	IMSG_UPDATE_CERT_OK,
65 
66 	IMSG_FILE_OPEN,
67 	IMSG_FILE_OPENED,
68 
69 	IMSG_SESSION_START,
70 	IMSG_SESSION_TAB,
71 	IMSG_SESSION_TAB_TITLE,
72 	IMSG_SESSION_END,
73 };
74 
75 enum line_type {
76 	/* text/gemini */
77 	LINE_TEXT,
78 	LINE_LINK,
79 	LINE_TITLE_1,
80 	LINE_TITLE_2,
81 	LINE_TITLE_3,
82 	LINE_ITEM,
83 	LINE_QUOTE,
84 	LINE_PRE_START,
85 	LINE_PRE_CONTENT,
86 	LINE_PRE_END,
87 
88 	/* text/x-patch */
89 	LINE_PATCH,
90 	LINE_PATCH_HDR,
91 	LINE_PATCH_HUNK_HDR,
92 	LINE_PATCH_ADD,
93 	LINE_PATCH_DEL,
94 
95 	/* minibuffer */
96 	LINE_COMPL,
97 	LINE_COMPL_CURRENT,
98 
99 	/* help */
100 	LINE_HELP,
101 
102 	/* download */
103 	LINE_DOWNLOAD,
104 	LINE_DOWNLOAD_DONE,
105 	LINE_DOWNLOAD_INFO,
106 };
107 
108 /* for lines: mark as hidden */
109 #define L_HIDDEN	1
110 
111 /* for vlines: mark as continuation */
112 #define L_CONTINUATION	2
113 
114 struct line {
115 	enum line_type		 type;
116 	char			*line;
117 	char			*alt;
118 	void			*data;
119 	int			 flags;
120 	TAILQ_ENTRY(line)	 lines;
121 };
122 
123 struct vline {
124 	struct line		*parent;
125 	char			*line;
126 	int			 flags;
127 	TAILQ_ENTRY(vline)	 vlines;
128 };
129 
130 struct parser;
131 struct page;
132 
133 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
134 typedef int	(*parserfreefn)(struct parser*);
135 
136 typedef void (imsg_handlerfn)(struct imsg*, size_t);
137 
138 struct parser {
139 	const char	*name;
140 	char		 title[128+1];
141 	char		*buf;
142 	size_t		 len;
143 	size_t		 cap;
144 
145 #define PARSER_IN_BODY	1
146 #define PARSER_IN_PRE	2
147 #define PARSER_IN_PATCH_HDR 4
148 	int		 flags;
149 	parsechunkfn	 parse;
150 	parserfreefn	 free;
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 	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_URGENT	0x2
205 #define TAB_LAZY	0x4	/* to lazy load tabs */
206 
207 #define NEW_TAB_URL	"about:new"
208 
209 extern TAILQ_HEAD(tabshead, tab) tabshead;
210 struct tab {
211 	TAILQ_ENTRY(tab)	 tabs;
212 	uint32_t		 id;
213 	uint32_t		 flags;
214 
215 	char			*cert;
216 	enum trust_state	 trust;
217 	struct proxy		*proxy;
218 	struct phos_uri		 uri;
219 	struct histhead		 hist;
220 	struct hist		*hist_cur;
221 	size_t			 hist_off;
222 
223 	int			 code;
224 	char			 meta[GEMINI_URL_LEN];
225 	int			 redirect_count;
226 
227 	struct buffer		 buffer;
228 
229 	short			 loading_anim;
230 	short			 loading_anim_step;
231 	struct event		 loadingev;
232 };
233 
234 extern TAILQ_HEAD(proxylist, proxy) proxies;
235 struct proxy {
236 	char	*match_proto;
237 
238 	char	*host;
239 	char	*port;
240 	int	 proto;
241 
242 	TAILQ_ENTRY(proxy) proxies;
243 };
244 
245 enum {
246 	PROTO_FINGER,
247 	PROTO_GEMINI,
248 	PROTO_GOPHER,
249 	/* ... */
250 };
251 
252 struct get_req {
253 	int		proto;
254 	char		host[254];
255 	char		port[16];
256 	char		req[1027];
257 };
258 
259 struct cmd {
260 	const char	*cmd;
261 	void		(*fn)(struct buffer *);
262 	const char	*descr;
263 };
264 extern struct cmd cmds[];
265 
266 /* defaults.c */
267 void		 config_init(void);
268 int		 config_setprfx(const char *, const char *, const char *);
269 int		 config_setvari(const char *, int);
270 int		 config_setvars(const char *, char *);
271 int		 config_setcolor(int, const char *, int, int, int);
272 int		 config_setattr(const char *, int, int, int);
273 void		 config_apply_style(void);
274 
275 /* downloads.c */
276 extern STAILQ_HEAD(downloads, download) downloads;
277 struct download {
278 	uint32_t		 id;
279 	int			 fd;
280 	size_t			 bytes;
281 	char			*path;
282 	STAILQ_ENTRY(download)	 entries;
283 };
284 
285 void		 recompute_downloads(void);
286 void		 enqueue_download(uint32_t, const char *);
287 struct download	*download_by_id(uint32_t);
288 
289 /* help.c */
290 void		 recompute_help(void);
291 
292 /* hist.c */
293 void		 hist_clear_forward(struct histhead*, struct hist*);
294 void		 hist_push(struct histhead*, struct hist*);
295 struct hist	*hist_pop(struct histhead *);
296 
297 /* mime.c */
298 int		 setup_parser_for(struct tab*);
299 
300 /* net.c */
301 int		 net_main(void);
302 
303 /* parse.y */
304 void		 parseconfig(const char *, int);
305 
306 /* sandbox.c */
307 void		 sandbox_net_process(void);
308 void		 sandbox_ui_process(void);
309 void		 sandbox_fs_process(void);
310 
311 /* telescope.c */
312 extern int operating;
313 extern int safe_mode;
314 
315 void		 gopher_send_search_req(struct tab *, const char *);
316 void		 load_url(struct tab *, const char *, const char *, int);
317 void		 load_url_in_tab(struct tab *, const char *, const char *, int);
318 int		 load_previous_page(struct tab*);
319 int		 load_next_page(struct tab*);
320 void		 add_to_bookmarks(const char*);
321 void		 humanify_url(const char *, char *, size_t);
322 int		 ui_send_net(int, uint32_t, const void *, uint16_t);
323 int		 ui_send_fs(int, uint32_t, const void *, uint16_t);
324 
325 /* tofu.c */
326 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
327 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
328 void			 tofu_add(struct ohash*, struct tofu_entry*);
329 void			 tofu_update(struct ohash*, struct tofu_entry*);
330 void			 tofu_temp_trust(struct ohash *, const char *, const char *, const char *);
331 
332 /* util.c */
333 int		 mark_nonblock(int);
334 int		 has_prefix(const char*, const char*);
335 int		 has_suffix(const char *, const char *);
336 int		 unicode_isspace(uint32_t);
337 int		 unicode_isgraph(uint32_t);
338 int		 dispatch_imsg(struct imsgev *, short, imsg_handlerfn **, size_t);
339 int		 imsg_compose_event(struct imsgev *, uint16_t, uint32_t, pid_t, int, const void *, uint16_t);
340 
341 /* wrap.c */
342 void		 erase_buffer(struct buffer *);
343 void		 empty_linelist(struct buffer*);
344 void		 empty_vlist(struct buffer*);
345 int		 wrap_one(struct buffer *, const char *, struct line *, size_t);
346 int		 wrap_text(struct buffer*, const char*, struct line*, size_t);
347 int		 hardwrap_text(struct buffer*, struct line*, size_t);
348 int		 wrap_page(struct buffer *, int width);
349 
350 #endif /* TELESCOPE_H */