d53db9a25c0cda6955597e033b92efe27aa43fad
[claws.git] / src / prefs_common.h
1 /*
2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2016 Hiroyuki Yamamoto and the Claws Mail team
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #ifndef __PREFS_COMMON_H__
20 #define __PREFS_COMMON_H__
21
22 #ifdef HAVE_CONFIG_H
23 #include "config.h"
24 #include "claws-features.h"
25 #endif
26
27 #include <glib.h>
28
29 #include "mainwindow.h"
30 #include "summaryview.h"
31 #include "folderview.h"
32 #include "codeconv.h"
33 #include "textview.h"
34 #include "procmime.h"
35 #include "prefs_msg_colors.h"
36 #include "prefs_summary_open.h"
37
38 #define CLAWS_CONFIG_VERSION 3
39
40 typedef struct _PrefsCommon     PrefsCommon;
41
42 typedef enum {
43         RECV_DIALOG_ALWAYS,
44         RECV_DIALOG_MANUAL,
45         RECV_DIALOG_NEVER
46 } RecvDialogMode;
47
48 typedef enum {
49         COMPOSE_DND_ASK,
50         COMPOSE_DND_INSERT,
51         COMPOSE_DND_ATTACH
52 } ComposeDndInsertOrAttach;
53
54 typedef enum {
55         CTE_AUTO,
56         CTE_BASE64,
57         CTE_QUOTED_PRINTABLE,
58         CTE_8BIT
59 } TransferEncodingMethod;
60
61 typedef enum
62 {
63 /* U = unread, N = new, M = marked */
64         SELECTONENTRY_NOTHING,
65         SELECTONENTRY_UNM,
66         SELECTONENTRY_UMN,
67         SELECTONENTRY_NUM,
68         SELECTONENTRY_NMU,
69         SELECTONENTRY_MNU,
70         SELECTONENTRY_MUN,
71         SELECTONENTRY_LAST
72 } SelectOnEntry;
73
74 typedef enum
75 {
76         ACTION_UNSET = 0, /* for backward compatibility */
77         ACTION_OLDEST_MARKED,
78         ACTION_OLDEST_NEW,
79         ACTION_OLDEST_UNREAD,
80         ACTION_LAST_OPENED,
81         ACTION_NEWEST_LIST,
82         ACTION_NOTHING,
83         ACTION_OLDEST_LIST,
84         ACTION_NEWEST_MARKED,
85         ACTION_NEWEST_NEW,
86         ACTION_NEWEST_UNREAD
87 } EntryAction;
88
89 typedef enum
90 {
91         NEXTUNREADMSGDIALOG_ALWAYS,
92         NEXTUNREADMSGDIALOG_ASSUME_YES,
93         NEXTUNREADMSGDIALOG_ASSUME_NO
94 } NextUnreadMsgDialogShow;
95
96 typedef enum
97 {
98         SHOW_NAME,
99         SHOW_ADDR,
100         SHOW_BOTH
101 } SummaryFromShow;
102
103 typedef enum
104 {
105         AVATARS_DISABLE = 0,
106         AVATARS_ENABLE_CAPTURE = 1,
107         AVATARS_ENABLE_RENDER = 2,
108         AVATARS_ENABLE_BOTH = 3
109 } EnableAvatars;
110
111 typedef enum
112 {
113         COL_MISSPELLED,
114         COL_QUOTE_LEVEL1,
115         COL_QUOTE_LEVEL2,
116         COL_QUOTE_LEVEL3,
117         COL_QUOTE_LEVEL1_BG,
118         COL_QUOTE_LEVEL2_BG,
119         COL_QUOTE_LEVEL3_BG,
120         COL_URI,
121         COL_TGT_FOLDER,
122         COL_SIGNATURE,
123         COL_EMPHASIS,
124         COL_DEFAULT_HEADER,
125         COL_DEFAULT_HEADER_BG,
126         COL_TAGS,
127         COL_TAGS_BG,
128         COL_QS_ACTIVE,
129         COL_QS_ACTIVE_BG,
130         COL_QS_ERROR,
131         COL_QS_ERROR_BG,
132         COL_LOG_MSG,
133         COL_LOG_WARN,
134         COL_LOG_ERROR,
135         COL_LOG_IN,
136         COL_LOG_OUT,
137         COL_LOG_STATUS_OK,
138         COL_LOG_STATUS_NOK,
139         COL_LOG_STATUS_SKIP,
140         COL_NEW,
141         COL_DIFF_ADDED,
142         COL_DIFF_DELETED,
143         COL_DIFF_HUNK,
144         COL_LAST_COLOR_INDEX
145 } ColorIndex;
146
147 struct _PrefsCommon
148 {
149         gint config_version;
150
151         /* Receive */
152         gboolean use_extinc;
153         gchar *extinc_cmd;
154         gboolean scan_all_after_inc;
155         gboolean autochk_newmail;
156         gint autochk_itv;
157         gboolean chk_on_startup;
158         gboolean open_inbox_on_inc;
159         gboolean newmail_notify_auto;
160         gboolean newmail_notify_manu;
161         gchar   *newmail_notify_cmd;
162         RecvDialogMode recv_dialog_mode;
163         gint receivewin_width;
164         gint receivewin_height;
165         gboolean close_recv_dialog;
166         gboolean no_recv_err_panel;
167
168         /* Send */
169         gboolean savemsg;
170         gboolean confirm_send_queued_messages;
171         gboolean send_dialog_invisible;
172         gint sendwin_width;
173         gint sendwin_height;
174         gchar *outgoing_charset;
175         TransferEncodingMethod encoding_method;
176         gboolean outgoing_fallback_to_ascii;
177         gboolean rewrite_first_from;
178         gboolean warn_empty_subj;
179         gint warn_sending_many_recipients_num;
180         gboolean hide_timezone;
181         gboolean allow_jisx0201_kana;
182
183         /* Compose */
184         gint undolevels;
185         gint linewrap_len;
186         gboolean linewrap_quote;
187         gboolean linewrap_pastes;
188         gboolean primary_paste_unselects;
189         gboolean autowrap;
190         gboolean auto_indent;
191         gboolean auto_exteditor;
192         gboolean reply_account_autosel;
193         gboolean default_reply_list;
194         gboolean forward_account_autosel;
195         gboolean reedit_account_autosel;
196         gboolean show_ruler;
197         gboolean autosave;
198         gint autosave_length;
199         gboolean autosave_encrypted;
200         gboolean warn_large_insert;
201         gint warn_large_insert_size;
202         gboolean compose_no_markup;
203         ComposeDndInsertOrAttach compose_dnd_mode;
204         gboolean compose_with_format;
205         gchar *compose_subject_format;
206         gchar *compose_body_format;
207         gboolean show_compose_margin;
208         gboolean type_any_header;
209
210         /* Quote */
211         gboolean reply_with_quote;
212         gchar *quotemark;
213         gchar *quotefmt;
214         gchar *fw_quotemark;
215         gchar *fw_quotefmt;
216         gboolean forward_as_attachment;
217         gboolean redirect_keep_from;
218         gchar *quote_chars;
219         
220         gboolean enable_aspell;
221         gchar *dictionary;
222         gchar *alt_dictionary;
223         gboolean check_while_typing;
224         gboolean recheck_when_changing_dict;
225         gboolean use_alternate;
226         gboolean use_both_dicts;
227
228         /* Display */
229         /* fonts */
230         gchar *textfont;
231         gchar *printfont;
232         gchar *boldfont;
233         gchar *normalfont;
234         gchar *smallfont;
235         gchar *titlefont;
236         gboolean use_different_print_font;
237         gboolean derive_from_normal_font;
238
239         /* custom colors */
240         ColorlabelPrefs custom_colorlabel[COLORLABELS];
241
242         /* program colors */
243         gulong color[COL_LAST_COLOR_INDEX];
244
245         /* image viewer */
246         gboolean display_img;
247         gboolean resize_img;
248         gboolean inline_img;
249
250         gboolean trans_hdr;
251         gint display_folder_unread;
252         gint ng_abbrev_len;
253
254         gboolean show_searchbar;
255         gboolean expand_thread;
256         gboolean swap_from;
257         gboolean use_addr_book;
258         gchar *date_format;
259         gboolean *msgview_date_format;
260
261         gboolean use_stripes_everywhere;
262         gboolean use_stripes_in_summaries; /* overrides if use_stripes_everywhere is set to TRUE */
263         gint stripes_color_offset;
264         gboolean enable_hscrollbar;
265         gboolean bold_unread;
266         gboolean next_on_delete;
267         gboolean enable_thread;
268         gboolean thread_by_subject;
269         gint thread_by_subject_max_age; /*!< Max. age of a thread which was threaded
270                                          *   by subject (days) */
271         FolderSortKey default_sort_key;
272         FolderSortType default_sort_type;
273
274         gchar *last_opened_folder;
275         gboolean goto_last_folder_on_startup;
276
277         ToolbarStyle toolbar_style;
278         gboolean toolbar_detachable;
279         gboolean show_statusbar;
280         gboolean show_col_headers;
281
282         gint folderview_vscrollbar_policy;
283
284         /* Filtering */
285         GSList *fltlist;
286
287         gint kill_score;
288         gint important_score;
289
290         /* Actions */
291         GSList *actions_list;
292
293         /* Summary columns visibility, position and size */
294         gboolean summary_col_visible[N_SUMMARY_COLS];
295         gint summary_col_pos[N_SUMMARY_COLS];
296         gint summary_col_size[N_SUMMARY_COLS];
297
298         gboolean folder_col_visible[N_FOLDER_COLS];
299         gint folder_col_pos[N_FOLDER_COLS];
300         gint folder_col_size[N_FOLDER_COLS];
301
302         /* Widget visibility, position and size */
303         gint folderwin_x;
304         gint folderwin_y;
305         gint folderview_width;
306         gint folderview_height;
307         gboolean folderview_visible;
308
309         gint summaryview_width;
310         gint summaryview_height;
311
312         gint main_msgwin_x;
313         gint main_msgwin_y;
314         gint msgview_width;
315         gint msgview_height;
316         gboolean msgview_visible;
317
318         gint mainview_x;
319         gint mainview_y;
320         gint mainview_width;
321         gint mainview_height;
322         gint mainwin_x;
323         gint mainwin_y;
324         gint mainwin_width;
325         gint mainwin_height;
326         gint mainwin_maximised;
327         gint mainwin_fullscreen;
328         gint mainwin_menubar;
329
330         gint msgwin_width;
331         gint msgwin_height;
332
333         gint mimeview_tree_height;
334         
335         gint sourcewin_width;
336         gint sourcewin_height;
337
338         gint compose_width;
339         gint compose_height;
340         gint compose_notebook_height;
341         gint compose_x;
342         gint compose_y;
343
344         /* Message */
345         gboolean enable_color;
346         gboolean enable_bgcolor;
347         gboolean recycle_quote_colors;
348         gboolean display_header_pane;
349         gboolean display_header;
350         gboolean display_xface;
351         gint line_space;
352         gboolean render_html;
353         gboolean invoke_plugin_on_html;
354         gboolean promote_html_part;
355         gboolean textview_cursor_visible;
356         gboolean enable_smooth_scroll;
357         gint scroll_step;
358         gboolean scroll_halfpage;
359         gboolean hide_quoted;
360         gboolean respect_flowed_format;
361         gboolean show_all_headers;
362
363         gboolean show_other_header;
364         GSList *disphdr_list;
365
366         gboolean attach_desc;
367
368         /* MIME viewer */
369         gchar *mime_textviewer;
370         gchar *mime_open_cmd;
371         gchar *attach_save_dir;
372         gchar *attach_load_dir;
373
374         GList *mime_open_cmd_history;
375         gboolean show_inline_attachments;
376
377         /* Addressbook */
378         gboolean addressbook_use_editaddress_dialog;
379         gint addressbook_hpaned_pos;
380         gint addressbook_vpaned_pos;
381         GList *addressbook_custom_attributes;
382
383         /* Interface */
384         LayoutType layout_mode;
385
386         gint statusbar_update_step;
387         gboolean emulate_emacs;
388
389         gboolean open_selected_on_folder_open;
390         gboolean open_selected_on_search_results;
391         gboolean open_selected_on_prevnext;
392         gboolean open_selected_on_deletemove;
393         gboolean open_selected_on_directional;
394         gboolean always_show_msg;
395
396         gboolean mark_as_read_on_new_window;
397         gboolean mark_as_read_delay;
398         gboolean immediate_exec;
399         SelectOnEntry select_on_entry;
400         gboolean show_tooltips;
401
402         EntryAction summary_select_prio[SUMMARY_OPEN_ACTIONS-1];
403
404         NextUnreadMsgDialogShow next_unread_msg_dialog;
405         SummaryFromShow summary_from_show;
406         gboolean add_address_by_click;
407         gchar *pixmap_theme_path;
408 #ifdef HAVE_SVG
409         gboolean enable_alpha_svg;
410         gboolean enable_pixmap_scaling;
411         gboolean pixmap_scaling_auto;
412         gint pixmap_scaling_ppi;
413 #endif
414         int hover_timeout; /* msecs mouse hover timeout */
415         gboolean ask_mark_all_read;
416         gboolean ask_override_colorlabel;
417         gboolean ask_apply_per_account_filtering_rules;
418         gint apply_per_account_filtering_rules;
419
420         /* Other */
421 #ifndef G_OS_WIN32
422         gchar *uri_cmd;
423 #else
424         gchar *gtk_theme;
425 #endif
426         gchar *ext_editor_cmd;
427         gboolean cmds_use_system_default;
428
429         gboolean cliplog;
430         guint loglength;
431         gboolean enable_log_standard;
432         gboolean enable_log_warning;
433         gboolean enable_log_error;
434         gboolean enable_log_status;
435
436         gboolean enable_filtering_debug;
437         gint filtering_debug_level;
438         gboolean enable_filtering_debug_inc;
439         gboolean enable_filtering_debug_manual;
440         gboolean enable_filtering_debug_folder_proc;
441         gboolean enable_filtering_debug_pre_proc;
442         gboolean enable_filtering_debug_post_proc;
443         gboolean filtering_debug_cliplog;
444         guint filtering_debug_loglength;
445
446         gboolean confirm_on_exit;
447         gboolean session_passwords;
448         gboolean clean_on_exit;
449         gboolean ask_on_clean;
450         gboolean warn_queued_on_exit;
451
452         gint io_timeout_secs;
453
454         gboolean gtk_can_change_accels;
455         
456         /* Memory cache*/
457         gint cache_max_mem_usage;
458         gint cache_min_keep_time;
459         
460         /* boolean for work offline 
461            stored here for use in inc.c */
462         gboolean work_offline;
463         
464         gint summary_quicksearch_type;
465         gint summary_quicksearch_sticky;
466         gint summary_quicksearch_recurse;
467         gint summary_quicksearch_dynamic;
468         gint summary_quicksearch_autorun;
469
470         GList *summary_quicksearch_history;
471         GList *summary_search_from_history;
472         GList *summary_search_to_history;
473         GList *summary_search_subject_history;
474         GList *summary_search_body_history;
475         GList *summary_search_adv_condition_history;
476         GList *message_search_history;
477         GList *compose_save_to_history;
478
479         gint filteringwin_width;
480         gint filteringwin_height;
481         gint filteringactionwin_width;
482         gint filteringactionwin_height;
483         gint matcherwin_width;
484         gint matcherwin_height;
485         gint templateswin_width;
486         gint templateswin_height;
487         gint actionswin_width;
488         gint actionswin_height;
489         gint actionsiodialog_width;
490         gint actionsiodialog_height;
491         gint tagswin_width;
492         gint tagswin_height;
493         gint addressbookwin_width;
494         gint addressbookwin_height;
495         gint addressbookeditpersonwin_width;
496         gint addressbookeditpersonwin_height;
497         gint addressbookeditgroupwin_width;
498         gint addressbookeditgroupwin_height;
499         gint pluginswin_width;
500         gint pluginswin_height;
501         gint prefswin_width;
502         gint prefswin_height;
503         gint folderitemwin_width;
504         gint folderitemwin_height;
505         gchar *zero_replacement;
506         gint editaccountwin_width;
507         gint editaccountwin_height;
508         gint accountswin_width;
509         gint accountswin_height;
510         gint logwin_width;
511         gint logwin_height;
512         gint filtering_debugwin_width;
513         gint filtering_debugwin_height;
514         gint folderselwin_width;
515         gint folderselwin_height;
516         gint addressaddwin_width;
517         gint addressaddwin_height;
518         gint addressbook_folderselwin_width;
519         gint addressbook_folderselwin_height;
520         gint aboutwin_width;
521         gint aboutwin_height;
522         gint addrgather_width;
523         gint addrgather_height;
524         gint news_subscribe_width;
525         gint news_subscribe_height;
526
527         gint warn_dnd;
528         gint broken_are_utf8;
529         gint skip_ssl_cert_check;
530         gint live_dangerously;
531         gint save_parts_readwrite;
532         gint never_send_retrcpt;
533         gint hide_quotes;
534         gboolean unsafe_ssl_certs;
535         gboolean real_time_sync;
536         
537         gchar *print_paper_type;
538         gint print_paper_orientation;
539         gint print_margin_top;
540         gint print_margin_bottom;
541         gint print_margin_left;
542         gint print_margin_right;
543   
544         gint print_use_color;
545         gint print_use_collate;
546         gint print_use_reverse;
547         gint print_use_duplex;
548         gint print_imgs;
549         gint print_previewwin_width;
550         gint print_previewwin_height;
551         
552         gboolean use_networkmanager;
553         gboolean use_shred;
554         gboolean two_line_vert;
555         gboolean inherit_folder_props;
556         gboolean flush_metadata;
557
558         gint nav_history_length;
559
560         gboolean folder_search_wildcard;
561         gboolean address_search_wildcard;
562
563         guint enable_avatars;
564
565 #ifndef PASSWORD_CRYPTO_OLD
566         gboolean use_master_passphrase;
567         gchar *master_passphrase;
568         gchar *master_passphrase_salt;
569         guint master_passphrase_pbkdf2_rounds;
570 #endif
571
572         /* Proxy */
573         gboolean use_proxy;
574         ProxyInfo proxy_info;
575 };
576
577 extern PrefsCommon prefs_common;
578
579 PrefsCommon *prefs_common_get_prefs(void);
580
581 GList *prefs_common_read_history_from_dir_with_defaults(const gchar *dirname, const gchar *history,
582                                                                                                                           GList *default_list);
583 void prefs_common_read_config   (void);
584 void prefs_common_write_config  (void);
585 void prefs_common_open          (void);
586 void pref_get_unescaped_pref(gchar *out, const gchar *in);
587 void pref_get_escaped_pref(gchar *out, const gchar *in);
588 void pref_set_textview_from_pref(GtkTextView *textview, const gchar *txt);
589 void pref_set_entry_from_pref(GtkEntry *entry, const gchar *txt);
590 gchar *pref_get_pref_from_textview(GtkTextView *textview);
591 gchar *pref_get_pref_from_entry(GtkEntry *entry);
592 const gchar *prefs_common_translated_header_name(const gchar *header_name);
593 const gchar *prefs_common_get_uri_cmd(void);
594 const gchar *prefs_common_get_ext_editor_cmd(void);
595
596 #define OPEN_SELECTED(when) (prefs_common.always_show_msg || prefs_common.when)
597
598 #define OPEN_SELECTED_ON_FOLDER_OPEN OPEN_SELECTED(open_selected_on_folder_open)
599 #define OPEN_SELECTED_ON_SEARCH_RESULTS OPEN_SELECTED(open_selected_on_search_results)
600 #define OPEN_SELECTED_ON_PREVNEXT OPEN_SELECTED(open_selected_on_prevnext)
601 #define OPEN_SELECTED_ON_DELETEMOVE OPEN_SELECTED(open_selected_on_deletemove)
602 #define OPEN_SELECTED_ON_DIRECTIONAL OPEN_SELECTED(open_selected_on_directional)
603
604 #endif /* __PREFS_COMMON_H__ */