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