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 
22 #include <event.h>
23 
24 #include "url.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 enum imsg_type {
32 	/* ui <-> client/fs */
33 	IMSG_GET,		/* data is URL, peerid the tab id */
34 	IMSG_ERR,
35 	IMSG_CHECK_CERT,
36 	IMSG_CERT_STATUS,
37 	IMSG_GOT_CODE,
38 	IMSG_GOT_META,
39 	IMSG_PROCEED,
40 	IMSG_STOP,
41 	IMSG_BUF,
42 	IMSG_EOF,
43 	IMSG_QUIT,
44 
45 	/* ui <-> fs */
46 	IMSG_BOOKMARK_PAGE,
47 	IMSG_BOOKMARK_OK,
48 };
49 
50 enum line_type {
51 	LINE_TEXT,
52 	LINE_LINK,
53 	LINE_TITLE_1,
54 	LINE_TITLE_2,
55 	LINE_TITLE_3,
56 	LINE_ITEM,
57 	LINE_QUOTE,
58 	LINE_PRE_START,
59 	LINE_PRE_CONTENT,
60 	LINE_PRE_END,
61 };
62 
63 struct line {
64 	enum line_type		 type;
65 	char			*line;
66 	char			*alt;
67 	int			 flags;
68 	TAILQ_ENTRY(line)	 lines;
69 };
70 
71 struct vline {
72 	const struct line	*parent;
73 	char			*line;
74 	int			 flags;
75 	TAILQ_ENTRY(vline)	 vlines;
76 };
77 
78 struct parser;
79 struct page;
80 
81 /* typedef void	(*initparserfn)(struct parser*); */
82 
83 typedef int	(*parsechunkfn)(struct parser*, const char*, size_t);
84 typedef int	(*parserfreefn)(struct parser*);
85 
86 typedef void (imsg_handlerfn)(struct imsg*, size_t);
87 
88 struct parser {
89 	const char	*name;
90 	char		 title[32+1];
91 	char		*buf;
92 	size_t		 len;
93 	size_t		 cap;
94 	int		 flags;
95 	parsechunkfn	 parse;
96 	parserfreefn	 free;
97 
98 	TAILQ_HEAD(, line)	 head;
99 };
100 
101 struct histhead {
102 	TAILQ_HEAD(mhisthead, hist)	head;
103 	size_t				len;
104 };
105 struct hist {
106 	char			h[1025];
107 	TAILQ_ENTRY(hist)	entries;
108 };
109 
110 struct ui_state {
111 	int			 curs_x;
112 	int			 curs_y;
113 	size_t			 line_off;
114 	size_t			 line_max;
115 	struct vline		*current_line;
116 	size_t			 line_x;
117 
118 	short			 loading_anim;
119 	short			 loading_anim_step;
120 	struct event		 loadingev;
121 
122 	TAILQ_HEAD(vhead, vline)	 head;
123 };
124 
125 extern TAILQ_HEAD(tabshead, tab) tabshead;
126 struct tab {
127 	struct parser		 page;
128 	TAILQ_ENTRY(tab)	 tabs;
129 	uint32_t		 id;
130 	uint32_t		 flags;
131 
132 	struct url		 url;
133 	struct histhead		 hist;
134 	struct hist		*hist_cur;
135 	size_t			 hist_off;
136 
137 	int			 code;
138 	char			 meta[GEMINI_URL_LEN];
139 	int			 redirect_count;
140 
141 	struct ui_state		 s;
142 };
143 
144 struct proto {
145 	const char	*schema;
146 
147 	/* should load the given url in the tab.  Optionally, it may
148 	 * consider the given url as relative to the one already
149 	 * present in tab.  It must set tab->urlstr to a serialized
150 	 * human-friendly URL. */
151 	void		 (*loadfn)(struct tab*, const char*);
152 };
153 
154 struct kmap {
155 	TAILQ_HEAD(map, keymap)	m;
156 	void			(*unhandled_input)(void);
157 };
158 
159 struct keymap {
160 	int			 meta;
161 	int			 key;
162 	struct kmap		 map;
163 	void			(*fn)(struct tab*);
164 
165 	TAILQ_ENTRY(keymap)	 keymaps;
166 };
167 
168 /* fs.c */
169 int		 fs_main(struct imsgbuf*);
170 
171 /* gemini.c */
172 int		 client_main(struct imsgbuf*);
173 
174 /* gemtext.c */
175 void		 gemtext_initparser(struct parser*);
176 
177 /* hist.c */
178 void		 hist_clear_forward(struct histhead*, struct hist*);
179 void		 hist_push(struct histhead*, struct hist*);
180 
181 /* keymap.c */
182 int		 kbd(const char*);
183 const char	*unkbd(int);
184 int		 kmap_define_key(struct kmap*, const char*, void(*)(struct tab*));
185 
186 /* mime.c */
187 int		 setup_parser_for(struct tab*);
188 
189 /* pages.c */
190 extern const char	*about_new;
191 
192 #define CANNOT_FETCH		0
193 #define TOO_MUCH_REDIRECTS	1
194 #define MALFORMED_RESPONSE	2
195 #define UNKNOWN_TYPE_OR_CSET	3
196 extern const char	*err_pages[70];
197 
198 /* parser.c */
199 int		 parser_append(struct parser*, const char*, size_t);
200 int		 parser_set_buf(struct parser*, const char*, size_t);
201 
202 /* sandbox.c */
203 void		 sandbox_network_process(void);
204 void		 sandbox_ui_process(void);
205 void		 sandbox_fs_process(void);
206 
207 /* telescope.c */
208 void		 load_about_url(struct tab*, const char*);
209 void		 load_gemini_url(struct tab*, const char*);
210 void		 load_url(struct tab*, const char*);
211 int		 load_previous_page(struct tab*);
212 int		 load_next_page(struct tab*);
213 void		 stop_tab(struct tab*);
214 void		 add_to_bookmarks(const char*);
215 
216 /* textplain.c */
217 void		 textplain_initparser(struct parser*);
218 
219 /* ui.c */
220 int		 ui_init(void);
221 void		 ui_on_tab_loaded(struct tab*);
222 void		 ui_on_tab_refresh(struct tab*);
223 void		 ui_require_input(struct tab*, int);
224 void		 ui_notify(const char*, ...) __attribute__((format(printf, 1, 2)));
225 void		 ui_end(void);
226 
227 /* util.c */
228 int		 mark_nonblock(int);
229 int		 has_prefix(const char*, const char*);
230 void		 dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
231 
232 /* wrap.c */
233 void		 wrap_text(struct tab*, const char*, struct line*, size_t);
234 int		 hardwrap_text(struct tab*, struct line*, size_t);
235 
236 #endif /* TELESCOPE_H */