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