Add more granular options on when to open a selected message.
[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 2
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_MARKED,
78         ACTION_NEW,
79         ACTION_UNREAD,
80         ACTION_LAST_OPENED,
81         ACTION_LAST_LIST,
82         ACTION_NOTHING,
83         ACTION_FIRST_LIST
84 } EntryAction;
85
86 typedef enum
87 {
88         NEXTUNREADMSGDIALOG_ALWAYS,
89         NEXTUNREADMSGDIALOG_ASSUME_YES,
90         NEXTUNREADMSGDIALOG_ASSUME_NO
91 } NextUnreadMsgDialogShow;
92
93 typedef enum
94 {
95         SHOW_NAME,
96         SHOW_ADDR,
97         SHOW_BOTH
98 } SummaryFromShow;
99
100 typedef enum
101 {
102         AVATARS_DISABLE = 0,
103         AVATARS_ENABLE_CAPTURE = 1,
104         AVATARS_ENABLE_RENDER = 2,
105         AVATARS_ENABLE_BOTH = 3
106 } EnableAvatars;
107
108 struct _PrefsCommon
109 {
110         gint config_version;
111
112         /* Receive */
113         gboolean use_extinc;
114         gchar *extinc_cmd;
115         gboolean scan_all_after_inc;
116         gboolean autochk_newmail;
117         gint autochk_itv;
118         gboolean chk_on_startup;
119         gboolean open_inbox_on_inc;
120         gboolean newmail_notify_auto;
121         gboolean newmail_notify_manu;
122         gchar   *newmail_notify_cmd;
123         RecvDialogMode recv_dialog_mode;
124         gint receivewin_width;
125         gint receivewin_height;
126         gboolean close_recv_dialog;
127         gboolean no_recv_err_panel;
128
129         /* Send */
130         gboolean savemsg;
131         gboolean confirm_send_queued_messages;
132         gboolean send_dialog_invisible;
133         gint sendwin_width;
134         gint sendwin_height;
135         gchar *outgoing_charset;
136         TransferEncodingMethod encoding_method;
137         gboolean outgoing_fallback_to_ascii;
138         gboolean rewrite_first_from;
139         gboolean warn_empty_subj;
140         gint warn_sending_many_recipients_num;
141         gboolean hide_timezone;
142         gboolean allow_jisx0201_kana;
143
144         /* Compose */
145         gint undolevels;
146         gint linewrap_len;
147         gboolean linewrap_quote;
148         gboolean linewrap_pastes;
149         gboolean primary_paste_unselects;
150         gboolean autowrap;
151         gboolean auto_indent;
152         gboolean auto_exteditor;
153         gboolean reply_account_autosel;
154         gboolean default_reply_list;
155         gboolean forward_account_autosel;
156         gboolean reedit_account_autosel;
157         gboolean show_ruler;
158         gboolean autosave;
159         gint autosave_length;
160         gboolean autosave_encrypted;
161         gboolean warn_large_insert;
162         gint warn_large_insert_size;
163         gboolean compose_no_markup;
164         ComposeDndInsertOrAttach compose_dnd_mode;
165         gboolean compose_with_format;
166         gchar *compose_subject_format;
167         gchar *compose_body_format;
168         gboolean show_compose_margin;
169         gboolean type_any_header;
170
171         /* Quote */
172         gboolean reply_with_quote;
173         gchar *quotemark;
174         gchar *quotefmt;
175         gchar *fw_quotemark;
176         gchar *fw_quotefmt;
177         gboolean forward_as_attachment;
178         gboolean redirect_keep_from;
179         gchar *quote_chars;
180         
181         gboolean enable_aspell;
182         gchar *dictionary;
183         gchar *alt_dictionary;
184         gulong misspelled_col;
185         gboolean check_while_typing;
186         gboolean recheck_when_changing_dict;
187         gboolean use_alternate;
188         gboolean use_both_dicts;
189
190         /* Display */
191         /* fonts */
192         gchar *widgetfont;
193         gchar *textfont;
194         gchar *printfont;
195         gchar *boldfont;
196         gchar *normalfont;
197         gchar *smallfont;
198         gchar *titlefont;
199         gboolean use_different_print_font;
200         gboolean derive_from_normal_font;
201
202         /* custom colors */
203         ColorlabelPrefs custom_colorlabel[COLORLABELS];
204
205         /* image viewer */
206         gboolean display_img;
207         gboolean resize_img;
208         gboolean inline_img;
209
210         gboolean trans_hdr;
211         gint display_folder_unread;
212         gint ng_abbrev_len;
213
214         gboolean show_searchbar;
215         gboolean expand_thread;
216         gboolean swap_from;
217         gboolean use_addr_book;
218         gchar *date_format;
219         gboolean *msgview_date_format;
220
221         gboolean use_stripes_everywhere;
222         gboolean use_stripes_in_summaries; /* overrides if use_stripes_everywhere is set to TRUE */
223         gint stripes_color_offset;
224         gboolean enable_hscrollbar;
225         gboolean bold_unread;
226         gboolean next_on_delete;
227         gboolean enable_thread;
228         gboolean thread_by_subject;
229         gint thread_by_subject_max_age; /*!< Max. age of a thread which was threaded
230                                          *   by subject (days) */
231         FolderSortKey default_sort_key;
232         FolderSortType default_sort_type;
233
234         gchar *last_opened_folder;
235         gboolean goto_last_folder_on_startup;
236
237         ToolbarStyle toolbar_style;
238         gboolean toolbar_detachable;
239         gboolean show_statusbar;
240         gboolean show_col_headers;
241
242         gint folderview_vscrollbar_policy;
243
244         /* Filtering */
245         GSList *fltlist;
246
247         gint kill_score;
248         gint important_score;
249
250         /* Actions */
251         GSList *actions_list;
252
253         /* Summary columns visibility, position and size */
254         gboolean summary_col_visible[N_SUMMARY_COLS];
255         gint summary_col_pos[N_SUMMARY_COLS];
256         gint summary_col_size[N_SUMMARY_COLS];
257
258         gboolean folder_col_visible[N_FOLDER_COLS];
259         gint folder_col_pos[N_FOLDER_COLS];
260         gint folder_col_size[N_FOLDER_COLS];
261
262         /* Widget visibility, position and size */
263         gint folderwin_x;
264         gint folderwin_y;
265         gint folderview_width;
266         gint folderview_height;
267         gboolean folderview_visible;
268
269         gint summaryview_width;
270         gint summaryview_height;
271
272         gint main_msgwin_x;
273         gint main_msgwin_y;
274         gint msgview_width;
275         gint msgview_height;
276         gboolean msgview_visible;
277
278         gint mainview_x;
279         gint mainview_y;
280         gint mainview_width;
281         gint mainview_height;
282         gint mainwin_x;
283         gint mainwin_y;
284         gint mainwin_width;
285         gint mainwin_height;
286         gint mainwin_maximised;
287         gint mainwin_fullscreen;
288         gint mainwin_menubar;
289
290         gint msgwin_width;
291         gint msgwin_height;
292
293         gint mimeview_tree_height;
294         
295         gint sourcewin_width;
296         gint sourcewin_height;
297
298         gint compose_width;
299         gint compose_height;
300         gint compose_notebook_height;
301         gint compose_x;
302         gint compose_y;
303
304         /* Message */
305         gboolean enable_color;
306         gboolean enable_bgcolor;
307         gulong quote_level1_col;
308         gulong quote_level2_col;
309         gulong quote_level3_col;
310         gulong quote_level1_bgcol;
311         gulong quote_level2_bgcol;
312         gulong quote_level3_bgcol;
313         gulong uri_col;
314         gulong tgt_folder_col;
315         gulong signature_col;
316         gulong emphasis_col;
317         gboolean recycle_quote_colors;
318         gulong default_header_bgcolor;
319         gulong default_header_color;
320         gulong tags_bgcolor;
321         gulong tags_color;
322         gulong qs_active_bgcolor;
323         gulong qs_active_color;
324         gulong qs_error_bgcolor;
325         gulong qs_error_color;
326         gboolean display_header_pane;
327         gboolean display_header;
328         gboolean display_xface;
329         gint line_space;
330         gboolean render_html;
331         gboolean invoke_plugin_on_html;
332         gboolean promote_html_part;
333         gboolean textview_cursor_visible;
334         gboolean enable_smooth_scroll;
335         gint scroll_step;
336         gboolean scroll_halfpage;
337         gboolean hide_quoted;
338         gboolean respect_flowed_format;
339         gboolean show_all_headers;
340
341         gboolean show_other_header;
342         GSList *disphdr_list;
343
344         gboolean attach_desc;
345
346         /* MIME viewer */
347         gchar *mime_textviewer;
348         gchar *mime_open_cmd;
349         gchar *attach_save_dir;
350         gchar *attach_load_dir;
351
352         GList *mime_open_cmd_history;
353         gboolean show_inline_attachments;
354
355         /* Addressbook */
356         gboolean addressbook_use_editaddress_dialog;
357         gint addressbook_hpaned_pos;
358         gint addressbook_vpaned_pos;
359         GList *addressbook_custom_attributes;
360
361         /* Interface */
362         gboolean layout_mode;
363
364         gint statusbar_update_step;
365         gboolean emulate_emacs;
366
367         gboolean open_selected_on_folder_open;
368         gboolean open_selected_on_search_results;
369         gboolean open_selected_on_prevnext;
370         gboolean open_selected_on_deletemove;
371         gboolean open_selected_on_directional;
372         gboolean always_show_msg;
373
374         gboolean mark_as_read_on_new_window;
375         gboolean mark_as_read_delay;
376         gboolean immediate_exec;
377         SelectOnEntry select_on_entry;
378         gboolean show_tooltips;
379
380         EntryAction summary_select_prio[SUMMARY_OPEN_ACTIONS-1];
381
382         NextUnreadMsgDialogShow next_unread_msg_dialog;
383         SummaryFromShow summary_from_show;
384         gboolean add_address_by_click;
385         gchar *pixmap_theme_path;
386 #ifdef HAVE_SVG
387         gboolean enable_alpha_svg;
388         gboolean enable_pixmap_scaling;
389         gboolean pixmap_scaling_auto;
390         gint pixmap_scaling_ppi;
391 #endif
392         int hover_timeout; /* msecs mouse hover timeout */
393         gboolean ask_mark_all_read;
394         gboolean ask_apply_per_account_filtering_rules;
395         gint apply_per_account_filtering_rules;
396
397         /* Other */
398 #ifndef G_OS_WIN32
399         gchar *uri_cmd;
400 #else
401         gchar *gtk_theme;
402 #endif
403         gchar *ext_editor_cmd;
404         gboolean cmds_use_system_default;
405
406         gboolean cliplog;
407         guint loglength;
408         gboolean enable_log_standard;
409         gboolean enable_log_warning;
410         gboolean enable_log_error;
411         gboolean enable_log_status;
412
413         gulong log_msg_color;
414         gulong log_warn_color;
415         gulong log_error_color;
416         gulong log_in_color;
417         gulong log_out_color;
418         gulong log_status_ok_color;
419         gulong log_status_nok_color;
420         gulong log_status_skip_color;
421
422         gboolean enable_filtering_debug;
423         gint filtering_debug_level;
424         gboolean enable_filtering_debug_inc;
425         gboolean enable_filtering_debug_manual;
426         gboolean enable_filtering_debug_folder_proc;
427         gboolean enable_filtering_debug_pre_proc;
428         gboolean enable_filtering_debug_post_proc;
429         gboolean filtering_debug_cliplog;
430         guint filtering_debug_loglength;
431
432         gboolean confirm_on_exit;
433         gboolean session_passwords;
434         gboolean clean_on_exit;
435         gboolean ask_on_clean;
436         gboolean warn_queued_on_exit;
437
438         gint io_timeout_secs;
439
440         gboolean gtk_can_change_accels;
441         
442         /* Memory cache*/
443         gint cache_max_mem_usage;
444         gint cache_min_keep_time;
445         
446         /* boolean for work offline 
447            stored here for use in inc.c */
448         gboolean work_offline;
449         
450         gint summary_quicksearch_type;
451         gint summary_quicksearch_sticky;
452         gint summary_quicksearch_recurse;
453         gint summary_quicksearch_dynamic;
454         gint summary_quicksearch_autorun;
455         gulong color_new;
456         
457         GList *summary_quicksearch_history;
458         GList *summary_search_from_history;
459         GList *summary_search_to_history;
460         GList *summary_search_subject_history;
461         GList *summary_search_body_history;
462         GList *summary_search_adv_condition_history;
463         GList *message_search_history;
464         GList *compose_save_to_history;
465
466         gint filteringwin_width;
467         gint filteringwin_height;
468         gint filteringactionwin_width;
469         gint filteringactionwin_height;
470         gint matcherwin_width;
471         gint matcherwin_height;
472         gint templateswin_width;
473         gint templateswin_height;
474         gint actionswin_width;
475         gint actionswin_height;
476         gint tagswin_width;
477         gint tagswin_height;
478         gint addressbookwin_width;
479         gint addressbookwin_height;
480         gint addressbookeditpersonwin_width;
481         gint addressbookeditpersonwin_height;
482         gint addressbookeditgroupwin_width;
483         gint addressbookeditgroupwin_height;
484         gint pluginswin_width;
485         gint pluginswin_height;
486         gint prefswin_width;
487         gint prefswin_height;
488         gint folderitemwin_width;
489         gint folderitemwin_height;
490         gchar *zero_replacement;
491         gint editaccountwin_width;
492         gint editaccountwin_height;
493         gint accountswin_width;
494         gint accountswin_height;
495         gint logwin_width;
496         gint logwin_height;
497         gint filtering_debugwin_width;
498         gint filtering_debugwin_height;
499         gint folderselwin_width;
500         gint folderselwin_height;
501         gint addressaddwin_width;
502         gint addressaddwin_height;
503         gint addressbook_folderselwin_width;
504         gint addressbook_folderselwin_height;
505         gint aboutwin_width;
506         gint aboutwin_height;
507         gint addrgather_width;
508         gint addrgather_height;
509         gint news_subscribe_width;
510         gint news_subscribe_height;
511
512         gint warn_dnd;
513         gint broken_are_utf8;
514         gint skip_ssl_cert_check;
515         gint live_dangerously;
516         gint save_parts_readwrite;
517         gint never_send_retrcpt;
518         gint hide_quotes;
519         gboolean unsafe_ssl_certs;
520         gboolean real_time_sync;
521         
522         gchar *print_paper_type;
523         gint print_paper_orientation;
524         gint print_margin_top;
525         gint print_margin_bottom;
526         gint print_margin_left;
527         gint print_margin_right;
528   
529         gint print_use_color;
530         gint print_use_collate;
531         gint print_use_reverse;
532         gint print_use_duplex;
533         gint print_imgs;
534         gint print_previewwin_width;
535         gint print_previewwin_height;
536         
537         gboolean use_networkmanager;
538         gboolean use_shred;
539         gboolean two_line_vert;
540         gboolean inherit_folder_props;
541         gboolean flush_metadata;
542
543         gint nav_history_length;
544
545         gulong diff_added_color;
546         gulong diff_deleted_color;
547         gulong diff_hunk_color;
548         
549         gboolean folder_search_wildcard;
550         gboolean address_search_wildcard;
551
552         guint enable_avatars;
553
554 #ifndef PASSWORD_CRYPTO_OLD
555         gboolean use_master_passphrase;
556         gchar *master_passphrase;
557         gchar *master_passphrase_salt;
558         guint master_passphrase_pbkdf2_rounds;
559 #endif
560 };
561
562 extern PrefsCommon prefs_common;
563
564 PrefsCommon *prefs_common_get_prefs(void);
565
566 GList *prefs_common_read_history_from_dir_with_defaults(const gchar *dirname, const gchar *history,
567                                                                                                                           GList *default_list);
568 void prefs_common_read_config   (void);
569 void prefs_common_write_config  (void);
570 void prefs_common_open          (void);
571 void pref_get_unescaped_pref(gchar *out, const gchar *in);
572 void pref_get_escaped_pref(gchar *out, const gchar *in);
573 void pref_set_textview_from_pref(GtkTextView *textview, const gchar *txt);
574 void pref_set_entry_from_pref(GtkEntry *entry, const gchar *txt);
575 gchar *pref_get_pref_from_textview(GtkTextView *textview);
576 gchar *pref_get_pref_from_entry(GtkEntry *entry);
577 const gchar *prefs_common_translated_header_name(const gchar *header_name);
578 const gchar *prefs_common_get_uri_cmd(void);
579 const gchar *prefs_common_get_ext_editor_cmd(void);
580
581 #define OPEN_SELECTED(when) (prefs_common.always_show_msg || prefs_common.when)
582
583 #define OPEN_SELECTED_ON_FOLDER_OPEN OPEN_SELECTED(open_selected_on_folder_open)
584 #define OPEN_SELECTED_ON_SEARCH_RESULTS OPEN_SELECTED(open_selected_on_search_results)
585 #define OPEN_SELECTED_ON_PREVNEXT OPEN_SELECTED(open_selected_on_prevnext)
586 #define OPEN_SELECTED_ON_DELETEMOVE OPEN_SELECTED(open_selected_on_deletemove)
587 #define OPEN_SELECTED_ON_DIRECTIONAL OPEN_SELECTED(open_selected_on_directional)
588
589 #endif /* __PREFS_COMMON_H__ */