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