2 * $Id: conftype.h 1155 2008-08-21 18:33:21Z hubert@u.washington.edu $
4 * ========================================================================
5 * Copyright 2013-2020 Eduardo Chappa
6 * Copyright 2006-2008 University of Washington
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * ========================================================================
17 #ifndef PITH_CONFTYPE_INCLUDED
18 #define PITH_CONFTYPE_INCLUDED
21 #include "../pith/helptext.h"
22 #include "../pith/remtype.h"
25 typedef enum {Sapling
, Seedling
, Seasoned
} FeatureLevel
;
29 * The array is initialized in pith/conf.c so the order of that initialization
30 * must correspond to the order of the values here. The order is
31 * significant in that it determines the order that the variables
32 * are written into the pinerc file and the order they show up in in the
35 typedef enum { V_PERSONAL_NAME
= 0
44 , V_DEFAULT_SAVE_FOLDER
46 , V_READ_MESSAGE_FOLDER
59 , V_SAVED_MSG_NAME_RULE
69 , V_THREAD_INDEX_STYLE
72 , V_THREAD_LASTREPLY_CHAR
77 #endif /* ! _WINDOWS */
88 , V_QUOTE_REPLACE_STRING
92 , V_USE_ONLY_DOMAIN_NAME
100 , V_FORCED_ABOOK_ENTRY
101 , V_KBLOCK_PASSWD_COUNT
113 , V_ACTIVE_MSG_INTERVAL
122 , V_UPLOAD_CMD_PREFIX
124 , V_DOWNLOAD_CMD_PREFIX
127 #if !defined(_WINDOWS) || defined(WINDOWS_LIBRESSL_CERTS)
137 , V_INC2NDCHECKINTERVAL
140 #if !defined(DOS) && !defined(OS2) && !defined(LEAVEOUTFIFO)
145 * Starting here, the rest of the variables are hidden by default in config
146 * screen. They are exposed with expose-hidden-config feature.
155 , V_LAST_TIME_PRUNE_QUESTION
161 , V_DEBUGMEM
/* obsolete */
165 , V_TCPWRITEWARNTIMEO
177 #ifdef DF_ENCRYPTION_RANGE
180 , V_REMOTE_ABOOK_METADATA
181 , V_REMOTE_ABOOK_HISTORY
182 , V_REMOTE_ABOOK_VALIDITY
184 , V_PERSONAL_PRINT_COMMAND
185 , V_PERSONAL_PRINT_CATEGORY
187 , V_PATTERNS
/* obsolete */
190 , V_PAT_FILTS_OLD
/* obsolete */
192 , V_PAT_SCORES_OLD
/* obsolete */
196 , V_ELM_STYLE_SAVE
/* obsolete */
197 , V_HEADER_IN_REPLY
/* obsolete */
198 , V_FEATURE_LEVEL
/* obsolete */
199 , V_OLD_STYLE_REPLY
/* obsolete */
200 , V_COMPOSE_MIME
/* obsolete */
201 , V_SHOW_ALL_CHARACTERS
/* obsolete */
202 , V_SAVE_BY_SENDER
/* obsolete */
203 #if defined(DOS) || defined(OS2)
210 , V_INDEX_COLOR_STYLE
211 , V_TITLEBAR_COLOR_STYLE
218 , V_TITLECLOSED_FORE_COLOR
219 , V_TITLECLOSED_BACK_COLOR
220 , V_FOLDER_FORE_COLOR
221 , V_FOLDER_BACK_COLOR
222 , V_DIRECTORY_FORE_COLOR
223 , V_DIRECTORY_BACK_COLOR
224 , V_FOLDER_LIST_FORE_COLOR
225 , V_FOLDER_LIST_BACK_COLOR
226 , V_STATUS_FORE_COLOR
227 , V_STATUS_BACK_COLOR
228 , V_KEYLABEL_FORE_COLOR
229 , V_KEYLABEL_BACK_COLOR
230 , V_KEYNAME_FORE_COLOR
231 , V_KEYNAME_BACK_COLOR
232 , V_SLCTBL_FORE_COLOR
233 , V_SLCTBL_BACK_COLOR
234 , V_METAMSG_FORE_COLOR
235 , V_METAMSG_BACK_COLOR
236 , V_QUOTE1_FORE_COLOR
237 , V_QUOTE1_BACK_COLOR
238 , V_QUOTE2_FORE_COLOR
239 , V_QUOTE2_BACK_COLOR
240 , V_QUOTE3_FORE_COLOR
241 , V_QUOTE3_BACK_COLOR
242 , V_INCUNSEEN_FORE_COLOR
243 , V_INCUNSEEN_BACK_COLOR
244 , V_SIGNATURE_FORE_COLOR
245 , V_SIGNATURE_BACK_COLOR
246 , V_PROMPT_FORE_COLOR
247 , V_PROMPT_BACK_COLOR
248 , V_HEADER_GENERAL_FORE_COLOR
249 , V_HEADER_GENERAL_BACK_COLOR
250 , V_IND_PLUS_FORE_COLOR
251 , V_IND_PLUS_BACK_COLOR
252 , V_IND_IMP_FORE_COLOR
253 , V_IND_IMP_BACK_COLOR
254 , V_IND_DEL_FORE_COLOR
255 , V_IND_DEL_BACK_COLOR
256 , V_IND_ANS_FORE_COLOR
257 , V_IND_ANS_BACK_COLOR
258 , V_IND_NEW_FORE_COLOR
259 , V_IND_NEW_BACK_COLOR
260 , V_IND_REC_FORE_COLOR
261 , V_IND_REC_BACK_COLOR
262 , V_IND_FWD_FORE_COLOR
263 , V_IND_FWD_BACK_COLOR
264 , V_IND_UNS_FORE_COLOR
265 , V_IND_UNS_BACK_COLOR
266 , V_IND_HIPRI_FORE_COLOR
267 , V_IND_HIPRI_BACK_COLOR
268 , V_IND_LOPRI_FORE_COLOR
269 , V_IND_LOPRI_BACK_COLOR
270 , V_IND_ARR_FORE_COLOR
271 , V_IND_ARR_BACK_COLOR
272 , V_IND_SUBJ_FORE_COLOR
273 , V_IND_SUBJ_BACK_COLOR
274 , V_IND_FROM_FORE_COLOR
275 , V_IND_FROM_BACK_COLOR
276 , V_IND_OP_FORE_COLOR
277 , V_IND_OP_BACK_COLOR
278 , V_INDEX_TOKEN_COLORS
281 #if defined(DOS) || defined(OS2)
290 , V_PRINT_FONT_CHAR_SET
298 , V_PUBLICCERT_CONTAINER
300 , V_PRIVATEKEY_CONTAINER
305 , V_LDAP_SERVERS
/* should be last so make will work right */
317 #define V_LAST_VAR (V_DUMMY - 1)
321 * The list of feature numbers (which bit goes with which feature).
322 * The order of the features is not significant.
328 F_ENABLE_TAB_COMPLETE
,
345 F_READ_IN_NEWSRC_ORDER
,
347 F_SAVE_PARTIAL_WO_CONFIRM
,
348 F_NEXT_THRD_WO_CONFIRM
,
354 F_UNSELECT_WONT_ADVANCE
,
362 F_AUTO_OPEN_NEXT_UNREAD
,
363 F_DISABLE_INDEX_LOCALE_DATES
,
364 F_SELECTED_SHOWN_BOLD
,
366 F_AUTO_INCLUDE_IN_REPLY
,
367 F_DISABLE_CONFIG_SCREEN
,
368 F_DISABLE_PASSWORD_CACHING
,
369 #ifdef LOCAL_PASSWD_CACHE
370 F_DISABLE_PASSWORD_FILE_SAVING
,
371 #endif /* LOCAL_PASSWD_CACHE */
373 F_DISABLE_PASSWORD_CMD
,
374 F_DISABLE_UPDATE_CMD
,
375 F_DISABLE_KBLOCK_CMD
,
376 F_DISABLE_SIGEDIT_CMD
,
377 F_DISABLE_ROLES_SETUP
,
378 F_DISABLE_ROLES_SIGEDIT
,
379 F_DISABLE_ROLES_TEMPLEDIT
,
380 F_DISABLE_PIPES_IN_SIGS
,
381 F_DISABLE_PIPES_IN_TEMPLATES
,
382 F_ATTACHMENTS_IN_REPLY
,
384 F_ENABLE_INCOMING_CHECKING
,
385 F_INCOMING_CHECKING_TOTAL
,
386 F_INCOMING_CHECKING_RECENT
,
387 F_NO_NEWS_VALIDATION
,
388 F_QUELL_EXTRA_POST_PROMPT
,
389 F_DISABLE_TAKE_LASTFIRST
,
390 F_DISABLE_TAKE_FULLNAMES
,
391 F_DISABLE_TERM_RESET_DISP
,
394 F_QUELL_LOCAL_LOOKUP
,
395 F_COMPOSE_TO_NEWSGRP
,
396 F_PRESERVE_START_STOP
,
397 F_COMPOSE_REJECTS_UNQUAL
,
405 F_PASS_CONTROL_CHARS
,
406 F_PASS_C1_CONTROL_CHARS
,
407 F_SINGLE_FOLDER_LIST
,
408 F_VERTICAL_FOLDER_LIST
,
416 F_DISABLE_SAVE_INPUT_HISTORY
,
425 F_ENABLE_DOT_FOLDERS
,
426 F_FIRST_SEND_FILTER_DFLT
,
427 F_ALWAYS_LAST_FLDR_DFLT
,
430 F_WARN_ABOUT_NO_SUBJECT
,
432 F_WARN_ABOUT_NO_TO_OR_CC
,
435 F_QUELL_LOCK_FAILURE_MSGS
,
436 F_ENABLE_SPACE_AS_TAB
,
437 F_USE_BORING_SPINNER
,
438 F_ENABLE_TAB_DELETES
,
439 F_FLAG_SCREEN_KW_SHORTCUT
,
441 F_ENABLE_XTERM_NEWMAIL
,
442 F_ENABLE_NEWMAIL_SHORT_TEXT
,
443 F_EXPANDED_DISTLISTS
,
446 F_DISABLE_SETLOCALE_COLLATE
,
447 F_FROM_DELIM_IN_PRINT
,
451 F_ENABLE_SEARCH_AND_REPL
,
456 F_ENABLE_STRIP_SIGDASHES
,
457 F_NEW_THREAD_ON_BLANK_SUBJECT
,
458 F_QUELL_PARTIAL_FETCH
,
459 F_QUELL_PERSONAL_NAME_PROMPT
,
460 F_QUELL_USER_ID_PROMPT
,
466 F_EXTERNAL_INLINE_IMAGES
,
468 F_QUELL_CHARSET_WARNING
,
470 F_ENABLE_EDIT_REPLY_INDENT
,
472 F_ALLOW_CHANGING_FROM
,
474 F_ENABLE_LESSTHAN_EXIT
,
475 F_ENABLE_FAST_RECENT
,
478 F_ENABLE_TAKE_EXPORT
,
479 F_QUELL_ATTACH_EXTRA_PROMPT
,
481 F_QUELL_ATTACH_EXT_WARN
,
483 F_QUELL_FILTER_DONE_MSG
,
487 F_PREDICT_NNTP_SERVER
,
490 F_QUELL_INTERNAL_MSG
,
493 F_SEPARATE_FLDR_AS_DIR
,
497 F_EXPANDED_ADDRBOOKS
,
500 F_SHOW_TEXTPLAIN_INT
,
501 F_ROLE_CONFIRM_DEFAULT
,
504 F_RET_INBOX_NO_CONFIRM
,
510 F_DO_MAILCAP_PARAM_SUBST
,
512 F_SLCTBL_ITEM_NOBOLD
,
513 F_QUELL_PINGS_COMPOSING
,
514 F_QUELL_PINGS_COMPOSING_INBOX
,
515 F_QUELL_BEZERK_TIMEZONE
,
517 F_QUELL_MAILDOMAIN_WARNING
,
518 F_DISABLE_SHARED_NAMESPACES
,
520 F_MAILDROPS_PRESERVE_STATE
,
521 F_EXPOSE_HIDDEN_CONFIG
,
525 F_ALWAYS_SPELL_CHECK
,
528 F_COLOR_LINE_IMPORTANT
,
530 F_ENABLE_FULL_HDR_AND_TEXT
,
531 F_QUELL_FULL_HDR_RESET
,
533 F_MULNEWSRC_HOSTNAMES_AS_TYPED
,
534 F_STRIP_WS_BEFORE_SEND
,
536 F_COMPOSE_ALWAYS_DOWNGRADE
,
537 F_SORT_DEFAULT_FCC_ALPHA
,
538 F_SORT_DEFAULT_SAVE_ALPHA
,
539 F_QUOTE_REPLACE_NOFLOW
,
541 F_SEND_CONFIRM_ON_EXPAND
,
542 F_ENABLE_NEWMAIL_SOUND
,
543 F_RENDER_HTML_INTERNALLY
,
545 F_FORWARD_AS_ATTACHMENT
,
546 F_PRESERVE_ORIGINAL_FIELD
,
549 #endif /* ! _WINDOWS */
550 F_QUELL_HOST_AFTER_URL
,
551 F_NNTP_SEARCH_USES_OVERVIEW
,
552 F_THREAD_SORTS_BY_ARRIVAL
,
555 F_QUELL_SSL_LARGEBLOCKS
,
556 F_STORE_WINPOS_IN_CONFIG
,
564 F_ENCRYPT_DEFAULT_ON
,
565 F_REMEMBER_SMIME_PASSPHRASE
,
566 F_USE_CERT_STORE_ONLY
,
568 F_PUBLICCERTS_IN_KEYCHAIN
,
571 F_FEATURE_LIST_COUNT
/* Number of features */
575 typedef struct init_err
{
576 int flags
, min_time
, max_time
;
583 unsigned is_obsolete
:1; /* variable read in, not written unless set */
584 unsigned is_used
:1; /* Some variables are disabled */
585 unsigned been_written
:1;
587 unsigned is_global
:1;
588 unsigned is_list
:1; /* flag indicating variable is a list */
589 unsigned is_fixed
:1; /* sys mgr has fixed this variable */
590 unsigned is_onlymain
:1; /* read and written from main_user_val */
591 unsigned is_outermost
:1; /* read and written from outermost pinerc */
592 unsigned del_quotes
:1; /* remove double quotes */
593 unsigned is_changed_val
:1; /* WP: use the changed val instead of cur val */
594 char *dname
; /* display name */
595 char *descrip
; /* description */
597 char *p
; /* pointer to single string value */
598 char **l
; /* pointer to list of string values */
601 char *p
; /* pointer to single string value */
602 char **l
; /* pointer to list of string values */
603 } main_user_val
; /* from pinerc */
605 char *p
; /* pointer to single string value */
606 char **l
; /* pointer to list of string values */
607 } changed_val
; /* currently different from pinerc */
609 char *p
; /* pointer to single string value */
610 char **l
; /* pointer to list of string values */
611 } post_user_val
; /* from pinerc */
613 char *p
; /* pointer to single string value */
614 char **l
; /* pointer to list of string values */
615 } global_val
; /* from default or pine.conf */
617 char *p
; /* pointer to single string value */
618 char **l
; /* pointer to list of string values */
619 } fixed_val
; /* fixed value assigned in pine.conf.fixed */
621 char *p
; /* pointer to single string value */
622 char **l
; /* pointer to list of string values */
623 } cmdline_val
; /* user typed as cmdline arg */
627 typedef struct feature_entry
{
629 char *dname
; /* display name, same as name if NULL */
632 int section
; /* for grouping in config screen */
633 int defval
; /* default value, 0 or 1 */
637 typedef struct pinerc_line
{
639 struct variable
*var
;
640 unsigned int is_var
:1;
641 unsigned int is_quoted
:1;
642 unsigned int obsolete_var
:1;
647 * Each pinerc has one of these.
649 typedef struct pinerc_s
{
650 RemType type
; /* type of pinerc, remote or local */
651 char *name
; /* file name or remote name */
652 REMDATA_S
*rd
; /* remote data structure */
653 time_t pinerc_written
;
655 unsigned outstanding_pinerc_changes
:1;
656 unsigned quit_to_edit
:1;
657 PINERC_LINE
*pinerc_lines
;
661 typedef enum {ParsePers
, ParsePersPost
, ParseGlobal
, ParseFixed
} ParsePinerc
;
664 /* data stored in a line in the metadata file */
665 typedef struct remote_data_meta
{
666 char *local_cache_file
;
667 imapuid_t uidvalidity
;
671 char read_status
; /* 'R' for readonly, 'W' for readwrite */
677 * Generic name/value pair structure
679 typedef struct nameval
{
680 char *name
; /* the name that goes on the screen */
681 char *shortname
; /* if non-NULL, name that goes in config file */
682 int value
; /* the internal bit number */
686 typedef enum {Main
, Post
, None
} EditWhich
;
691 typedef enum {Directory
, Container
, Keychain
, Nada
} SmimeHolderType
;
693 typedef enum {Public
, Private
, CACert
, Password
} WhichCerts
;
695 typedef struct certdata
{
696 unsigned deleted
:1; /* certificate is marked deleted */
697 unsigned renew
:1; /* we must renew this list, set at top cert */
698 char *date_from
; /* date from which certificate is valid */
699 char *date_to
; /* date certificate expires */
700 char *md5
; /* MD5 Hash */
703 typedef struct certlist
{
704 char *name
; /* file name */
705 char *cn
; /* CN field from certificate */
706 void *x509_cert
; /* this is type (X509 *) */
708 struct certlist
*next
;
711 typedef struct smime_stuff
{
713 unsigned do_sign
:1; /* set true if signing */
714 unsigned do_encrypt
:1; /* set true if encrypting */
715 unsigned need_passphrase
:1; /* set true if loading a key failed due to lack of passphrase */
716 unsigned entered_passphrase
:1; /* user entered a passphrase */
717 unsigned already_auto_asked
:1; /* asked for passphrase automatically, not again */
718 volatile char passphrase
[100]; /* storage for the entered passphrase */
719 char **passphrase_emailaddr
; /* pointer to allocated storage */
722 * If we are using the Container type it is easiest if we
723 * read in and maintain a list of certs and then write them
724 * out all at once. For Directory type we just leave the data
725 * in the individual files and read the list of files in the
728 SmimeHolderType publictype
;
731 CertList
*publiccertlist
;
732 CertList
*backuppubliccertlist
;
734 SmimeHolderType privatetype
;
736 char *privatecontent
;
737 CertList
*privatecertlist
;
738 CertList
*backupprivatecertlist
;
739 void *personal_certs
; /* this is type (PERSONAL_CERT *) */
741 SmimeHolderType catype
;
744 CertList
*cacertlist
;
745 CertList
*backupcacertlist
;
749 #define BACKUPDATACERT(X) ((X) == Public ? ps_global->smime->backuppubliccertlist : \
750 (X) == Private ? ps_global->smime->backupprivatecertlist : \
751 (X) == CACert ? ps_global->smime->backupcacertlist : \
752 (X) == Password ? (CertList *) ps_global->backuppassword : \
755 #define DATACERT(X) ((X) == Public ? ps_global->smime->publiccertlist : \
756 (X) == Private ? ps_global->smime->privatecertlist : \
757 (X) == CACert ? ps_global->smime->cacertlist : \
758 (X) == Password ? (CertList *) ps_global->pwdcertlist : \
761 #define PATHCERTDIR(X) ((X) == Public ? ps_global->smime->publicpath : \
762 (X) == Private ? ps_global->smime->privatepath : \
763 (X) == CACert ? ps_global->smime->capath : \
764 (X) == Password ? ps_global->pwdcertdir : \
767 #define CONTENTCERTLIST(X) ((X) == Public ? ps_global->smime->publiccontent : \
768 (X) == Private ? ps_global->smime->privatecontent : \
769 (X) == CACert ? ps_global->smime->cacontent : \
770 (X) == Password ? ps_global->pwdcertcontent : \
773 #define SMHOLDERTYPE(X) ((X) == Public ? ps_global->smime->publictype : \
774 (X) == Private ? ps_global->smime->privatetype : \
775 (X) == CACert ? ps_global->smime->catype : \
776 (X) == Password ? Directory : \
779 #define EXTCERT(X) (((X) == Public ? ".crt" \
780 : ((X) == Private ? ".key" \
781 : ((X) == CACert ? ".crt" : ""))))
783 #define DELETEDCERT(X) ((X)->data.deleted)
784 #define RENEWCERT(X) ((X)->data.renew)
785 #define DATEFROMCERT(X) ((X)->data.date_from)
786 #define DATETOCERT(X) ((X)->data.date_to)
787 #define MD5CERT(X) ((X)->data.md5)
792 /* exported prototypes */
795 #endif /* PITH_CONFTYPE_INCLUDED */