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