Prepare for release 1.9.0.
[xxxterm.git] / xxxterm.h
blob49b281b67013232aa9950666365f87ae24082713
1 /*
2 * Copyright (c) 2011 Conformal Systems LLC <info@conformal.com>
3 * Copyright (c) 2011 Marco Peereboom <marco@peereboom.us>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 #include <ctype.h>
19 #include <dlfcn.h>
20 #include <err.h>
21 #include <errno.h>
22 #include <libgen.h>
23 #include <pwd.h>
24 #include <regex.h>
25 #include <signal.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <unistd.h>
30 #include <dirent.h>
32 #include <sys/types.h>
33 #include <sys/wait.h>
34 #if defined(__linux__)
35 #include "linux/util.h"
36 #include "linux/tree.h"
37 #include <bsd/stdlib.h>
38 # if !defined(sane_libbsd_headers)
39 void arc4random_buf(void *, size_t);
40 u_int32_t arc4random_uniform(u_int32_t);
41 # endif
42 #elif defined(__FreeBSD__)
43 #include <libutil.h>
44 #include "freebsd/util.h"
45 #include <sys/tree.h>
46 #else /* OpenBSD */
47 #include <util.h>
48 #include <sys/tree.h>
49 #endif
50 #include <sys/queue.h>
51 #include <sys/resource.h>
52 #include <sys/socket.h>
53 #include <sys/stat.h>
54 #include <sys/time.h>
55 #include <sys/un.h>
57 #include <gtk/gtk.h>
58 #include <gdk/gdkkeysyms.h>
60 #if GTK_CHECK_VERSION(3,0,0)
61 /* we still use GDK_* instead of GDK_KEY_* */
62 #include <gdk/gdkkeysyms-compat.h>
63 #endif
65 #include <webkit/webkit.h>
66 #include <libsoup/soup.h>
67 #include <JavaScriptCore/JavaScript.h>
68 #include <gnutls/gnutls.h>
69 #include <gnutls/x509.h>
71 /* comment if you don't want to use threads */
72 #define USE_THREADS
74 #ifdef USE_THREADS
75 #include <gcrypt.h>
76 #include <pthread.h>
77 #endif
79 #include "version.h"
80 #include "javascript.h"
82 javascript.h borrowed from vimprobable2 under the following license:
84 Copyright (c) 2009 Leon Winter
85 Copyright (c) 2009-2011 Hannes Schueller
86 Copyright (c) 2009-2010 Matto Fransen
87 Copyright (c) 2010-2011 Hans-Peter Deifel
88 Copyright (c) 2010-2011 Thomas Adam
89 Copyright (c) 2011 Albert Kim
90 Copyright (c) 2011 Daniel Carl
92 Permission is hereby granted, free of charge, to any person obtaining a copy
93 of this software and associated documentation files (the "Software"), to deal
94 in the Software without restriction, including without limitation the rights
95 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
96 copies of the Software, and to permit persons to whom the Software is
97 furnished to do so, subject to the following conditions:
99 The above copyright notice and this permission notice shall be included in
100 all copies or substantial portions of the Software.
102 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
103 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
104 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
105 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
106 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
107 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
108 THE SOFTWARE.
111 /*#define XT_DEBUG*/
112 #ifdef XT_DEBUG
113 #define DPRINTF(x...) do { if (swm_debug) fprintf(stderr, x); } while (0)
114 #define DNPRINTF(n,x...) do { if (swm_debug & n) fprintf(stderr, x); } while (0)
115 #define XT_D_MOVE 0x0001
116 #define XT_D_KEY 0x0002
117 #define XT_D_TAB 0x0004
118 #define XT_D_URL 0x0008
119 #define XT_D_CMD 0x0010
120 #define XT_D_NAV 0x0020
121 #define XT_D_DOWNLOAD 0x0040
122 #define XT_D_CONFIG 0x0080
123 #define XT_D_JS 0x0100
124 #define XT_D_FAVORITE 0x0200
125 #define XT_D_PRINTING 0x0400
126 #define XT_D_COOKIE 0x0800
127 #define XT_D_KEYBINDING 0x1000
128 #define XT_D_CLIP 0x2000
129 #define XT_D_BUFFERCMD 0x4000
130 #define XT_D_INSPECTOR 0x8000
131 extern u_int32_t swm_debug;
132 #else
133 #define DPRINTF(x...)
134 #define DNPRINTF(n,x...)
135 #endif
137 #define LENGTH(x) (sizeof x / sizeof x[0])
138 #define CLEAN(mask) (mask & ~(GDK_MOD2_MASK) & \
139 ~(GDK_BUTTON1_MASK) & \
140 ~(GDK_BUTTON2_MASK) & \
141 ~(GDK_BUTTON3_MASK) & \
142 ~(GDK_BUTTON4_MASK) & \
143 ~(GDK_BUTTON5_MASK))
145 #define XT_NOMARKS (('z' - 'a' + 1) * 2 + 10)
147 struct tab {
148 TAILQ_ENTRY(tab) entry;
149 GtkWidget *vbox;
150 GtkWidget *tab_content;
151 struct {
152 GtkWidget *label;
153 GtkWidget *eventbox;
154 GtkWidget *box;
155 GtkWidget *sep;
156 } tab_elems;
157 GtkWidget *label;
158 GtkWidget *spinner;
159 GtkWidget *uri_entry;
160 GtkWidget *search_entry;
161 GtkWidget *toolbar;
162 GtkWidget *browser_win;
163 GtkWidget *statusbar_box;
164 struct {
165 GtkWidget *statusbar;
166 GtkWidget *buffercmd;
167 GtkWidget *zoom;
168 GtkWidget *position;
169 } sbe;
170 GtkWidget *cmd;
171 GtkWidget *buffers;
172 GtkWidget *oops;
173 GtkWidget *backward;
174 GtkWidget *forward;
175 GtkWidget *stop;
176 GtkWidget *gohome;
177 GtkWidget *js_toggle;
178 GtkEntryCompletion *completion;
179 guint tab_id;
180 WebKitWebView *wv;
182 WebKitWebHistoryItem *item;
183 WebKitWebBackForwardList *bfl;
185 /* favicon */
186 WebKitNetworkRequest *icon_request;
187 WebKitDownload *icon_download;
188 gchar *icon_dest_uri;
190 /* adjustments for browser */
191 GtkScrollbar *sb_h;
192 GtkScrollbar *sb_v;
193 GtkAdjustment *adjust_h;
194 GtkAdjustment *adjust_v;
196 /* flags */
197 int mode;
198 #define XT_MODE_COMMAND (0)
199 #define XT_MODE_INSERT (1)
200 #define XT_MODE_HINT (2)
201 int focus_wv;
202 int ctrl_click;
203 gchar *status;
204 int xtp_meaning; /* identifies dls/favorites */
205 gchar *tmp_uri;
206 int popup; /* 1 if cmd_entry has popup visible */
207 #ifdef USE_THREADS
208 /* https thread stuff */
209 GThread *thread;
210 #endif
211 /* hints */
212 int script_init;
213 int new_tab;
215 /* custom stylesheet */
216 int styled;
217 char *stylesheet;
219 /* search */
220 char *search_text;
221 int search_forward;
222 guint search_id;
224 /* settings */
225 WebKitWebSettings *settings;
226 gchar *user_agent;
228 /* marks */
229 double mark[XT_NOMARKS];
231 /* inspector */
232 WebKitWebInspector *inspector;
233 GtkWidget *inspector_window;
234 GtkWidget *inspector_view;
236 TAILQ_HEAD(tab_list, tab);
238 struct karg {
239 int i;
240 char *s;
241 int precount;
244 struct download {
245 RB_ENTRY(download) entry;
246 int id;
247 WebKitDownload *download;
248 struct tab *tab;
250 RB_HEAD(download_list, download);
251 RB_PROTOTYPE(download_list, download, entry, download_rb_cmp);
253 struct history {
254 RB_ENTRY(history) entry;
255 const gchar *uri;
256 const gchar *title;
258 RB_HEAD(history_list, history);
259 RB_PROTOTYPE(history_list, history, entry, history_rb_cmp);
261 /* utility */
262 #define XT_NAME ("XXXTerm")
263 #define XT_CB_HANDLED (TRUE)
264 #define XT_CB_PASSTHROUGH (FALSE)
265 #define XT_FAVS_FILE ("favorites")
267 int run_script(struct tab *, char *);
268 void xt_icon_from_file(struct tab *, char *);
269 GtkWidget *create_window(const gchar *);
270 void show_oops(struct tab *, const char *, ...);
271 gchar *get_html_page(gchar *, gchar *, gchar *, bool);
272 const gchar *get_uri(struct tab *);
273 const gchar *get_title(struct tab *, bool);
275 void load_webkit_string(struct tab *, const char *, gchar *);
276 void button_set_stockid(GtkWidget *, char *);
278 /* cookies */
279 int remove_cookie(int);
280 void print_cookie(char *msg, SoupCookie *);
281 void setup_cookies(void);
283 /* proxy */
284 #define XT_PRXY_SHOW (1<<0)
285 #define XT_PRXY_TOGGLE (1<<1)
287 /* inspector */
288 #define XT_INS_SHOW (1<<0)
289 #define XT_INS_HIDE (1<<1)
290 #define XT_INS_CLOSE (1<<2)
292 WebKitWebView* inspector_inspect_web_view_cb(WebKitWebInspector *,
293 WebKitWebView*, struct tab *);
294 void setup_inspector(struct tab *);
295 int inspector_cmd(struct tab *, struct karg *);
297 /* about */
298 #define XT_XTP_STR "xxxt://"
299 #define XT_URI_ABOUT ("about:")
300 #define XT_URI_ABOUT_LEN (strlen(XT_URI_ABOUT))
301 #define XT_URI_ABOUT_ABOUT ("about")
302 #define XT_URI_ABOUT_BLANK ("blank")
303 #define XT_URI_ABOUT_CERTS ("certs")
304 #define XT_URI_ABOUT_COOKIEWL ("cookiewl")
305 #define XT_URI_ABOUT_COOKIEJAR ("cookiejar")
306 #define XT_URI_ABOUT_DOWNLOADS ("downloads")
307 #define XT_URI_ABOUT_FAVORITES ("favorites")
308 #define XT_URI_ABOUT_HELP ("help")
309 #define XT_URI_ABOUT_HISTORY ("history")
310 #define XT_URI_ABOUT_JSWL ("jswl")
311 #define XT_URI_ABOUT_PLUGINWL ("plwl")
312 #define XT_URI_ABOUT_SET ("set")
313 #define XT_URI_ABOUT_STATS ("stats")
314 #define XT_URI_ABOUT_MARCO ("marco")
315 #define XT_URI_ABOUT_STARTPAGE ("startpage")
317 struct about_type {
318 char *name;
319 int (*func)(struct tab *, struct karg *);
322 struct sp {
323 char *line;
324 TAILQ_ENTRY(sp) entry;
326 TAILQ_HEAD(sp_list, sp);
328 int blank(struct tab *, struct karg *);
329 int help(struct tab *, struct karg *);
330 int about(struct tab *, struct karg *);
331 int stats(struct tab *, struct karg *);
332 void show_certs(struct tab *, gnutls_x509_crt_t *,
333 size_t, char *);
334 int ca_cmd(struct tab *, struct karg *);
335 int cookie_show_wl(struct tab *, struct karg *);
336 int xtp_page_cl(struct tab *, struct karg *);
337 int xtp_page_dl(struct tab *, struct karg *);
338 int xtp_page_fl(struct tab *, struct karg *);
339 int xtp_page_hl(struct tab *, struct karg *);
340 int parse_xtp_url(struct tab *, const char *);
341 int add_favorite(struct tab *, struct karg *);
342 void update_favorite_tabs(struct tab *);
343 void update_history_tabs(struct tab *);
344 void update_download_tabs(struct tab *);
345 void xtp_generate_keys(void);
346 size_t about_list_size(void);
347 int cookie_cmd(struct tab *, struct karg *);
348 int js_cmd(struct tab *, struct karg *);
349 int pl_cmd(struct tab *, struct karg *);
350 void startpage_add(const char *, ...);
353 * xtp tab meanings
354 * identifies which tabs have xtp pages in (corresponding to about_list indices)
356 #define XT_XTP_TAB_MEANING_NORMAL (-1) /* normal url */
357 #define XT_XTP_TAB_MEANING_BL (1) /* about:blank in this tab */
358 #define XT_XTP_TAB_MEANING_CL (4) /* cookie manager in this tab */
359 #define XT_XTP_TAB_MEANING_DL (5) /* download manager in this tab */
360 #define XT_XTP_TAB_MEANING_FL (6) /* favorite manager in this tab */
361 #define XT_XTP_TAB_MEANING_HL (8) /* history manager in this tab */
363 /* whitelists */
364 #define XT_WL_TOGGLE (1<<0)
365 #define XT_WL_ENABLE (1<<1)
366 #define XT_WL_DISABLE (1<<2)
367 #define XT_WL_FQDN (1<<3) /* default */
368 #define XT_WL_TOPLEVEL (1<<4)
369 #define XT_WL_PERSISTENT (1<<5)
370 #define XT_WL_SESSION (1<<6)
371 #define XT_WL_RELOAD (1<<7)
372 #define XT_SHOW (1<<8)
373 #define XT_DELETE (1<<9)
374 #define XT_SAVE (1<<10)
375 #define XT_OPEN (1<<11)
377 #define XT_WL_INVALID (0)
378 #define XT_WL_JAVASCRIPT (1)
379 #define XT_WL_COOKIE (2)
380 #define XT_WL_PLUGIN (3)
382 struct domain {
383 RB_ENTRY(domain) entry;
384 gchar *d;
385 int handy; /* app use */
387 RB_HEAD(domain_list, domain);
388 RB_PROTOTYPE(domain_list, domain, entry, domain_rb_cmp);
390 int wl_show(struct tab *, struct karg *, char *,
391 struct domain_list *);
393 /* uri aliases */
394 struct alias {
395 char *a_name;
396 char *a_uri;
397 TAILQ_ENTRY(alias) entry;
399 TAILQ_HEAD(alias_list, alias);
401 /* mime types */
402 struct mime_type {
403 char *mt_type;
404 char *mt_action;
405 int mt_default;
406 int mt_download;
407 TAILQ_ENTRY(mime_type) entry;
409 TAILQ_HEAD(mime_type_list, mime_type);
411 struct domain * wl_find(const gchar *, struct domain_list *);
412 int wl_save(struct tab *, struct karg *, int);
413 int toggle_cwl(struct tab *, struct karg *);
414 int toggle_js(struct tab *, struct karg *);
415 int toggle_pl(struct tab *, struct karg *);
417 /* input autofocus */
418 void input_autofocus(struct tab *);
419 void input_focus_blur(struct tab *, void *);
420 void *input_check_mode(struct tab *);
421 int command_mode(struct tab *, struct karg *);
423 /* settings */
424 #define XT_BM_NORMAL (0)
425 #define XT_BM_WHITELIST (1)
426 #define XT_BM_KIOSK (2)
428 #define XT_TABS_NORMAL (0)
429 #define XT_TABS_COMPACT (1)
431 #define XT_EM_HYBRID (0)
432 #define XT_EM_VI (1)
434 #define CTRL GDK_CONTROL_MASK
435 #define MOD1 GDK_MOD1_MASK
436 #define SHFT GDK_SHIFT_MASK
438 struct key_binding {
439 char *cmd;
440 guint mask;
441 guint use_in_entry;
442 guint key;
443 TAILQ_ENTRY(key_binding) entry; /* in bss so no need to init */
445 TAILQ_HEAD(keybinding_list, key_binding);
447 struct settings {
448 char *name;
449 int type;
450 #define XT_S_INVALID (0)
451 #define XT_S_INT (1)
452 #define XT_S_STR (2)
453 #define XT_S_FLOAT (3)
454 uint32_t flags;
455 #define XT_SF_RESTART (1<<0)
456 #define XT_SF_RUNTIME (1<<1)
457 int *ival;
458 char **sval;
459 struct special *s;
460 gfloat *fval;
461 int (*activate)(char *);
464 int set(struct tab *, struct karg *);
465 size_t get_settings_size(void);
466 int settings_add(char *, char *);
467 void setup_proxy(char *);
468 int set_browser_mode(struct settings *, char *);
469 int set_cookie_policy(struct settings *, char *);
470 char *get_browser_mode(struct settings *);
471 char *get_cookie_policy(struct settings *);
472 void init_keybindings(void);
473 void config_parse(char *, int);
474 char *get_setting_name(int);
476 extern int tabless;
477 extern int enable_socket;
478 extern int single_instance;
479 extern int fancy_bar;
480 extern int browser_mode;
481 extern int enable_localstorage;
482 extern char *statusbar_elems;
484 extern int show_tabs;
485 extern int tab_style;
486 extern int show_url;
487 extern int show_statusbar;
488 extern int ctrl_click_focus;
489 extern int cookies_enabled;
490 extern int read_only_cookies;
491 extern int enable_scripts;
492 extern int enable_plugins;
493 extern gfloat default_zoom_level;
494 extern char default_script[PATH_MAX];
495 extern int window_height;
496 extern int window_width;
497 extern int icon_size;
498 extern int refresh_interval;
499 extern int enable_plugin_whitelist;
500 extern int enable_cookie_whitelist;
501 extern int enable_js_whitelist;
502 extern int session_timeout;
503 extern int cookie_policy;
504 extern char *ssl_ca_file;
505 extern char *resource_dir;
506 extern gboolean ssl_strict_certs;
507 extern int append_next;
508 extern char *home;
509 extern char *search_string;
510 extern char *http_proxy;
511 extern char download_dir[PATH_MAX];
512 extern char runtime_settings[PATH_MAX];
513 extern int allow_volatile_cookies;
514 extern int save_global_history;
515 extern char *user_agent;
516 extern int save_rejected_cookies;
517 extern int session_autosave;
518 extern int guess_search;
519 extern int dns_prefetch;
520 extern gint max_connections;
521 extern gint max_host_connections;
522 extern gint enable_spell_checking;
523 extern char *spell_check_languages;
524 extern int xterm_workaround;
525 extern char *url_regex;
526 extern int history_autosave;
527 extern char search_file[PATH_MAX];
528 extern char command_file[PATH_MAX];
529 extern char *encoding;
530 extern int autofocus_onload;
531 extern int js_autorun_enabled;
532 extern char *cmd_font_name;
533 extern char *oops_font_name;
534 extern char *statusbar_font_name;
535 extern char *tabbar_font_name;
536 extern int edit_mode;
538 /* globals */
539 extern char *version;
540 extern char *icons[];
541 extern char rc_fname[PATH_MAX];
542 extern char work_dir[PATH_MAX];
543 extern struct passwd *pwd;
544 long long unsigned int blocked_cookies;
545 extern SoupCookieJar *s_cookiejar;
546 extern SoupCookieJar *p_cookiejar;
547 extern SoupSession *session;
548 extern GtkNotebook *notebook;
550 extern void (*_soup_cookie_jar_add_cookie)(SoupCookieJar *, SoupCookie *);
552 extern struct history_list hl;
553 extern struct download_list downloads;
554 extern struct tab_list tabs;
555 extern struct about_type about_list[];
556 extern struct domain_list c_wl;
557 extern struct domain_list js_wl;
558 extern struct domain_list pl_wl;
559 extern struct alias_list aliases;
560 extern struct mime_type_list mtl;
561 extern struct keybinding_list kbl;
562 extern struct sp_list spl;
564 extern PangoFontDescription *cmd_font;
565 extern PangoFontDescription *oops_font;
566 extern PangoFontDescription *statusbar_font;
567 extern PangoFontDescription *tabbar_font;