2 * $Id: conftype.h 1155 2008-08-21 18:33:21Z hubert@u.washington.edu $
4 * ========================================================================
5 * Copyright 2013-2021 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_UNIXSSL_CERTS)
140 , V_INC2NDCHECKINTERVAL
143 #if !defined(DOS) && !defined(OS2) && !defined(LEAVEOUTFIFO)
148 * Starting here, the rest of the variables are hidden by default in config
149 * screen. They are exposed with expose-hidden-config feature.
158 , V_LAST_TIME_PRUNE_QUESTION
164 , V_DEBUGMEM
/* obsolete */
168 , V_TCPWRITEWARNTIMEO
181 , V_REMOTE_ABOOK_METADATA
182 , V_REMOTE_ABOOK_HISTORY
183 , V_REMOTE_ABOOK_VALIDITY
185 , V_PERSONAL_PRINT_COMMAND
186 , V_PERSONAL_PRINT_CATEGORY
188 , V_PATTERNS
/* obsolete */
191 , V_PAT_FILTS_OLD
/* obsolete */
193 , V_PAT_SCORES_OLD
/* obsolete */
197 , V_ELM_STYLE_SAVE
/* obsolete */
198 , V_HEADER_IN_REPLY
/* obsolete */
199 , V_FEATURE_LEVEL
/* obsolete */
200 , V_OLD_STYLE_REPLY
/* obsolete */
201 , V_COMPOSE_MIME
/* obsolete */
202 , V_SHOW_ALL_CHARACTERS
/* obsolete */
203 , V_SAVE_BY_SENDER
/* obsolete */
204 #if defined(DOS) || defined(OS2)
211 , V_INDEX_COLOR_STYLE
212 , V_TITLEBAR_COLOR_STYLE
219 , V_TITLECLOSED_FORE_COLOR
220 , V_TITLECLOSED_BACK_COLOR
221 , V_FOLDER_FORE_COLOR
222 , V_FOLDER_BACK_COLOR
223 , V_DIRECTORY_FORE_COLOR
224 , V_DIRECTORY_BACK_COLOR
225 , V_FOLDER_LIST_FORE_COLOR
226 , V_FOLDER_LIST_BACK_COLOR
227 , V_STATUS_FORE_COLOR
228 , V_STATUS_BACK_COLOR
229 , V_KEYLABEL_FORE_COLOR
230 , V_KEYLABEL_BACK_COLOR
231 , V_KEYNAME_FORE_COLOR
232 , V_KEYNAME_BACK_COLOR
233 , V_SLCTBL_FORE_COLOR
234 , V_SLCTBL_BACK_COLOR
235 , V_METAMSG_FORE_COLOR
236 , V_METAMSG_BACK_COLOR
237 , V_QUOTE1_FORE_COLOR
238 , V_QUOTE1_BACK_COLOR
239 , V_QUOTE2_FORE_COLOR
240 , V_QUOTE2_BACK_COLOR
241 , V_QUOTE3_FORE_COLOR
242 , V_QUOTE3_BACK_COLOR
243 , V_INCUNSEEN_FORE_COLOR
244 , V_INCUNSEEN_BACK_COLOR
245 , V_SIGNATURE_FORE_COLOR
246 , V_SIGNATURE_BACK_COLOR
247 , V_PROMPT_FORE_COLOR
248 , V_PROMPT_BACK_COLOR
249 , V_HEADER_GENERAL_FORE_COLOR
250 , V_HEADER_GENERAL_BACK_COLOR
251 , V_IND_PLUS_FORE_COLOR
252 , V_IND_PLUS_BACK_COLOR
253 , V_IND_IMP_FORE_COLOR
254 , V_IND_IMP_BACK_COLOR
255 , V_IND_DEL_FORE_COLOR
256 , V_IND_DEL_BACK_COLOR
257 , V_IND_ANS_FORE_COLOR
258 , V_IND_ANS_BACK_COLOR
259 , V_IND_NEW_FORE_COLOR
260 , V_IND_NEW_BACK_COLOR
261 , V_IND_REC_FORE_COLOR
262 , V_IND_REC_BACK_COLOR
263 , V_IND_FWD_FORE_COLOR
264 , V_IND_FWD_BACK_COLOR
265 , V_IND_UNS_FORE_COLOR
266 , V_IND_UNS_BACK_COLOR
267 , V_IND_HIPRI_FORE_COLOR
268 , V_IND_HIPRI_BACK_COLOR
269 , V_IND_LOPRI_FORE_COLOR
270 , V_IND_LOPRI_BACK_COLOR
271 , V_IND_ARR_FORE_COLOR
272 , V_IND_ARR_BACK_COLOR
273 , V_IND_SUBJ_FORE_COLOR
274 , V_IND_SUBJ_BACK_COLOR
275 , V_IND_FROM_FORE_COLOR
276 , V_IND_FROM_BACK_COLOR
277 , V_IND_OP_FORE_COLOR
278 , V_IND_OP_BACK_COLOR
279 , V_INDEX_TOKEN_COLORS
282 #if defined(DOS) || defined(OS2)
291 , V_PRINT_FONT_CHAR_SET
299 , V_PUBLICCERT_CONTAINER
301 , V_PRIVATEKEY_CONTAINER
306 , V_LDAP_SERVERS
/* should be last so make will work right */
318 #define V_LAST_VAR (V_DUMMY - 1)
322 * The list of feature numbers (which bit goes with which feature).
323 * The order of the features is not significant.
329 F_ENABLE_TAB_COMPLETE
,
346 F_READ_IN_NEWSRC_ORDER
,
348 F_SAVE_PARTIAL_WO_CONFIRM
,
349 F_NEXT_THRD_WO_CONFIRM
,
355 F_UNSELECT_WONT_ADVANCE
,
363 F_AUTO_OPEN_NEXT_UNREAD
,
364 F_DISABLE_INDEX_LOCALE_DATES
,
365 F_SELECTED_SHOWN_BOLD
,
367 F_AUTO_INCLUDE_IN_REPLY
,
368 F_DISABLE_CONFIG_SCREEN
,
369 F_DISABLE_PASSWORD_CACHING
,
370 #ifdef LOCAL_PASSWD_CACHE
371 F_DISABLE_PASSWORD_FILE_SAVING
,
372 #endif /* LOCAL_PASSWD_CACHE */
374 F_DISABLE_PASSWORD_CMD
,
375 F_DISABLE_UPDATE_CMD
,
376 F_DISABLE_KBLOCK_CMD
,
377 F_DISABLE_SIGEDIT_CMD
,
378 F_ENABLE_DEL_WHEN_WRITING
,
379 F_DISABLE_ROLES_SETUP
,
380 F_DISABLE_ROLES_SIGEDIT
,
381 F_DISABLE_ROLES_TEMPLEDIT
,
382 F_DISABLE_PIPES_IN_SIGS
,
383 F_DISABLE_PIPES_IN_TEMPLATES
,
384 F_ATTACHMENTS_IN_REPLY
,
386 F_ENABLE_INCOMING_CHECKING
,
387 F_INCOMING_CHECKING_TOTAL
,
388 F_INCOMING_CHECKING_RECENT
,
389 F_NO_NEWS_VALIDATION
,
390 F_QUELL_EXTRA_POST_PROMPT
,
391 F_DISABLE_TAKE_LASTFIRST
,
392 F_DISABLE_TAKE_FULLNAMES
,
393 F_DISABLE_TERM_RESET_DISP
,
396 F_QUELL_LOCAL_LOOKUP
,
397 F_COMPOSE_TO_NEWSGRP
,
398 F_PRESERVE_START_STOP
,
399 F_COMPOSE_REJECTS_UNQUAL
,
407 F_PASS_CONTROL_CHARS
,
408 F_PASS_C1_CONTROL_CHARS
,
409 F_SINGLE_FOLDER_LIST
,
410 F_VERTICAL_FOLDER_LIST
,
418 F_DISABLE_SAVE_INPUT_HISTORY
,
427 F_ENABLE_DOT_FOLDERS
,
428 F_FIRST_SEND_FILTER_DFLT
,
429 F_ALWAYS_LAST_FLDR_DFLT
,
432 F_WARN_ABOUT_NO_SUBJECT
,
434 F_WARN_ABOUT_NO_TO_OR_CC
,
437 F_QUELL_LOCK_FAILURE_MSGS
,
438 F_ENABLE_SPACE_AS_TAB
,
439 F_USE_BORING_SPINNER
,
440 F_ENABLE_TAB_DELETES
,
441 F_FLAG_SCREEN_KW_SHORTCUT
,
443 F_ENABLE_XTERM_NEWMAIL
,
444 F_ENABLE_NEWMAIL_SHORT_TEXT
,
445 F_EXPANDED_DISTLISTS
,
448 F_DISABLE_SETLOCALE_COLLATE
,
449 F_FROM_DELIM_IN_PRINT
,
453 F_ENABLE_SEARCH_AND_REPL
,
458 F_ENABLE_STRIP_SIGDASHES
,
459 F_NEW_THREAD_ON_BLANK_SUBJECT
,
460 F_QUELL_PARTIAL_FETCH
,
461 F_QUELL_PERSONAL_NAME_PROMPT
,
462 F_QUELL_USER_ID_PROMPT
,
468 F_EXTERNAL_INLINE_IMAGES
,
470 F_QUELL_CHARSET_WARNING
,
472 F_ENABLE_EDIT_REPLY_INDENT
,
474 F_ALLOW_CHANGING_FROM
,
476 F_ENABLE_LESSTHAN_EXIT
,
477 F_ENABLE_FAST_RECENT
,
480 F_ENABLE_TAKE_EXPORT
,
481 F_QUELL_ATTACH_EXTRA_PROMPT
,
483 F_QUELL_ATTACH_EXT_WARN
,
485 F_QUELL_FILTER_DONE_MSG
,
489 F_PREDICT_NNTP_SERVER
,
492 F_QUELL_INTERNAL_MSG
,
495 F_SEPARATE_FLDR_AS_DIR
,
499 F_EXPANDED_ADDRBOOKS
,
502 F_SHOW_TEXTPLAIN_INT
,
503 F_ROLE_CONFIRM_DEFAULT
,
506 F_RET_INBOX_NO_CONFIRM
,
512 F_DO_MAILCAP_PARAM_SUBST
,
514 F_SLCTBL_ITEM_NOBOLD
,
515 F_QUELL_PINGS_COMPOSING
,
516 F_QUELL_PINGS_COMPOSING_INBOX
,
517 F_QUELL_BEZERK_TIMEZONE
,
519 F_QUELL_MAILDOMAIN_WARNING
,
520 F_DISABLE_SHARED_NAMESPACES
,
522 F_MAILDROPS_PRESERVE_STATE
,
523 F_EXPOSE_HIDDEN_CONFIG
,
527 F_ALWAYS_SPELL_CHECK
,
530 F_COLOR_LINE_IMPORTANT
,
532 F_ENABLE_FULL_HDR_AND_TEXT
,
533 F_QUELL_FULL_HDR_RESET
,
535 F_MULNEWSRC_HOSTNAMES_AS_TYPED
,
536 F_STRIP_WS_BEFORE_SEND
,
538 F_COMPOSE_ALWAYS_DOWNGRADE
,
539 F_SORT_DEFAULT_FCC_ALPHA
,
540 F_SORT_DEFAULT_SAVE_ALPHA
,
541 F_QUOTE_REPLACE_NOFLOW
,
543 F_SEND_CONFIRM_ON_EXPAND
,
544 F_ENABLE_NEWMAIL_SOUND
,
545 F_RENDER_HTML_INTERNALLY
,
547 F_FORWARD_AS_ATTACHMENT
,
548 F_PRESERVE_ORIGINAL_FIELD
,
551 #endif /* ! _WINDOWS */
552 F_QUELL_HOST_AFTER_URL
,
553 F_NNTP_SEARCH_USES_OVERVIEW
,
554 F_THREAD_SORTS_BY_ARRIVAL
,
557 F_QUELL_SSL_LARGEBLOCKS
,
558 F_STORE_WINPOS_IN_CONFIG
,
566 F_ENCRYPT_DEFAULT_ON
,
567 F_REMEMBER_SMIME_PASSPHRASE
,
568 F_USE_CERT_STORE_ONLY
,
570 F_PUBLICCERTS_IN_KEYCHAIN
,
573 F_FEATURE_LIST_COUNT
/* Number of features */
577 typedef struct init_err
{
578 int flags
, min_time
, max_time
;
585 unsigned is_obsolete
:1; /* variable read in, not written unless set */
586 unsigned is_used
:1; /* Some variables are disabled */
587 unsigned been_written
:1;
589 unsigned is_global
:1;
590 unsigned is_list
:1; /* flag indicating variable is a list */
591 unsigned is_fixed
:1; /* sys mgr has fixed this variable */
592 unsigned is_onlymain
:1; /* read and written from main_user_val */
593 unsigned is_outermost
:1; /* read and written from outermost pinerc */
594 unsigned del_quotes
:1; /* remove double quotes */
595 unsigned is_changed_val
:1; /* WP: use the changed val instead of cur val */
596 char *dname
; /* display name */
597 char *descrip
; /* description */
599 char *p
; /* pointer to single string value */
600 char **l
; /* pointer to list of string values */
603 char *p
; /* pointer to single string value */
604 char **l
; /* pointer to list of string values */
605 } main_user_val
; /* from pinerc */
607 char *p
; /* pointer to single string value */
608 char **l
; /* pointer to list of string values */
609 } changed_val
; /* currently different from pinerc */
611 char *p
; /* pointer to single string value */
612 char **l
; /* pointer to list of string values */
613 } post_user_val
; /* from pinerc */
615 char *p
; /* pointer to single string value */
616 char **l
; /* pointer to list of string values */
617 } global_val
; /* from default or pine.conf */
619 char *p
; /* pointer to single string value */
620 char **l
; /* pointer to list of string values */
621 } fixed_val
; /* fixed value assigned in pine.conf.fixed */
623 char *p
; /* pointer to single string value */
624 char **l
; /* pointer to list of string values */
625 } cmdline_val
; /* user typed as cmdline arg */
629 typedef struct feature_entry
{
631 char *dname
; /* display name, same as name if NULL */
634 int section
; /* for grouping in config screen */
635 int defval
; /* default value, 0 or 1 */
639 typedef struct pinerc_line
{
641 struct variable
*var
;
642 unsigned int is_var
:1;
643 unsigned int is_quoted
:1;
644 unsigned int obsolete_var
:1;
649 * Each pinerc has one of these.
651 typedef struct pinerc_s
{
652 RemType type
; /* type of pinerc, remote or local */
653 char *name
; /* file name or remote name */
654 REMDATA_S
*rd
; /* remote data structure */
655 time_t pinerc_written
;
657 unsigned outstanding_pinerc_changes
:1;
658 unsigned quit_to_edit
:1;
659 PINERC_LINE
*pinerc_lines
;
663 typedef enum {ParsePers
, ParsePersPost
, ParseGlobal
, ParseFixed
} ParsePinerc
;
666 /* data stored in a line in the metadata file */
667 typedef struct remote_data_meta
{
668 char *local_cache_file
;
669 imapuid_t uidvalidity
;
673 char read_status
; /* 'R' for readonly, 'W' for readwrite */
679 * Generic name/value pair structure
681 typedef struct nameval
{
682 char *name
; /* the name that goes on the screen */
683 char *shortname
; /* if non-NULL, name that goes in config file */
684 int value
; /* the internal bit number */
688 typedef enum {Main
, Post
, None
} EditWhich
;
693 typedef enum {Directory
, Container
, Keychain
, Nada
} SmimeHolderType
;
695 typedef enum {Public
, Private
, CACert
, Password
} WhichCerts
;
697 typedef struct certdata
{
698 unsigned deleted
:1; /* certificate is marked deleted */
699 unsigned renew
:1; /* we must renew this list, set at top cert */
700 char *date_from
; /* date from which certificate is valid */
701 char *date_to
; /* date certificate expires */
702 char *md5
; /* MD5 Hash */
705 typedef struct certlist
{
706 char *name
; /* file name */
707 char *cn
; /* CN field from certificate */
708 void *x509_cert
; /* this is type (X509 *) */
710 struct certlist
*next
;
713 typedef struct smime_stuff
{
715 unsigned do_sign
:1; /* set true if signing */
716 unsigned do_encrypt
:1; /* set true if encrypting */
717 unsigned need_passphrase
:1; /* set true if loading a key failed due to lack of passphrase */
718 unsigned entered_passphrase
:1; /* user entered a passphrase */
719 unsigned already_auto_asked
:1; /* asked for passphrase automatically, not again */
720 volatile char passphrase
[100]; /* storage for the entered passphrase */
721 char **passphrase_emailaddr
; /* pointer to allocated storage */
724 * If we are using the Container type it is easiest if we
725 * read in and maintain a list of certs and then write them
726 * out all at once. For Directory type we just leave the data
727 * in the individual files and read the list of files in the
730 SmimeHolderType publictype
;
733 CertList
*publiccertlist
;
734 CertList
*backuppubliccertlist
;
736 SmimeHolderType privatetype
;
738 char *privatecontent
;
739 CertList
*privatecertlist
;
740 CertList
*backupprivatecertlist
;
741 void *personal_certs
; /* this is type (PERSONAL_CERT *) */
743 SmimeHolderType catype
;
746 CertList
*cacertlist
;
747 CertList
*backupcacertlist
;
751 #define BACKUPDATACERT(X) ((X) == Public ? ps_global->smime->backuppubliccertlist : \
752 (X) == Private ? ps_global->smime->backupprivatecertlist : \
753 (X) == CACert ? ps_global->smime->backupcacertlist : \
754 (X) == Password ? (CertList *) ps_global->backuppassword : \
757 #define DATACERT(X) ((X) == Public ? ps_global->smime->publiccertlist : \
758 (X) == Private ? ps_global->smime->privatecertlist : \
759 (X) == CACert ? ps_global->smime->cacertlist : \
760 (X) == Password ? (CertList *) ps_global->pwdcertlist : \
763 #define PATHCERTDIR(X) ((X) == Public ? ps_global->smime->publicpath : \
764 (X) == Private ? ps_global->smime->privatepath : \
765 (X) == CACert ? ps_global->smime->capath : \
766 (X) == Password ? ps_global->pwdcertdir : \
769 #define CONTENTCERTLIST(X) ((X) == Public ? ps_global->smime->publiccontent : \
770 (X) == Private ? ps_global->smime->privatecontent : \
771 (X) == CACert ? ps_global->smime->cacontent : \
772 (X) == Password ? ps_global->pwdcertcontent : \
775 #define SMHOLDERTYPE(X) ((X) == Public ? ps_global->smime->publictype : \
776 (X) == Private ? ps_global->smime->privatetype : \
777 (X) == CACert ? ps_global->smime->catype : \
778 (X) == Password ? Directory : \
781 #define EXTCERT(X) (((X) == Public ? ".crt" \
782 : ((X) == Private ? ".key" \
783 : ((X) == CACert ? ".crt" : ""))))
785 #define DELETEDCERT(X) ((X)->data.deleted)
786 #define RENEWCERT(X) ((X)->data.renew)
787 #define DATEFROMCERT(X) ((X)->data.date_from)
788 #define DATETOCERT(X) ((X)->data.date_to)
789 #define MD5CERT(X) ((X)->data.md5)
794 /* exported prototypes */
797 #endif /* PITH_CONFTYPE_INCLUDED */