move one more function over
[xxxterm.git] / xxxterm.h
blob4c6bde9137a3eb59ab50e926f0c51e84a8b2f2a6
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 # endif
41 #elif defined(__FreeBSD__)
42 #include <libutil.h>
43 #include "freebsd/util.h"
44 #include <sys/tree.h>
45 #else /* OpenBSD */
46 #include <util.h>
47 #include <sys/tree.h>
48 #endif
49 #include <sys/queue.h>
50 #include <sys/resource.h>
51 #include <sys/socket.h>
52 #include <sys/stat.h>
53 #include <sys/time.h>
54 #include <sys/un.h>
56 #include <gtk/gtk.h>
57 #include <gdk/gdkkeysyms.h>
59 #if GTK_CHECK_VERSION(3,0,0)
60 /* we still use GDK_* instead of GDK_KEY_* */
61 #include <gdk/gdkkeysyms-compat.h>
62 #endif
64 #include <webkit/webkit.h>
65 #include <libsoup/soup.h>
66 #include <JavaScriptCore/JavaScript.h>
67 #include <gnutls/gnutls.h>
68 #include <gnutls/x509.h>
70 /* comment if you don't want to use threads */
71 //#define USE_THREADS
73 #ifdef USE_THREADS
74 #include <gcrypt.h>
75 #include <pthread.h>
76 #endif
78 #include "version.h"
79 #include "javascript.h"
81 javascript.h borrowed from vimprobable2 under the following license:
83 Copyright (c) 2009 Leon Winter
84 Copyright (c) 2009-2011 Hannes Schueller
85 Copyright (c) 2009-2010 Matto Fransen
86 Copyright (c) 2010-2011 Hans-Peter Deifel
87 Copyright (c) 2010-2011 Thomas Adam
88 Copyright (c) 2011 Albert Kim
89 Copyright (c) 2011 Daniel Carl
91 Permission is hereby granted, free of charge, to any person obtaining a copy
92 of this software and associated documentation files (the "Software"), to deal
93 in the Software without restriction, including without limitation the rights
94 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
95 copies of the Software, and to permit persons to whom the Software is
96 furnished to do so, subject to the following conditions:
98 The above copyright notice and this permission notice shall be included in
99 all copies or substantial portions of the Software.
101 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
102 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
103 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
104 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
105 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
106 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
107 THE SOFTWARE.
110 /*#define XT_DEBUG*/
111 #ifdef XT_DEBUG
112 #define DPRINTF(x...) do { if (swm_debug) fprintf(stderr, x); } while (0)
113 #define DNPRINTF(n,x...) do { if (swm_debug & n) fprintf(stderr, x); } while (0)
114 #define XT_D_MOVE 0x0001
115 #define XT_D_KEY 0x0002
116 #define XT_D_TAB 0x0004
117 #define XT_D_URL 0x0008
118 #define XT_D_CMD 0x0010
119 #define XT_D_NAV 0x0020
120 #define XT_D_DOWNLOAD 0x0040
121 #define XT_D_CONFIG 0x0080
122 #define XT_D_JS 0x0100
123 #define XT_D_FAVORITE 0x0200
124 #define XT_D_PRINTING 0x0400
125 #define XT_D_COOKIE 0x0800
126 #define XT_D_KEYBINDING 0x1000
127 #define XT_D_CLIP 0x2000
128 #define XT_D_BUFFERCMD 0x4000
129 #define XT_D_INSPECTOR 0x8000
130 extern u_int32_t swm_debug;
131 #else
132 #define DPRINTF(x...)
133 #define DNPRINTF(n,x...)
134 #endif
136 #define LENGTH(x) (sizeof x / sizeof x[0])
137 #define CLEAN(mask) (mask & ~(GDK_MOD2_MASK) & \
138 ~(GDK_BUTTON1_MASK) & \
139 ~(GDK_BUTTON2_MASK) & \
140 ~(GDK_BUTTON3_MASK) & \
141 ~(GDK_BUTTON4_MASK) & \
142 ~(GDK_BUTTON5_MASK))
144 #define XT_NOMARKS (('z' - 'a' + 1) * 2 + 10)
146 struct tab {
147 TAILQ_ENTRY(tab) entry;
148 GtkWidget *vbox;
149 GtkWidget *tab_content;
150 struct {
151 GtkWidget *label;
152 GtkWidget *eventbox;
153 GtkWidget *box;
154 GtkWidget *sep;
155 } tab_elems;
156 GtkWidget *label;
157 GtkWidget *spinner;
158 GtkWidget *uri_entry;
159 GtkWidget *search_entry;
160 GtkWidget *toolbar;
161 GtkWidget *browser_win;
162 GtkWidget *statusbar_box;
163 struct {
164 GtkWidget *statusbar;
165 GtkWidget *buffercmd;
166 GtkWidget *zoom;
167 GtkWidget *position;
168 } sbe;
169 GtkWidget *cmd;
170 GtkWidget *buffers;
171 GtkWidget *oops;
172 GtkWidget *backward;
173 GtkWidget *forward;
174 GtkWidget *stop;
175 GtkWidget *gohome;
176 GtkWidget *js_toggle;
177 GtkEntryCompletion *completion;
178 guint tab_id;
179 WebKitWebView *wv;
181 WebKitWebHistoryItem *item;
182 WebKitWebBackForwardList *bfl;
184 /* favicon */
185 WebKitNetworkRequest *icon_request;
186 WebKitDownload *icon_download;
187 gchar *icon_dest_uri;
189 /* adjustments for browser */
190 GtkScrollbar *sb_h;
191 GtkScrollbar *sb_v;
192 GtkAdjustment *adjust_h;
193 GtkAdjustment *adjust_v;
195 /* flags */
196 int focus_wv;
197 int ctrl_click;
198 gchar *status;
199 int xtp_meaning; /* identifies dls/favorites */
200 gchar *tmp_uri;
201 int popup; /* 1 if cmd_entry has popup visible */
202 #ifdef USE_THREADS
203 /* https thread stuff */
204 GThread *thread;
205 #endif
206 /* hints */
207 int script_init;
208 int hints_on;
209 int new_tab;
211 /* custom stylesheet */
212 int styled;
213 char *stylesheet;
215 /* search */
216 char *search_text;
217 int search_forward;
218 guint search_id;
220 /* settings */
221 WebKitWebSettings *settings;
222 gchar *user_agent;
224 /* marks */
225 double mark[XT_NOMARKS];
227 /* inspector */
228 WebKitWebInspector *inspector;
229 GtkWidget *inspector_window;
230 GtkWidget *inspector_view;
232 TAILQ_HEAD(tab_list, tab);
234 struct karg {
235 int i;
236 char *s;
237 int precount;
240 struct download {
241 RB_ENTRY(download) entry;
242 int id;
243 WebKitDownload *download;
244 struct tab *tab;
246 RB_HEAD(download_list, download);
247 RB_PROTOTYPE(download_list, download, entry, download_rb_cmp);
249 struct history {
250 RB_ENTRY(history) entry;
251 const gchar *uri;
252 const gchar *title;
254 RB_HEAD(history_list, history);
255 RB_PROTOTYPE(history_list, history, entry, history_rb_cmp);
257 /* utility */
258 #define XT_NAME ("XXXTerm")
259 #define XT_CB_HANDLED (TRUE)
260 #define XT_CB_PASSTHROUGH (FALSE)
261 #define XT_FAVS_FILE ("favorites")
263 void xt_icon_from_file(struct tab *, char *);
264 GtkWidget *create_window(const gchar *);
265 void show_oops(struct tab *, const char *, ...);
266 gchar *get_html_page(gchar *, gchar *, gchar *, bool);
267 const gchar *get_uri(struct tab *);
268 const gchar *get_title(struct tab *, bool);
270 void load_webkit_string(struct tab *, const char *, gchar *);
271 void button_set_stockid(GtkWidget *, char *);
273 /* cookies */
274 int remove_cookie(int);
276 /* inspector */
277 #define XT_INS_SHOW (1<<0)
278 #define XT_INS_HIDE (1<<1)
279 #define XT_INS_CLOSE (1<<2)
281 WebKitWebView* inspector_inspect_web_view_cb(WebKitWebInspector *,
282 WebKitWebView*, struct tab *);
283 void setup_inspector(struct tab *);
284 int inspector_cmd(struct tab *, struct karg *);
286 /* about */
287 #define XT_XTP_STR "xxxt://"
288 #define XT_URI_ABOUT ("about:")
289 #define XT_URI_ABOUT_LEN (strlen(XT_URI_ABOUT))
290 #define XT_URI_ABOUT_ABOUT ("about")
291 #define XT_URI_ABOUT_BLANK ("blank")
292 #define XT_URI_ABOUT_CERTS ("certs")
293 #define XT_URI_ABOUT_COOKIEWL ("cookiewl")
294 #define XT_URI_ABOUT_COOKIEJAR ("cookiejar")
295 #define XT_URI_ABOUT_DOWNLOADS ("downloads")
296 #define XT_URI_ABOUT_FAVORITES ("favorites")
297 #define XT_URI_ABOUT_HELP ("help")
298 #define XT_URI_ABOUT_HISTORY ("history")
299 #define XT_URI_ABOUT_JSWL ("jswl")
300 #define XT_URI_ABOUT_PLUGINWL ("plwl")
301 #define XT_URI_ABOUT_SET ("set")
302 #define XT_URI_ABOUT_STATS ("stats")
303 #define XT_URI_ABOUT_MARCO ("marco")
304 #define XT_URI_ABOUT_STARTPAGE ("startpage")
306 struct about_type {
307 char *name;
308 int (*func)(struct tab *, struct karg *);
311 struct sp {
312 char *line;
313 TAILQ_ENTRY(sp) entry;
315 TAILQ_HEAD(sp_list, sp);
317 int blank(struct tab *, struct karg *);
318 int help(struct tab *, struct karg *);
319 int about(struct tab *, struct karg *);
320 int stats(struct tab *, struct karg *);
321 void show_certs(struct tab *, gnutls_x509_crt_t *,
322 size_t, char *);
323 int ca_cmd(struct tab *, struct karg *);
324 int cookie_show_wl(struct tab *, struct karg *);
325 int xtp_page_cl(struct tab *, struct karg *);
326 int xtp_page_dl(struct tab *, struct karg *);
327 int xtp_page_fl(struct tab *, struct karg *);
328 int xtp_page_hl(struct tab *, struct karg *);
329 int parse_xtp_url(struct tab *, const char *);
330 int add_favorite(struct tab *, struct karg *);
331 void update_favorite_tabs(struct tab *);
332 void update_history_tabs(struct tab *);
333 void update_download_tabs(struct tab *);
334 void xtp_generate_keys(void);
335 size_t about_list_size(void);
336 int cookie_cmd(struct tab *, struct karg *);
337 int js_cmd(struct tab *, struct karg *);
338 int pl_cmd(struct tab *, struct karg *);
339 void startpage_add(const char *, ...);
342 * xtp tab meanings
343 * identifies which tabs have xtp pages in (corresponding to about_list indices)
345 #define XT_XTP_TAB_MEANING_NORMAL (-1) /* normal url */
346 #define XT_XTP_TAB_MEANING_BL (1) /* about:blank in this tab */
347 #define XT_XTP_TAB_MEANING_CL (4) /* cookie manager in this tab */
348 #define XT_XTP_TAB_MEANING_DL (5) /* download manager in this tab */
349 #define XT_XTP_TAB_MEANING_FL (6) /* favorite manager in this tab */
350 #define XT_XTP_TAB_MEANING_HL (8) /* history manager in this tab */
352 /* whitelists */
353 #define XT_WL_TOGGLE (1<<0)
354 #define XT_WL_ENABLE (1<<1)
355 #define XT_WL_DISABLE (1<<2)
356 #define XT_WL_FQDN (1<<3) /* default */
357 #define XT_WL_TOPLEVEL (1<<4)
358 #define XT_WL_PERSISTENT (1<<5)
359 #define XT_WL_SESSION (1<<6)
360 #define XT_WL_RELOAD (1<<7)
361 #define XT_SHOW (1<<8)
362 #define XT_DELETE (1<<9)
363 #define XT_SAVE (1<<10)
364 #define XT_OPEN (1<<11)
366 #define XT_WL_INVALID (0)
367 #define XT_WL_JAVASCRIPT (1)
368 #define XT_WL_COOKIE (2)
369 #define XT_WL_PLUGIN (3)
371 struct domain {
372 RB_ENTRY(domain) entry;
373 gchar *d;
374 int handy; /* app use */
376 RB_HEAD(domain_list, domain);
377 RB_PROTOTYPE(domain_list, domain, entry, domain_rb_cmp);
379 int wl_show(struct tab *, struct karg *, char *,
380 struct domain_list *);
382 /* uri aliases */
383 struct alias {
384 char *a_name;
385 char *a_uri;
386 TAILQ_ENTRY(alias) entry;
388 TAILQ_HEAD(alias_list, alias);
390 /* mime types */
391 struct mime_type {
392 char *mt_type;
393 char *mt_action;
394 int mt_default;
395 int mt_download;
396 TAILQ_ENTRY(mime_type) entry;
398 TAILQ_HEAD(mime_type_list, mime_type);
400 struct domain * wl_find(const gchar *, struct domain_list *);
401 int wl_save(struct tab *, struct karg *, int);
402 int toggle_cwl(struct tab *, struct karg *);
403 int toggle_js(struct tab *, struct karg *);
404 int toggle_pl(struct tab *, struct karg *);
406 /* settings */
407 #define XT_BM_NORMAL (0)
408 #define XT_BM_WHITELIST (1)
409 #define XT_BM_KIOSK (2)
411 #define XT_TABS_NORMAL (0)
412 #define XT_TABS_COMPACT (1)
414 #define CTRL GDK_CONTROL_MASK
415 #define MOD1 GDK_MOD1_MASK
416 #define SHFT GDK_SHIFT_MASK
418 struct key_binding {
419 char *cmd;
420 guint mask;
421 guint use_in_entry;
422 guint key;
423 TAILQ_ENTRY(key_binding) entry; /* in bss so no need to init */
425 TAILQ_HEAD(keybinding_list, key_binding);
427 struct settings {
428 char *name;
429 int type;
430 #define XT_S_INVALID (0)
431 #define XT_S_INT (1)
432 #define XT_S_STR (2)
433 #define XT_S_FLOAT (3)
434 uint32_t flags;
435 #define XT_SF_RESTART (1<<0)
436 #define XT_SF_RUNTIME (1<<1)
437 int *ival;
438 char **sval;
439 struct special *s;
440 gfloat *fval;
441 int (*activate)(char *);
444 int set(struct tab *, struct karg *);
445 size_t get_settings_size(void);
446 int settings_add(char *, char *);
447 void setup_proxy(char *);
448 int set_browser_mode(struct settings *, char *);
449 int set_cookie_policy(struct settings *, char *);
450 char *get_browser_mode(struct settings *);
451 char *get_cookie_policy(struct settings *);
452 void init_keybindings(void);
453 void config_parse(char *, int);
454 char *get_setting_name(int);
456 extern int tabless;
457 extern int enable_socket;
458 extern int single_instance;
459 extern int fancy_bar;
460 extern int browser_mode;
461 extern int enable_localstorage;
462 extern char *statusbar_elems;
464 extern int show_tabs;
465 extern int tab_style;
466 extern int show_url;
467 extern int show_statusbar;
468 extern int ctrl_click_focus;
469 extern int cookies_enabled;
470 extern int read_only_cookies;
471 extern int enable_scripts;
472 extern int enable_plugins;
473 extern gfloat default_zoom_level;
474 extern char default_script[PATH_MAX];
475 extern int window_height;
476 extern int window_width;
477 extern int icon_size;
478 extern int refresh_interval;
479 extern int enable_plugin_whitelist;
480 extern int enable_cookie_whitelist;
481 extern int enable_js_whitelist;
482 extern int session_timeout;
483 extern int cookie_policy;
484 extern char *ssl_ca_file;
485 extern char *resource_dir;
486 extern gboolean ssl_strict_certs;
487 extern int append_next;
488 extern char *home;
489 extern char *search_string;
490 extern char *http_proxy;
491 extern char download_dir[PATH_MAX];
492 extern char runtime_settings[PATH_MAX];
493 extern int allow_volatile_cookies;
494 extern int save_global_history;
495 extern char *user_agent;
496 extern int save_rejected_cookies;
497 extern int session_autosave;
498 extern int guess_search;
499 extern int dns_prefetch;
500 extern gint max_connections;
501 extern gint max_host_connections;
502 extern gint enable_spell_checking;
503 extern char *spell_check_languages;
504 extern int xterm_workaround;
505 extern char *url_regex;
506 extern int history_autosave;
507 extern char search_file[PATH_MAX];
508 extern char command_file[PATH_MAX];
509 extern char *encoding;
510 extern int autofocus_onload;
511 extern char *cmd_font_name;
512 extern char *oops_font_name;
513 extern char *statusbar_font_name;
514 extern char *tabbar_font_name;
516 /* globals */
517 extern char *version;
518 extern char *icons[];
519 extern char rc_fname[PATH_MAX];
520 extern char work_dir[PATH_MAX];
521 extern struct passwd *pwd;
522 long long unsigned int blocked_cookies;
523 extern SoupCookieJar *s_cookiejar;
524 extern SoupCookieJar *p_cookiejar;
525 extern SoupSession *session;
527 extern void (*_soup_cookie_jar_add_cookie)(SoupCookieJar *, SoupCookie *);
529 extern struct history_list hl;
530 extern struct download_list downloads;
531 extern struct tab_list tabs;
532 extern struct about_type about_list[];
533 extern struct domain_list c_wl;
534 extern struct domain_list js_wl;
535 extern struct domain_list pl_wl;
536 extern struct alias_list aliases;
537 extern struct mime_type_list mtl;
538 extern struct keybinding_list kbl;
539 extern struct sp_list spl;
541 extern PangoFontDescription *cmd_font;
542 extern PangoFontDescription *oops_font;
543 extern PangoFontDescription *statusbar_font;
544 extern PangoFontDescription *tabbar_font;