src/prefs_common.h

   1 /*
   2  * Claws Mail -- a GTK based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2022 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 "claws-features.h"
  24 #endif
  25
  26 #include <glib.h>
  27
  28 #include "mainwindow.h"
  29 #include "summaryview.h"
  30 #include "folderview.h"
  31 #include "codeconv.h"
  32 #include "textview.h"
  33 #include "procmime.h"
  34 #include "prefs_msg_colors.h"
  35 #include "prefs_summary_open.h"
  36
  37 #define CLAWS_CONFIG_VERSION 4
  38
  39 typedef struct _PrefsCommon     PrefsCommon;
  40
  41 typedef enum {
  42         RECV_DIALOG_ALWAYS,
  43         RECV_DIALOG_MANUAL,
  44         RECV_DIALOG_NEVER
  45 } RecvDialogMode;
  46
  47 typedef enum {
  48         COMPOSE_DND_ASK,
  49         COMPOSE_DND_INSERT,
  50         COMPOSE_DND_ATTACH
  51 } ComposeDndInsertOrAttach;
  52
  53 typedef enum {
  54         CTE_AUTO,
  55         CTE_BASE64,
  56         CTE_QUOTED_PRINTABLE,
  57         CTE_8BIT
  58 } TransferEncodingMethod;
  59
  60 typedef enum
  61 {
  62 /* U = unread, N = new, M = marked */
  63         SELECTONENTRY_NOTHING,
  64         SELECTONENTRY_UNM,
  65         SELECTONENTRY_UMN,
  66         SELECTONENTRY_NUM,
  67         SELECTONENTRY_NMU,
  68         SELECTONENTRY_MNU,
  69         SELECTONENTRY_MUN,
  70         SELECTONENTRY_LAST
  71 } SelectOnEntry;
  72
  73 typedef enum
  74 {
  75         ACTION_UNSET = 0, /* for backward compatibility */
  76         ACTION_OLDEST_MARKED,
  77         ACTION_OLDEST_NEW,
  78         ACTION_OLDEST_UNREAD,
  79         ACTION_LAST_OPENED,
  80         ACTION_NEWEST_LIST,
  81         ACTION_NOTHING,
  82         ACTION_OLDEST_LIST,
  83         ACTION_NEWEST_MARKED,
  84         ACTION_NEWEST_NEW,
  85         ACTION_NEWEST_UNREAD
  86 } EntryAction;
  87
  88 typedef enum
  89 {
  90         NEXTUNREADMSGDIALOG_ALWAYS,
  91         NEXTUNREADMSGDIALOG_ASSUME_YES,
  92         NEXTUNREADMSGDIALOG_ASSUME_NO
  93 } NextUnreadMsgDialogShow;
  94
  95 typedef enum
  96 {
  97         SHOW_NAME,
  98         SHOW_ADDR,
  99         SHOW_BOTH
 100 } SummaryFromShow;
 101
 102 typedef enum
 103 {
 104         AVATARS_DISABLE = 0,
 105         AVATARS_ENABLE_CAPTURE = 1,
 106         AVATARS_ENABLE_RENDER = 2,
 107         AVATARS_ENABLE_BOTH = 3
 108 } EnableAvatars;
 109
 110 typedef enum
 111 {
 112         COL_MISSPELLED,
 113         COL_QUOTE_LEVEL1,
 114         COL_QUOTE_LEVEL2,
 115         COL_QUOTE_LEVEL3,
 116         COL_QUOTE_LEVEL1_BG,
 117         COL_QUOTE_LEVEL2_BG,
 118         COL_QUOTE_LEVEL3_BG,
 119         COL_URI,
 120         COL_TGT_FOLDER,
 121         COL_SIGNATURE,
 122         COL_EMPHASIS,
 123         COL_DEFAULT_HEADER,
 124         COL_DEFAULT_HEADER_BG,
 125         COL_TAGS,
 126         COL_TAGS_BG,
 127         COL_QS_ACTIVE,
 128         COL_QS_ACTIVE_BG,
 129         COL_QS_ERROR,
 130         COL_QS_ERROR_BG,
 131         COL_LOG_MSG,
 132         COL_LOG_WARN,
 133         COL_LOG_ERROR,
 134         COL_LOG_IN,
 135         COL_LOG_OUT,
 136         COL_LOG_STATUS_OK,
 137         COL_LOG_STATUS_NOK,
 138         COL_LOG_STATUS_SKIP,
 139         COL_NEW,
 140         COL_DIFF_ADDED,
 141         COL_DIFF_DELETED,
 142         COL_DIFF_HUNK,
 143         COL_LAST_COLOR_INDEX
 144 } ColorIndex;
 145
 146 struct _PrefsCommon
 147 {
 148         gint config_version;
 149
 150         /* Receive */
 151         gboolean use_extinc;
 152         gchar *extinc_cmd;
 153         gboolean scan_all_after_inc;
 154         gboolean autochk_newmail;
 155         gint autochk_itv;
 156         gboolean chk_on_startup;
 157         gboolean open_inbox_on_inc;
 158         gboolean newmail_notify_auto;
 159         gboolean newmail_notify_manu;
 160         gchar   *newmail_notify_cmd;
 161         RecvDialogMode recv_dialog_mode;
 162         gint receivewin_width;
 163         gint receivewin_height;
 164         gboolean close_recv_dialog;
 165         gboolean no_recv_err_panel;
 166
 167         /* Send */
 168         gboolean savemsg;
 169         gboolean confirm_send_queued_messages;
 170         gboolean send_dialog_invisible;
 171         gint sendwin_width;
 172         gint sendwin_height;
 173         gchar *outgoing_charset;
 174         TransferEncodingMethod encoding_method;
 175         gboolean outgoing_fallback_to_ascii;
 176         gboolean rewrite_first_from;
 177         gboolean warn_empty_subj;
 178         gint warn_sending_many_recipients_num;
 179         gboolean hide_timezone;
 180         gboolean allow_jisx0201_kana;
 181
 182         /* Compose */
 183         gint undolevels;
 184         gint linewrap_len;
 185         gboolean linewrap_quote;
 186         gboolean linewrap_pastes;
 187         gboolean primary_paste_unselects;
 188         gboolean autowrap;
 189         gboolean auto_indent;
 190         gboolean auto_exteditor;
 191         gboolean reply_account_autosel;
 192         gboolean default_reply_list;
 193         gboolean forward_account_autosel;
 194         gboolean reedit_account_autosel;
 195         gboolean show_ruler;
 196         gboolean autosave;
 197         gint autosave_length;
 198         gboolean autosave_encrypted;
 199         gboolean warn_large_insert;
 200         gint warn_large_insert_size;
 201         gboolean compose_no_markup;
 202         ComposeDndInsertOrAttach compose_dnd_mode;
 203         gboolean compose_with_format;
 204         gchar *compose_subject_format;
 205         gchar *compose_body_format;
 206         gboolean show_compose_margin;
 207         gboolean type_any_header;
 208
 209         /* Quote */
 210         gboolean reply_with_quote;
 211         gchar *quotemark;
 212         gchar *quotefmt;
 213         gchar *fw_quotemark;
 214         gchar *fw_quotefmt;
 215         gboolean forward_as_attachment;
 216         gboolean redirect_keep_from;
 217         gchar *quote_chars;
 218
 219         gboolean enable_aspell;
 220         gchar *dictionary;
 221         gchar *alt_dictionary;
 222         gboolean check_while_typing;
 223         gboolean recheck_when_changing_dict;
 224         gboolean use_alternate;
 225         gboolean use_both_dicts;
 226
 227         /* Display */
 228         /* fonts */
 229         gchar *textfont;
 230         gchar *printfont;
 231         gchar *boldfont;
 232         gchar *normalfont;
 233         gchar *smallfont;
 234         gchar *titlefont;
 235         gboolean use_different_print_font;
 236         gboolean derive_from_normal_font;
 237
 238         /* custom colors */
 239         ColorlabelPrefs custom_colorlabel[COLORLABELS];
 240
 241         /* program colors */
 242         GdkRGBA color[COL_LAST_COLOR_INDEX];
 243
 244         /* image viewer */
 245         gboolean display_img;
 246         gboolean resize_img;
 247         gboolean inline_img;
 248         gboolean fit_img_height;
 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 show_statusbar;
 282         gboolean show_col_headers;
 283
 284         gint folderview_vscrollbar_policy;
 285
 286         /* Filtering */
 287         GSList *fltlist;
 288
 289         gint kill_score;
 290         gint important_score;
 291
 292         /* Actions */
 293         GSList *actions_list;
 294
 295         /* Summary lock column headers */
 296         gboolean summary_col_lock;
 297
 298         /* Summary columns visibility, position and size */
 299         gboolean summary_col_visible[N_SUMMARY_COLS];
 300         gint summary_col_pos[N_SUMMARY_COLS];
 301         gint summary_col_size[N_SUMMARY_COLS];
 302
 303         gboolean folder_col_visible[N_FOLDER_COLS];
 304         gint folder_col_pos[N_FOLDER_COLS];
 305         gint folder_col_size[N_FOLDER_COLS];
 306
 307         /* Widget visibility, position and size */
 308         gint folderwin_x;
 309         gint folderwin_y;
 310         gint folderview_width;
 311         gint folderview_height;
 312         gboolean folderview_visible;
 313
 314         gint summaryview_width;
 315         gint summaryview_height;
 316
 317         gint main_msgwin_x;
 318         gint main_msgwin_y;
 319         gint msgview_width;
 320         gint msgview_height;
 321         gboolean msgview_visible;
 322
 323         gint mainview_x;
 324         gint mainview_y;
 325         gint mainview_width;
 326         gint mainview_height;
 327         gint mainwin_x;
 328         gint mainwin_y;
 329         gint mainwin_width;
 330         gint mainwin_height;
 331         gint mainwin_maximised;
 332         gint mainwin_fullscreen;
 333         gint mainwin_menubar;
 334
 335         gint msgwin_width;
 336         gint msgwin_height;
 337
 338         gint mimeview_tree_height;
 339
 340         gint sourcewin_width;
 341         gint sourcewin_height;
 342
 343         gint compose_width;
 344         gint compose_height;
 345         gint compose_notebook_height;
 346         gint compose_x;
 347         gint compose_y;
 348
 349         /* Message */
 350         gboolean enable_color;
 351         gboolean enable_bgcolor;
 352         gboolean recycle_quote_colors;
 353         gboolean display_header_pane;
 354         gboolean display_header;
 355         gboolean display_xface;
 356         gboolean save_xface;
 357         gint line_space;
 358         gboolean render_html;
 359         gboolean invoke_plugin_on_html;
 360         gboolean promote_html_part;
 361         gboolean textview_cursor_visible;
 362         gboolean enable_smooth_scroll;
 363         gint scroll_step;
 364         gboolean scroll_halfpage;
 365         gboolean hide_quoted;
 366         gboolean respect_flowed_format;
 367         gboolean show_all_headers;
 368
 369         gboolean show_other_header;
 370         GSList *disphdr_list;
 371
 372         gboolean attach_desc;
 373
 374         /* MIME viewer */
 375         gchar *mime_textviewer;
 376         gchar *mime_open_cmd;
 377         gchar *attach_save_dir;
 378         gchar *attach_load_dir;
 379
 380         GList *mime_open_cmd_history;
 381         gboolean show_inline_attachments;
 382
 383         /* Addressbook */
 384         gboolean addressbook_use_editaddress_dialog;
 385         gint addressbook_hpaned_pos;
 386         gint addressbook_vpaned_pos;
 387         GList *addressbook_custom_attributes;
 388
 389         /* Interface */
 390         LayoutType layout_mode;
 391
 392         gint statusbar_update_step;
 393         gboolean emulate_emacs;
 394
 395         gboolean open_selected_on_folder_open;
 396         gboolean open_selected_on_search_results;
 397         gboolean open_selected_on_prevnext;
 398         gboolean open_selected_on_deletemove;
 399         gboolean open_selected_on_directional;
 400         gboolean always_show_msg;
 401
 402         gboolean mark_as_read_on_new_window;
 403         gboolean mark_as_read_delay;
 404         gboolean immediate_exec;
 405         SelectOnEntry select_on_entry;
 406         gboolean show_tooltips;
 407
 408         EntryAction summary_select_prio[SUMMARY_OPEN_ACTIONS-1];
 409
 410         NextUnreadMsgDialogShow next_unread_msg_dialog;
 411         SummaryFromShow summary_from_show;
 412         gboolean add_address_by_click;
 413         gchar *pixmap_theme_path;
 414 #ifdef HAVE_SVG
 415         gboolean enable_alpha_svg;
 416         gboolean enable_pixmap_scaling;
 417         gboolean pixmap_scaling_auto;
 418         gint pixmap_scaling_ppi;
 419 #endif
 420         int hover_timeout; /* msecs mouse hover timeout */
 421         gboolean ask_mark_all_read;
 422         gboolean run_processingrules_before_mark_all;
 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_enable_accels;
 462
 463         /* Memory cache*/
 464         gint cache_max_mem_usage;
 465         gint cache_min_keep_time;
 466
 467         /* boolean for work offline
 468            stored here for use in inc.c */
 469         gboolean work_offline;
 470
 471         gint summary_quicksearch_type;
 472         gint summary_quicksearch_sticky;
 473         gint summary_quicksearch_recurse;
 474         gint summary_quicksearch_dynamic;
 475         gint summary_quicksearch_autorun;
 476
 477         GList *summary_quicksearch_history;
 478         GList *summary_search_from_history;
 479         GList *summary_search_to_history;
 480         GList *summary_search_subject_history;
 481         GList *summary_search_body_history;
 482         GList *summary_search_adv_condition_history;
 483         GList *message_search_history;
 484         GList *compose_save_to_history;
 485
 486         gint filteringwin_width;
 487         gint filteringwin_height;
 488         gint filteringactionwin_width;
 489         gint filteringactionwin_height;
 490         gint matcherwin_width;
 491         gint matcherwin_height;
 492         gint templateswin_width;
 493         gint templateswin_height;
 494         gint actionswin_width;
 495         gint actionswin_height;
 496         gint actionsiodialog_width;
 497         gint actionsiodialog_height;
 498         gint tagswin_width;
 499         gint tagswin_height;
 500         gint sslmanwin_width;
 501         gint sslmanwin_height;
 502         gint uriopenerwin_width;
 503         gint uriopenerwin_height;
 504         gint foldersortwin_width;
 505         gint foldersortwin_height;
 506         gint addressbookwin_width;
 507         gint addressbookwin_height;
 508         gint addressbookeditpersonwin_width;
 509         gint addressbookeditpersonwin_height;
 510         gint addressbookeditgroupwin_width;
 511         gint addressbookeditgroupwin_height;
 512         gint pluginswin_width;
 513         gint pluginswin_height;
 514         gint prefswin_width;
 515         gint prefswin_height;
 516         gint folderitemwin_width;
 517         gint folderitemwin_height;
 518         gchar *zero_replacement;
 519         gint editaccountwin_width;
 520         gint editaccountwin_height;
 521         gint accountswin_width;
 522         gint accountswin_height;
 523         gint logwin_width;
 524         gint logwin_height;
 525         gint filtering_debugwin_width;
 526         gint filtering_debugwin_height;
 527         gint folderselwin_width;
 528         gint folderselwin_height;
 529         gint addressaddwin_width;
 530         gint addressaddwin_height;
 531         gint addressbook_folderselwin_width;
 532         gint addressbook_folderselwin_height;
 533         gint aboutwin_width;
 534         gint aboutwin_height;
 535         gint addrgather_width;
 536         gint addrgather_height;
 537         gint news_subscribe_width;
 538         gint news_subscribe_height;
 539
 540         gint imap_scan_tree_recurs_limit;
 541         gint warn_dnd;
 542         gint broken_are_utf8;
 543         gint skip_ssl_cert_check;
 544         gint live_dangerously;
 545         gint save_parts_readwrite;
 546         gint never_send_retrcpt;
 547         gint hide_quotes;
 548         gboolean unsafe_ssl_certs;
 549         gboolean real_time_sync;
 550         gboolean show_save_all_success;
 551         gboolean show_save_all_failure;
 552
 553         gchar *print_paper_type;
 554         gint print_paper_orientation;
 555         gint print_margin_top;
 556         gint print_margin_bottom;
 557         gint print_margin_left;
 558         gint print_margin_right;
 559
 560         gint print_use_color;
 561         gint print_use_collate;
 562         gint print_use_reverse;
 563         gint print_use_duplex;
 564         gint print_imgs;
 565         gint print_previewwin_width;
 566         gint print_previewwin_height;
 567
 568         gboolean use_networkmanager;
 569         gboolean use_shred;
 570         gboolean two_line_vert;
 571         gboolean inherit_folder_props;
 572         gboolean flush_metadata;
 573
 574         gint nav_history_length;
 575
 576         gboolean folder_search_wildcard;
 577         gboolean address_search_wildcard;
 578
 579         guint enable_avatars;
 580
 581 #ifndef PASSWORD_CRYPTO_OLD
 582         gboolean use_primary_passphrase;
 583         gchar *primary_passphrase;
 584         gchar *primary_passphrase_salt;
 585         guint primary_passphrase_pbkdf2_rounds;
 586 #endif
 587
 588         /* Proxy */
 589         gboolean use_proxy;
 590         ProxyInfo proxy_info;
 591
 592     /* Quicksearch */
 593     guint qs_press_timeout;
 594 };
 595
 596 extern PrefsCommon prefs_common;
 597
 598 PrefsCommon *prefs_common_get_prefs(void);
 599
 600 GList *prefs_common_read_history_from_dir_with_defaults(const gchar *dirname, const gchar *history,
 601                                                                                                                           GList *default_list);
 602 void prefs_common_read_config   (void);
 603 void prefs_common_write_config  (void);
 604 void prefs_common_open          (void);
 605 void pref_get_unescaped_pref(gchar *out, const gchar *in);
 606 void pref_get_escaped_pref(gchar *out, const gchar *in);
 607 void pref_set_textview_from_pref(GtkTextView *textview, const gchar *txt);
 608 void pref_set_entry_from_pref(GtkEntry *entry, const gchar *txt);
 609 gchar *pref_get_pref_from_textview(GtkTextView *textview);
 610 gchar *pref_get_pref_from_entry(GtkEntry *entry);
 611 const gchar *prefs_common_translated_header_name(const gchar *header_name);
 612 const gchar *prefs_common_get_uri_cmd(void);
 613 const gchar *prefs_common_get_ext_editor_cmd(void);
 614
 615 #define OPEN_SELECTED(when) (prefs_common.always_show_msg || prefs_common.when)
 616
 617 #define OPEN_SELECTED_ON_FOLDER_OPEN OPEN_SELECTED(open_selected_on_folder_open)
 618 #define OPEN_SELECTED_ON_SEARCH_RESULTS OPEN_SELECTED(open_selected_on_search_results)
 619 #define OPEN_SELECTED_ON_PREVNEXT OPEN_SELECTED(open_selected_on_prevnext)
 620 #define OPEN_SELECTED_ON_DELETEMOVE OPEN_SELECTED(open_selected_on_deletemove)
 621 #define OPEN_SELECTED_ON_DIRECTIONAL OPEN_SELECTED(open_selected_on_directional)
 622
 623 #endif /* __PREFS_COMMON_H__ */