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