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 	/* help */
89 	LINE_HELP,
90 };
91 
92 /* for lines: mark as hidden */
93 #define L_HIDDEN	1
94 
95 /* for vlines: mark as continuation */
96 #define L_CONTINUATION	2
97 
98 struct line {
99 	enum line_type		 type;
100 	char			*line;
101 	char			*alt;
102 	void			*data;
103 	int			 flags;
104 	TAILQ_ENTRY(line)	 lines;
105 };
106 
107 struct vline {
108 	struct line		*parent;
109 	char			*line;
110 	int			 flags;
111 	TAILQ_ENTRY(vline)	 vlines;
112 };
113 
114 struct parser;
115 struct page;
116 
117 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
118 typedef int	(*parserfreefn)(struct parser*);
119 
120 typedef void (imsg_handlerfn)(struct imsg*, size_t);
121 
122 struct parser {
123 	const char	*name;
124 	char		 title[128+1];
125 	char		*buf;
126 	size_t		 len;
127 	size_t		 cap;
128 
129 #define PARSER_IN_BODY	1
130 #define PARSER_IN_PRE	2
131 	int		 flags;
132 	parsechunkfn	 parse;
133 	parserfreefn	 free;
134 
135 	TAILQ_HEAD(, line)	 head;
136 };
137 
138 /*
139  * differnt types of trust for a certificate.  Following
140  * gemini://thfr.info/gemini/modified-trust-verify.gmi
141  */
142 enum trust_state {
143 	TS_UNKNOWN,
144 	TS_UNTRUSTED,
145 	TS_TEMP_TRUSTED,
146 	TS_TRUSTED,
147 	TS_VERIFIED,
148 };
149 
150 struct tofu_entry {
151 	char	domain[GEMINI_URL_LEN];
152 
153 	/*
154 	 * enough space for ``PROTO:HASH''.  probably isn't a good
155 	 * idea tho.
156 	 */
157 	char	hash[128+1];
158 	int	verified;
159 };
160 
161 struct histhead {
162 	TAILQ_HEAD(mhisthead, hist)	head;
163 	size_t				len;
164 };
165 struct hist {
166 	char			h[1025];
167 	TAILQ_ENTRY(hist)	entries;
168 };
169 
170 struct buffer {
171 	struct parser		 page;
172 
173 	size_t			 last_line_off;
174 	int			 force_redraw;
175 
176 	int			 curs_x;
177 	int			 curs_y;
178 	size_t			 line_off;
179 	size_t			 line_max;
180 	struct vline		*top_line;
181 	struct vline		*current_line;
182 	size_t			 cpoff;
183 	TAILQ_HEAD(vhead, vline) head;
184 };
185 
186 #define TAB_CURRENT	0x1	/* only for save_session */
187 #define TAB_URGENT	0x2
188 #define TAB_LAZY	0x4	/* to lazy load tabs */
189 
190 #define NEW_TAB_URL	"about:new"
191 
192 extern TAILQ_HEAD(tabshead, tab) tabshead;
193 struct tab {
194 	TAILQ_ENTRY(tab)	 tabs;
195 	uint32_t		 id;
196 	uint32_t		 flags;
197 
198 	char			*cert;
199 	enum trust_state	 trust;
200 	struct proxy		*proxy;
201 	struct phos_uri		 uri;
202 	struct histhead		 hist;
203 	struct hist		*hist_cur;
204 	size_t			 hist_off;
205 
206 	int			 code;
207 	char			 meta[GEMINI_URL_LEN];
208 	int			 redirect_count;
209 
210 	struct buffer		 buffer;
211 
212 	short			 loading_anim;
213 	short			 loading_anim_step;
214 	struct event		 loadingev;
215 
216 	int			 fd;
217 	size_t			 bytes;
218 	char			*path;
219 };
220 
221 struct proto {
222 	const char	*schema;
223 
224 	/*
225 	 * should load the given url in the tab.  Optionally, it may
226 	 * consider the given url as relative to the one already
227 	 * present in tab.  It must set tab->urlstr to a serialized
228 	 * human-friendly URL.
229 	 */
230 	void		 (*loadfn)(struct tab*, const char*);
231 };
232 
233 extern TAILQ_HEAD(proxylist, proxy) proxies;
234 struct proxy {
235 	char	*match_proto;
236 
237 	char	*host;
238 	char	*port;
239 	int	 proto;
240 
241 	TAILQ_ENTRY(proxy) proxies;
242 };
243 
244 enum {
245 	PROTO_GEMINI,
246 	/* ... */
247 };
248 
249 struct get_req {
250 	int		proto;
251 	char		host[254];
252 	char		port[16];
253 	char		req[1027];
254 };
255 
256 struct kmap {
257 	TAILQ_HEAD(map, keymap)	m;
258 	void			(*unhandled_input)(void);
259 };
260 extern struct kmap global_map, minibuffer_map;
261 
262 typedef void(interactivefn)(struct buffer *);
263 
264 struct keymap {
265 	int			 meta;
266 	int			 key;
267 	struct kmap		 map;
268 	interactivefn		 *fn;
269 
270 	TAILQ_ENTRY(keymap)	 keymaps;
271 };
272 
273 struct cmd {
274 	const char	*cmd;
275 	void		(*fn)(struct buffer *);
276 	const char	*descr;
277 };
278 extern struct cmd cmds[];
279 
280 /* defaults.c */
281 void		 config_init(void);
282 int		 config_setprfx(const char *, const char *, const char *);
283 int		 config_setvari(const char *, int);
284 int		 config_setvars(const char *, char *);
285 int		 config_setcolor(int, const char *, int, int, int);
286 int		 config_setattr(const char *, int, int, int);
287 void		 config_apply_style(void);
288 
289 /* fs.c */
290 extern char	session_file[PATH_MAX];
291 
292 int		 fs_init(void);
293 int		 fs_main(void);
294 int		 last_time_crashed(void);
295 int		 lock_session(void);
296 int		 load_certs(struct ohash*);
297 
298 /* gemini.c */
299 int		 client_main(void);
300 
301 /* help.c */
302 void		 recompute_help(void);
303 
304 /* hist.c */
305 void		 hist_clear_forward(struct histhead*, struct hist*);
306 void		 hist_push(struct histhead*, struct hist*);
307 
308 /* keymap.c */
309 int		 kbd(const char*);
310 const char	*unkbd(int);
311 int		 kmap_define_key(struct kmap*, const char*, void(*)(struct buffer*));
312 
313 /* mime.c */
314 int		 setup_parser_for(struct tab*);
315 
316 /* parse.y */
317 void		 parseconfig(const char *, int);
318 
319 /* sandbox.c */
320 void		 sandbox_net_process(void);
321 void		 sandbox_ui_process(void);
322 void		 sandbox_fs_process(void);
323 
324 /* telescope.c */
325 void		 load_about_url(struct tab*, const char*);
326 void		 load_gemini_url(struct tab*, const char*);
327 void		 load_via_proxy(struct tab *, const char *, struct proxy *);
328 void		 load_url(struct tab *, const char *, const char *);
329 int		 load_previous_page(struct tab*);
330 int		 load_next_page(struct tab*);
331 void		 free_tab(struct tab *);
332 void		 stop_tab(struct tab*);
333 void		 add_to_bookmarks(const char*);
334 void		 save_session(void);
335 
336 /* tofu.c */
337 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
338 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
339 void			 tofu_add(struct ohash*, struct tofu_entry*);
340 void			 tofu_update(struct ohash*, struct tofu_entry*);
341 void			 tofu_temp_trust(struct ohash *, const char *, const char *, const char *);
342 
343 /* util.c */
344 int		 mark_nonblock(int);
345 int		 has_prefix(const char*, const char*);
346 int		 unicode_isspace(uint32_t);
347 int		 unicode_isgraph(uint32_t);
348 int		 dispatch_imsg(struct imsgev *, short, imsg_handlerfn **, size_t);
349 int		 imsg_compose_event(struct imsgev *, uint16_t, uint32_t, pid_t, int, const void *, uint16_t);
350 
351 /* wrap.c */
352 void		 erase_buffer(struct buffer *);
353 void		 empty_linelist(struct buffer*);
354 void		 empty_vlist(struct buffer*);
355 int		 wrap_one(struct buffer *, const char *, struct line *, size_t);
356 int		 wrap_text(struct buffer*, const char*, struct line*, size_t);
357 int		 hardwrap_text(struct buffer*, struct line*, size_t);
358 int		 wrap_page(struct buffer *, int width);
359 
360 #endif /* TELESCOPE_H */