src/prefs_common.h

   1 /*
   2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2020 the Claws Mail team and Hiroyuki Yamamoto
   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 swap_from;
 256         gboolean use_addr_book;
 257         gchar *date_format;
 258         gboolean *msgview_date_format;
 259
 260         gboolean use_stripes_everywhere;
 261         gboolean use_stripes_in_summaries; /* overrides if use_stripes_everywhere is set to TRUE */
 262         gint stripes_color_offset;
 263         gboolean enable_hscrollbar;
 264         gboolean bold_unread;
 265         gboolean next_on_delete;
 266         gboolean thread_by_subject;
 267         gint thread_by_subject_max_age; /*!< Max. age of a thread which was threaded
 268                                          *   by subject (days) */
 269         FolderSortKey default_sort_key;
 270         FolderSortType default_sort_type;
 271         gboolean folder_default_thread;
 272         gboolean folder_default_thread_collapsed;
 273         gboolean folder_default_hide_read_threads;
 274         gboolean folder_default_hide_read_msgs;
 275         gboolean folder_default_hide_del_msgs;
 276
 277         gchar *last_opened_folder;
 278         gboolean goto_last_folder_on_startup;
 279
 280         ToolbarStyle toolbar_style;
 281         gboolean toolbar_detachable;
 282         gboolean show_statusbar;
 283         gboolean show_col_headers;
 284
 285         gint folderview_vscrollbar_policy;
 286
 287         /* Filtering */
 288         GSList *fltlist;
 289
 290         gint kill_score;
 291         gint important_score;
 292
 293         /* Actions */
 294         GSList *actions_list;
 295
 296         /* Summary lock column headers */
 297         gboolean summary_col_lock;
 298
 299         /* Summary columns visibility, position and size */
 300         gboolean summary_col_visible[N_SUMMARY_COLS];
 301         gint summary_col_pos[N_SUMMARY_COLS];
 302         gint summary_col_size[N_SUMMARY_COLS];
 303
 304         gboolean folder_col_visible[N_FOLDER_COLS];
 305         gint folder_col_pos[N_FOLDER_COLS];
 306         gint folder_col_size[N_FOLDER_COLS];
 307
 308         /* Widget visibility, position and size */
 309         gint folderwin_x;
 310         gint folderwin_y;
 311         gint folderview_width;
 312         gint folderview_height;
 313         gboolean folderview_visible;
 314
 315         gint summaryview_width;
 316         gint summaryview_height;
 317
 318         gint main_msgwin_x;
 319         gint main_msgwin_y;
 320         gint msgview_width;
 321         gint msgview_height;
 322         gboolean msgview_visible;
 323
 324         gint mainview_x;
 325         gint mainview_y;
 326         gint mainview_width;
 327         gint mainview_height;
 328         gint mainwin_x;
 329         gint mainwin_y;
 330         gint mainwin_width;
 331         gint mainwin_height;
 332         gint mainwin_maximised;
 333         gint mainwin_fullscreen;
 334         gint mainwin_menubar;
 335
 336         gint msgwin_width;
 337         gint msgwin_height;
 338
 339         gint mimeview_tree_height;
 340
 341         gint sourcewin_width;
 342         gint sourcewin_height;
 343
 344         gint compose_width;
 345         gint compose_height;
 346         gint compose_notebook_height;
 347         gint compose_x;
 348         gint compose_y;
 349
 350         /* Message */
 351         gboolean enable_color;
 352         gboolean enable_bgcolor;
 353         gboolean recycle_quote_colors;
 354         gboolean display_header_pane;
 355         gboolean display_header;
 356         gboolean display_xface;
 357         gboolean save_xface;
 358         gint line_space;
 359         gboolean render_html;
 360         gboolean invoke_plugin_on_html;
 361         gboolean promote_html_part;
 362         gboolean textview_cursor_visible;
 363         gboolean enable_smooth_scroll;
 364         gint scroll_step;
 365         gboolean scroll_halfpage;
 366         gboolean hide_quoted;
 367         gboolean respect_flowed_format;
 368         gboolean show_all_headers;
 369
 370         gboolean show_other_header;
 371         GSList *disphdr_list;
 372
 373         gboolean attach_desc;
 374
 375         /* MIME viewer */
 376         gchar *mime_textviewer;
 377         gchar *mime_open_cmd;
 378         gchar *attach_save_dir;
 379         gchar *attach_load_dir;
 380
 381         GList *mime_open_cmd_history;
 382         gboolean show_inline_attachments;
 383
 384         /* Addressbook */
 385         gboolean addressbook_use_editaddress_dialog;
 386         gint addressbook_hpaned_pos;
 387         gint addressbook_vpaned_pos;
 388         GList *addressbook_custom_attributes;
 389
 390         /* Interface */
 391         LayoutType layout_mode;
 392
 393         gint statusbar_update_step;
 394         gboolean emulate_emacs;
 395
 396         gboolean open_selected_on_folder_open;
 397         gboolean open_selected_on_search_results;
 398         gboolean open_selected_on_prevnext;
 399         gboolean open_selected_on_deletemove;
 400         gboolean open_selected_on_directional;
 401         gboolean always_show_msg;
 402
 403         gboolean mark_as_read_on_new_window;
 404         gboolean mark_as_read_delay;
 405         gboolean immediate_exec;
 406         SelectOnEntry select_on_entry;
 407         gboolean show_tooltips;
 408
 409         EntryAction summary_select_prio[SUMMARY_OPEN_ACTIONS-1];
 410
 411         NextUnreadMsgDialogShow next_unread_msg_dialog;
 412         SummaryFromShow summary_from_show;
 413         gboolean add_address_by_click;
 414         gchar *pixmap_theme_path;
 415 #ifdef HAVE_SVG
 416         gboolean enable_alpha_svg;
 417         gboolean enable_pixmap_scaling;
 418         gboolean pixmap_scaling_auto;
 419         gint pixmap_scaling_ppi;
 420 #endif
 421         int hover_timeout; /* msecs mouse hover timeout */
 422         gboolean ask_mark_all_read;
 423         gboolean ask_override_colorlabel;
 424         gboolean ask_apply_per_account_filtering_rules;
 425         gint apply_per_account_filtering_rules;
 426
 427         /* Other */
 428 #ifndef G_OS_WIN32
 429         gchar *uri_cmd;
 430 #else
 431         gchar *gtk_theme;
 432 #endif
 433         gchar *ext_editor_cmd;
 434         gboolean cmds_use_system_default;
 435
 436         gboolean cliplog;
 437         guint loglength;
 438         gboolean enable_log_standard;
 439         gboolean enable_log_warning;
 440         gboolean enable_log_error;
 441         gboolean enable_log_status;
 442
 443         gboolean enable_filtering_debug;
 444         gint filtering_debug_level;
 445         gboolean enable_filtering_debug_inc;
 446         gboolean enable_filtering_debug_manual;
 447         gboolean enable_filtering_debug_folder_proc;
 448         gboolean enable_filtering_debug_pre_proc;
 449         gboolean enable_filtering_debug_post_proc;
 450         gboolean filtering_debug_cliplog;
 451         guint filtering_debug_loglength;
 452
 453         gboolean confirm_on_exit;
 454         gboolean session_passwords;
 455         gboolean clean_on_exit;
 456         gboolean ask_on_clean;
 457         gboolean warn_queued_on_exit;
 458
 459         gint io_timeout_secs;
 460
 461         gboolean gtk_can_change_accels;
 462         gboolean gtk_enable_accels;
 463
 464         /* Memory cache*/
 465         gint cache_max_mem_usage;
 466         gint cache_min_keep_time;
 467
 468         /* boolean for work offline
 469            stored here for use in inc.c */
 470         gboolean work_offline;
 471
 472         gint summary_quicksearch_type;
 473         gint summary_quicksearch_sticky;
 474         gint summary_quicksearch_recurse;
 475         gint summary_quicksearch_dynamic;
 476         gint summary_quicksearch_autorun;
 477
 478         GList *summary_quicksearch_history;
 479         GList *summary_search_from_history;
 480         GList *summary_search_to_history;
 481         GList *summary_search_subject_history;
 482         GList *summary_search_body_history;
 483         GList *summary_search_adv_condition_history;
 484         GList *message_search_history;
 485         GList *compose_save_to_history;
 486
 487         gint filteringwin_width;
 488         gint filteringwin_height;
 489         gint filteringactionwin_width;
 490         gint filteringactionwin_height;
 491         gint matcherwin_width;
 492         gint matcherwin_height;
 493         gint templateswin_width;
 494         gint templateswin_height;
 495         gint actionswin_width;
 496         gint actionswin_height;
 497         gint actionsiodialog_width;
 498         gint actionsiodialog_height;
 499         gint tagswin_width;
 500         gint tagswin_height;
 501         gint sslmanwin_width;
 502         gint sslmanwin_height;
 503         gint uriopenerwin_width;
 504         gint uriopenerwin_height;
 505         gint foldersortwin_width;
 506         gint foldersortwin_height;
 507         gint addressbookwin_width;
 508         gint addressbookwin_height;
 509         gint addressbookeditpersonwin_width;
 510         gint addressbookeditpersonwin_height;
 511         gint addressbookeditgroupwin_width;
 512         gint addressbookeditgroupwin_height;
 513         gint pluginswin_width;
 514         gint pluginswin_height;
 515         gint prefswin_width;
 516         gint prefswin_height;
 517         gint folderitemwin_width;
 518         gint folderitemwin_height;
 519         gchar *zero_replacement;
 520         gint editaccountwin_width;
 521         gint editaccountwin_height;
 522         gint accountswin_width;
 523         gint accountswin_height;
 524         gint logwin_width;
 525         gint logwin_height;
 526         gint filtering_debugwin_width;
 527         gint filtering_debugwin_height;
 528         gint folderselwin_width;
 529         gint folderselwin_height;
 530         gint addressaddwin_width;
 531         gint addressaddwin_height;
 532         gint addressbook_folderselwin_width;
 533         gint addressbook_folderselwin_height;
 534         gint aboutwin_width;
 535         gint aboutwin_height;
 536         gint addrgather_width;
 537         gint addrgather_height;
 538         gint news_subscribe_width;
 539         gint news_subscribe_height;
 540
 541     gint imap_scan_tree_recurs_limit;
 542         gint warn_dnd;
 543         gint broken_are_utf8;
 544         gint skip_ssl_cert_check;
 545         gint live_dangerously;
 546         gint save_parts_readwrite;
 547         gint never_send_retrcpt;
 548         gint hide_quotes;
 549         gboolean unsafe_ssl_certs;
 550         gboolean real_time_sync;
 551
 552         gchar *print_paper_type;
 553         gint print_paper_orientation;
 554         gint print_margin_top;
 555         gint print_margin_bottom;
 556         gint print_margin_left;
 557         gint print_margin_right;
 558
 559         gint print_use_color;
 560         gint print_use_collate;
 561         gint print_use_reverse;
 562         gint print_use_duplex;
 563         gint print_imgs;
 564         gint print_previewwin_width;
 565         gint print_previewwin_height;
 566
 567         gboolean use_networkmanager;
 568         gboolean use_shred;
 569         gboolean two_line_vert;
 570         gboolean inherit_folder_props;
 571         gboolean flush_metadata;
 572
 573         gint nav_history_length;
 574
 575         gboolean folder_search_wildcard;
 576         gboolean address_search_wildcard;
 577
 578         guint enable_avatars;
 579
 580 #ifndef PASSWORD_CRYPTO_OLD
 581         gboolean use_master_passphrase;
 582         gchar *master_passphrase;
 583         gchar *master_passphrase_salt;
 584         guint master_passphrase_pbkdf2_rounds;
 585 #endif
 586
 587         /* Proxy */
 588         gboolean use_proxy;
 589         ProxyInfo proxy_info;
 590 };
 591
 592 extern PrefsCommon prefs_common;
 593
 594 PrefsCommon *prefs_common_get_prefs(void);
 595
 596 GList *prefs_common_read_history_from_dir_with_defaults(const gchar *dirname, const gchar *history,
 597                                                                                                                           GList *default_list);
 598 void prefs_common_read_config   (void);
 599 void prefs_common_write_config  (void);
 600 void prefs_common_open          (void);
 601 void pref_get_unescaped_pref(gchar *out, const gchar *in);
 602 void pref_get_escaped_pref(gchar *out, const gchar *in);
 603 void pref_set_textview_from_pref(GtkTextView *textview, const gchar *txt);
 604 void pref_set_entry_from_pref(GtkEntry *entry, const gchar *txt);
 605 gchar *pref_get_pref_from_textview(GtkTextView *textview);
 606 gchar *pref_get_pref_from_entry(GtkEntry *entry);
 607 const gchar *prefs_common_translated_header_name(const gchar *header_name);
 608 const gchar *prefs_common_get_uri_cmd(void);
 609 const gchar *prefs_common_get_ext_editor_cmd(void);
 610
 611 #define OPEN_SELECTED(when) (prefs_common.always_show_msg || prefs_common.when)
 612
 613 #define OPEN_SELECTED_ON_FOLDER_OPEN OPEN_SELECTED(open_selected_on_folder_open)
 614 #define OPEN_SELECTED_ON_SEARCH_RESULTS OPEN_SELECTED(open_selected_on_search_results)
 615 #define OPEN_SELECTED_ON_PREVNEXT OPEN_SELECTED(open_selected_on_prevnext)
 616 #define OPEN_SELECTED_ON_DELETEMOVE OPEN_SELECTED(open_selected_on_deletemove)
 617 #define OPEN_SELECTED_ON_DIRECTIONAL OPEN_SELECTED(open_selected_on_directional)
 618
 619 #endif /* __PREFS_COMMON_H__ */