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 "compat.h"
21 #include "phos/phos.h"
22 
23 #include <event.h>
24 
25 #define MIN(a, b) ((a) < (b) ? (a) : (b))
26 #define MAX(a, b) ((a) > (b) ? (a) : (b))
27 
28 #define GEMINI_URL_LEN 1024
29 
30 enum imsg_type {
31 	/* ui <-> client/fs */
32 	IMSG_GET,		/* data is URL, peerid the tab id */
33 	IMSG_ERR,
34 	IMSG_CHECK_CERT,
35 	IMSG_CERT_STATUS,
36 	IMSG_GOT_CODE,
37 	IMSG_GOT_META,
38 	IMSG_PROCEED,
39 	IMSG_STOP,
40 	IMSG_BUF,
41 	IMSG_EOF,
42 	IMSG_QUIT,
43 
44 	/* ui <-> fs */
45 	IMSG_BOOKMARK_PAGE,
46 	IMSG_BOOKMARK_OK,
47 	IMSG_SAVE_CERT,
48 	IMSG_SAVE_CERT_OK,
49 	IMSG_UPDATE_CERT,
50 	IMSG_UPDATE_CERT_OK,
51 
52 	IMSG_SESSION_START,
53 	IMSG_SESSION_TAB,
54 	IMSG_SESSION_END,
55 };
56 
57 enum line_type {
58 	LINE_TEXT,
59 	LINE_LINK,
60 	LINE_TITLE_1,
61 	LINE_TITLE_2,
62 	LINE_TITLE_3,
63 	LINE_ITEM,
64 	LINE_QUOTE,
65 	LINE_PRE_START,
66 	LINE_PRE_CONTENT,
67 	LINE_PRE_END,
68 };
69 
70 struct line {
71 	enum line_type		 type;
72 	char			*line;
73 	char			*alt;
74 	int			 flags;
75 	TAILQ_ENTRY(line)	 lines;
76 };
77 
78 struct vline {
79 	const struct line	*parent;
80 	char			*line;
81 	int			 flags;
82 	TAILQ_ENTRY(vline)	 vlines;
83 };
84 
85 struct parser;
86 struct page;
87 
88 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
89 typedef int	(*parserfreefn)(struct parser*);
90 
91 typedef void (imsg_handlerfn)(struct imsg*, size_t);
92 
93 struct parser {
94 	const char	*name;
95 	char		 title[32+1];
96 	char		*buf;
97 	size_t		 len;
98 	size_t		 cap;
99 	int		 flags;
100 	parsechunkfn	 parse;
101 	parserfreefn	 free;
102 
103 	TAILQ_HEAD(, line)	 head;
104 };
105 
106 /*
107  * differnt types of trust for a certificate.  Following
108  * gemini://thfr.info/gemini/modified-trust-verify.gmi
109  */
110 enum trust_state {
111 	TS_UNKNOWN,
112 	TS_UNTRUSTED,
113 	TS_TRUSTED,
114 	TS_VERIFIED,
115 };
116 
117 struct tofu_entry {
118 	char	domain[GEMINI_URL_LEN];
119 
120 	/*
121 	 * enough space for ``PROTO:HASH''.  probably isn't a good
122 	 * idea tho.
123 	 */
124 	char	hash[128+1];
125 	int	verified;
126 };
127 
128 struct histhead {
129 	TAILQ_HEAD(mhisthead, hist)	head;
130 	size_t				len;
131 };
132 struct hist {
133 	char			h[1025];
134 	TAILQ_ENTRY(hist)	entries;
135 };
136 
137 struct window {
138 	struct parser		 page;
139 	int			 curs_x;
140 	int			 curs_y;
141 	size_t			 line_off;
142 	size_t			 line_max;
143 	struct vline		*current_line;
144 	size_t			 cpoff;
145 	TAILQ_HEAD(vhead, vline) head;
146 };
147 
148 extern TAILQ_HEAD(tabshead, tab) tabshead;
149 struct tab {
150 	TAILQ_ENTRY(tab)	 tabs;
151 	uint32_t		 id;
152 	uint32_t		 flags;
153 
154 	char			*cert;
155 	enum trust_state	 trust;
156 	struct phos_uri		 uri;
157 	struct histhead		 hist;
158 	struct hist		*hist_cur;
159 	size_t			 hist_off;
160 
161 	int			 code;
162 	char			 meta[GEMINI_URL_LEN];
163 	int			 redirect_count;
164 
165 	struct window		 window;
166 
167 	short			 loading_anim;
168 	short			 loading_anim_step;
169 	struct event		 loadingev;
170 };
171 
172 struct proto {
173 	const char	*schema;
174 
175 	/*
176 	 * should load the given url in the tab.  Optionally, it may
177 	 * consider the given url as relative to the one already
178 	 * present in tab.  It must set tab->urlstr to a serialized
179 	 * human-friendly URL.
180 	 */
181 	void		 (*loadfn)(struct tab*, const char*);
182 };
183 
184 struct kmap {
185 	TAILQ_HEAD(map, keymap)	m;
186 	void			(*unhandled_input)(void);
187 };
188 
189 struct keymap {
190 	int			 meta;
191 	int			 key;
192 	struct kmap		 map;
193 	void			(*fn)(struct window*);
194 
195 	TAILQ_ENTRY(keymap)	 keymaps;
196 };
197 
198 /* fs.c */
199 int		 fs_init(void);
200 int		 fs_main(struct imsgbuf*);
201 int		 load_certs(struct ohash*);
202 int		 load_last_session(void(*)(const char*));
203 
204 /* gemini.c */
205 int		 client_main(struct imsgbuf*);
206 
207 /* gemtext.c */
208 void		 gemtext_initparser(struct parser*);
209 
210 /* hist.c */
211 void		 hist_clear_forward(struct histhead*, struct hist*);
212 void		 hist_push(struct histhead*, struct hist*);
213 
214 /* keymap.c */
215 int		 kbd(const char*);
216 const char	*unkbd(int);
217 int		 kmap_define_key(struct kmap*, const char*, void(*)(struct window*));
218 
219 /* mime.c */
220 int		 setup_parser_for(struct tab*);
221 
222 /* pages.c */
223 extern const char	*about_new;
224 
225 #define CANNOT_FETCH		0
226 #define TOO_MUCH_REDIRECTS	1
227 #define MALFORMED_RESPONSE	2
228 #define UNKNOWN_TYPE_OR_CSET	3
229 extern const char	*err_pages[70];
230 
231 /* parser.c */
232 int		 parser_append(struct parser*, const char*, size_t);
233 int		 parser_set_buf(struct parser*, const char*, size_t);
234 int		 parser_foreach_line(struct parser*, const char*, size_t, parsechunkfn);
235 
236 /* sandbox.c */
237 void		 sandbox_network_process(void);
238 void		 sandbox_ui_process(void);
239 void		 sandbox_fs_process(void);
240 
241 /* telescope.c */
242 void		 load_about_url(struct tab*, const char*);
243 void		 load_gemini_url(struct tab*, const char*);
244 void		 load_url(struct tab*, const char*);
245 int		 load_previous_page(struct tab*);
246 int		 load_next_page(struct tab*);
247 void		 stop_tab(struct tab*);
248 void		 add_to_bookmarks(const char*);
249 void		 save_session(void);
250 
251 /* textplain.c */
252 void		 textplain_initparser(struct parser*);
253 
254 /* tofu.c */
255 void			 tofu_init(struct ohash*, unsigned int, ptrdiff_t);
256 struct tofu_entry	*tofu_lookup(struct ohash*, const char*, const char*);
257 void			 tofu_add(struct ohash*, struct tofu_entry*);
258 void			 tofu_update(struct ohash*, struct tofu_entry*);
259 
260 /* ui.c */
261 unsigned int	 tab_new_id(void);
262 int		 ui_init(int, char * const*);
263 void		 ui_on_tab_loaded(struct tab*);
264 void		 ui_on_tab_refresh(struct tab*);
265 void		 ui_require_input(struct tab*, int);
266 void		 ui_yornp(const char*, void (*)(int, unsigned int), unsigned int);
267 void		 ui_notify(const char*, ...) __attribute__((format(printf, 1, 2)));
268 void		 ui_end(void);
269 
270 /* utf.8 */
271 uint32_t	 utf8_decode(uint32_t*restrict, uint32_t*restrict, uint8_t);
272 size_t		 utf8_encode(uint32_t, char*);
273 char		*utf8_nth(char*, size_t);
274 size_t		 utf8_cplen(char*);
275 size_t		 utf8_chwidth(uint32_t);
276 size_t		 utf8_snwidth(const char*, size_t);
277 size_t		 utf8_swidth(const char*);
278 size_t		 utf8_swidth_between(const char*, const char*);
279 char		*utf8_next_cp(const char*);
280 char		*utf8_prev_cp(const char*, const char*);
281 
282 /* util.c */
283 int		 mark_nonblock(int);
284 int		 has_prefix(const char*, const char*);
285 int		 unicode_isspace(uint32_t);
286 int		 unicode_isgraph(uint32_t);
287 void		 dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
288 
289 /* wrap.c */
290 void		 empty_linelist(struct window*);
291 void		 empty_vlist(struct window*);
292 int		 wrap_text(struct window*, const char*, struct line*, size_t);
293 int		 hardwrap_text(struct window*, struct line*, size_t);
294 
295 #endif /* TELESCOPE_H */