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