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 <event.h>
25 #include <limits.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 struct imsgev {
33 	struct imsgbuf	 ibuf;
34 	void		(*handler)(int, short, void *);
35 	struct event	 ev;
36 	short		 events;
37 };
38 
39 enum imsg_type {
40 	/* ui <-> client/fs */
41 	IMSG_GET,		/* data is URL, peerid the tab id */
42 	IMSG_GET_RAW,		/* get but with an explicit req str */
43 	IMSG_ERR,
44 	IMSG_CHECK_CERT,
45 	IMSG_CERT_STATUS,
46 	IMSG_GOT_CODE,
47 	IMSG_GOT_META,
48 	IMSG_PROCEED,
49 	IMSG_STOP,
50 	IMSG_BUF,
51 	IMSG_EOF,
52 	IMSG_QUIT,
53 
54 	/* ui <-> fs */
55 	IMSG_BOOKMARK_PAGE,
56 	IMSG_BOOKMARK_OK,
57 	IMSG_SAVE_CERT,
58 	IMSG_SAVE_CERT_OK,
59 	IMSG_UPDATE_CERT,
60 	IMSG_UPDATE_CERT_OK,
61 
62 	IMSG_FILE_OPEN,
63 	IMSG_FILE_OPENED,
64 
65 	IMSG_SESSION_START,
66 	IMSG_SESSION_TAB,
67 	IMSG_SESSION_TAB_TITLE,
68 	IMSG_SESSION_END,
69 };
70 
71 enum line_type {
72 	/* text/gemini */
73 	LINE_TEXT,
74 	LINE_LINK,
75 	LINE_TITLE_1,
76 	LINE_TITLE_2,
77 	LINE_TITLE_3,
78 	LINE_ITEM,
79 	LINE_QUOTE,
80 	LINE_PRE_START,
81 	LINE_PRE_CONTENT,
82 	LINE_PRE_END,
83 
84 	/* minibuffer */
85 	LINE_COMPL,
86 	LINE_COMPL_CURRENT,
87 };
88 
89 /* for lines: mark as hidden */
90 #define L_HIDDEN	1
91 
92 /* for vlines: mark as continuation */
93 #define L_CONTINUATION	2
94 
95 struct line {
96 	enum line_type		 type;
97 	char			*line;
98 	char			*alt;
99 	void			*data;
100 	int			 flags;
101 	TAILQ_ENTRY(line)	 lines;
102 };
103 
104 struct vline {
105 	struct line		*parent;
106 	char			*line;
107 	int			 flags;
108 	TAILQ_ENTRY(vline)	 vlines;
109 };
110 
111 struct parser;
112 struct page;
113 
114 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
115 typedef int	(*parserfreefn)(struct parser*);
116 
117 typedef void (imsg_handlerfn)(struct imsg*, size_t);
118 
119 struct parser {
120 	const char	*name;
121 	char		 title[128+1];
122 	char		*buf;
123 	size_t		 len;
124 	size_t		 cap;
125 
126 #define PARSER_IN_BODY	1
127 #define PARSER_IN_PRE	2
128 	int		 flags;
129 	parsechunkfn	 parse;
130 	parserfreefn	 free;
131 
132 	TAILQ_HEAD(, line)	 head;
133 };
134 
135 /*
136  * differnt types of trust for a certificate.  Following
137  * gemini://thfr.info/gemini/modified-trust-verify.gmi
138  */
139 enum trust_state {
140 	TS_UNKNOWN,
141 	TS_UNTRUSTED,
142 	TS_TEMP_TRUSTED,
143 	TS_TRUSTED,
144 	TS_VERIFIED,
145 };
146 
147 struct tofu_entry {
148 	char	domain[GEMINI_URL_LEN];
149 
150 	/*
151 	 * enough space for ``PROTO:HASH''.  probably isn't a good
152 	 * idea tho.
153 	 */
154 	char	hash[128+1];
155 	int	verified;
156 };
157 
158 struct histhead {
159 	TAILQ_HEAD(mhisthead, hist)	head;
160 	size_t				len;
161 };
162 struct hist {
163 	char			h[1025];
164 	TAILQ_ENTRY(hist)	entries;
165 };
166 
167 struct buffer {
168 	struct parser		 page;
169 
170 	size_t			 last_line_off;
171 	int			 force_redraw;
172 
173 	int			 curs_x;
174 	int			 curs_y;
175 	size_t			 line_off;
176 	size_t			 line_max;
177 	struct vline		*top_line;
178 	struct vline		*current_line;
179 	size_t			 cpoff;
180 	TAILQ_HEAD(vhead, vline) head;
181 };
182 
183 #define TAB_CURRENT	0x1	/* only for save_session */
184 #define TAB_URGENT	0x2
185 #define TAB_LAZY	0x4	/* to lazy load tabs */
186 
187 #define NEW_TAB_URL	"about:new"
188 
189 extern TAILQ_HEAD(tabshead, tab) tabshead;
190 struct tab {
191 	TAILQ_ENTRY(tab)	 tabs;
192 	uint32_t		 id;
193 	uint32_t		 flags;
194 
195 	char			*cert;
196 	enum trust_state	 trust;
197 	struct proxy		*proxy;
198 	struct phos_uri		 uri;
199 	struct histhead		 hist;
200 	struct hist		*hist_cur;
201 	size_t			 hist_off;
202 
203 	int			 code;
204 	char			 meta[GEMINI_URL_LEN];
205 	int			 redirect_count;
206 
207 	struct buffer		 buffer;
208 
209 	short			 loading_anim;
210 	short			 loading_anim_step;
211 	struct event		 loadingev;
212 
213 	int			 fd;
214 	size_t			 bytes;
215 	char			*path;
216 };
217 
218 struct proto {
219 	const char	*schema;
220 
221 	/*
222 	 * should load the given url in the tab.  Optionally, it may
223 	 * consider the given url as relative to the one already
224 	 * present in tab.  It must set tab->urlstr to a serialized
225 	 * human-friendly URL.
226 	 */
227 	void		 (*loadfn)(struct tab*, const char*);
228 };
229 
230 extern TAILQ_HEAD(proxylist, proxy) proxies;
231 struct proxy {
232 	char	*match_proto;
233 
234 	char	*host;
235 	char	*port;
236 	int	 proto;
237 
238 	TAILQ_ENTRY(proxy) proxies;
239 };
240 
241 enum {
242 	PROTO_GEMINI,
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 /* gemini.c */
296 int		 client_main(void);
297 
298 /* help.c */
299 void		 recompute_help(void);
300 
301 /* hist.c */
302 void		 hist_clear_forward(struct histhead*, struct hist*);
303 void		 hist_push(struct histhead*, struct hist*);
304 
305 /* keymap.c */
306 int		 kbd(const char*);
307 const char	*unkbd(int);
308 int		 kmap_define_key(struct kmap*, const char*, void(*)(struct buffer*));
309 
310 /* mime.c */
311 int		 setup_parser_for(struct tab*);
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_about_url(struct tab*, const char*);
323 void		 load_gemini_url(struct tab*, const char*);
324 void		 load_via_proxy(struct tab *, const char *, struct proxy *);
325 void		 load_url(struct tab *, const char *, const char *);
326 int		 load_previous_page(struct tab*);
327 int		 load_next_page(struct tab*);
328 void		 free_tab(struct tab *);
329 void		 stop_tab(struct tab*);
330 void		 add_to_bookmarks(const char*);
331 void		 save_session(void);
332 
333 /* tofu.c */
334 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
335 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
336 void			 tofu_add(struct ohash*, struct tofu_entry*);
337 void			 tofu_update(struct ohash*, struct tofu_entry*);
338 void			 tofu_temp_trust(struct ohash *, const char *, const char *, const char *);
339 
340 /* util.c */
341 int		 mark_nonblock(int);
342 int		 has_prefix(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 */