1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Account, macro and variable handling.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2013 Steffen "Daode" Nurpmeso <sdaoden@users.sf.net>.
8 * Copyright (c) 1980, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 #ifndef HAVE_AMALGAMATION
45 * HOWTO add a new non-dynamic binary or value option:
46 * - add an entry to nail.h:enum okeys
47 * - run create-okey-map.pl
51 /* Note: changing the hash function must be reflected in create-okey-map.pl */
52 #define MA_PRIME HSHSIZE
53 #define MA_HASH(S) (torek_hash(S) % MA_PRIME)
58 MA_TYPE_MASK
= MA_ACC
,
59 MA_UNDEF
= 1<<1 /* Unlink after lookup */
63 struct macro
*ma_next
;
65 struct mline
*ma_contents
;
66 size_t ma_maxlen
; /* Maximum line length */
67 enum ma_flags ma_flags
;
68 struct var
*ma_localopts
; /* `account' unroll list, for `localopts' */
74 char l_line
[VFIELD_SIZE(sizeof(size_t))];
91 struct lostack
*s_up
; /* Outer context */
92 struct macro
*s_mac
; /* Context (`account' or `define') */
93 struct var
*s_localopts
;
94 bool_t s_unroll
; /* Unroll? */
97 /* Include the constant create-okey-map.pl output */
100 static struct macro
*_acc_curr
; /* Currently active account */
101 static struct lostack
*_localopts
; /* Currently executing macro unroll list */
103 /* TODO once we have a dynamically sized hashtable we could unite _macros and
104 * TODO _variables into a single hashtable, stripping down fun interface;
105 * TODO also, setting and clearing a variable can be easily joined */
106 static struct macro
*_macros
[MA_PRIME
]; /* TODO dynamically spaced */
107 static struct var
*_vars
[MA_PRIME
]; /* TODO dynamically spaced */
109 /* Special cased value string allocation */
110 static char * _vcopy(char const *str
);
111 static void _vfree(char *cp
);
113 /* Check for special housekeeping. */
114 static bool_t
_check_special_vars(char const *name
, bool_t enable
,
117 /* If a variable name begins with a lowercase-character and contains at
118 * least one '@', it is converted to all-lowercase. This is necessary
119 * for lookups of names based on email addresses.
121 * Following the standard, only the part following the last '@' should
122 * be lower-cased, but practice has established otherwise here */
123 static char const * _canonify(char const *vn
);
125 /* Locate a variable and return its variable node */
126 static struct var
* _lookup(char const *name
, ui_it h
, bool_t hisset
);
129 static bool_t
__var_assign(char const *name
, char const *val
);
130 static bool_t
__var_unset(char const *name
);
131 static char * __var_lookup(char const *name
, bool_t look_environ
);
133 /* Line *cp* consists solely of WS and a } */
134 static bool_t
_is_closing_angle(char const *cp
);
136 /* Lookup for macros/accounts */
137 static struct macro
*_malook(char const *name
, struct macro
*data
,
140 /* Walk all lines of a macro and execute() them */
141 static int _maexec(struct macro
const *mp
, struct var
**unroll_store
);
143 /* User display helpers */
144 static int _list_macros(enum ma_flags mafl
);
147 static bool_t
_define1(char const *name
, enum ma_flags mafl
);
148 static void _undef1(char const *name
, enum ma_flags mafl
);
149 static void _freelines(struct mline
*lp
);
151 /* qsort(3) helper */
152 static int __var_list_all_cmp(void const *s1
, void const *s2
);
154 /* Update replay-log */
155 static void _localopts_add(struct lostack
*losp
, char const *name
,
157 static void _localopts_unroll(struct var
**vapp
);
160 _vcopy(char const *str
)
168 len
= strlen(str
) + 1;
170 memcpy(news
, str
, len
);
183 _check_special_vars(char const *name
, bool_t enable
, char **val
)
185 /* TODO _check_special_vars --> value cache
186 * TODO in general: some may not be unset etc. etc. All this shouldn't
187 * TODO be handled like this, but through a generic value-cache interface,
188 * TODO which may apply constaints *before* use; also see below */
193 if (strcmp(name
, "debug") == 0)
195 else if (strcmp(name
, "header") == 0)
196 flag
= OPT_N_FLAG
, enable
= !enable
;
197 else if (strcmp(name
, "skipemptybody") == 0)
199 else if (strcmp(name
, "verbose") == 0)
201 else if (strcmp(name
, "folder") == 0) {
202 rv
= (val
== NULL
|| var_folder_updated(*val
, &cp
));
203 if (rv
&& cp
!= NULL
) {
205 /* It's smalloc()ed, but ensure we don't leak */
214 else if (strcmp(name
, "line-editor-cursor-right") == 0 &&
215 (rv
= (val
!= NULL
&& *val
!= NULL
))) {
216 char const *x
= cp
= *val
;
219 /* Set with no value? *//*TODO invalid,but no way to "re-unset";see above
220 * TODO adjust tty.c when line-editor-cursor-right is properly handled in
224 c
= expand_shell_escape(&x
, FAL0
);
228 } while (*x
!= '\0');
244 _canonify(char const *vn
)
246 if (! upperchar(*vn
)) {
249 for (vp
= vn
; *vp
!= '\0' && *vp
!= '@'; ++vp
)
251 vn
= (*vp
== '@') ? i_strdup(vn
) : vn
;
257 _lookup(char const *name
, ui_it h
, bool_t hisset
)
259 struct var
**vap
, *lvp
, *vp
;
265 for (lvp
= NULL
, vp
= *vap
; vp
!= NULL
; lvp
= vp
, vp
= vp
->v_link
)
266 if (*vp
->v_name
== *name
&& strcmp(vp
->v_name
, name
) == 0) {
267 /* Relink as head, hope it "sorts on usage" over time */
269 lvp
->v_link
= vp
->v_link
;
281 __var_assign(char const *name
, char const *val
)
289 bool_t tmp
= var_clear_allow_undefined
;
290 var_clear_allow_undefined
= TRU1
;
291 err
= __var_unset(name
);
292 var_clear_allow_undefined
= tmp
;
296 name
= _canonify(name
);
298 vp
= _lookup(name
, h
, TRU1
);
300 /* Don't care what happens later on, store this in the unroll list */
301 if (_localopts
!= NULL
)
302 _localopts_add(_localopts
, name
, vp
);
305 vp
= (struct var
*)scalloc(1, sizeof *vp
);
306 vp
->v_name
= _vcopy(name
);
307 vp
->v_link
= _vars
[h
];
312 vp
->v_value
= _vcopy(val
);
314 /* Check if update allowed XXX wasteful on error! */
315 if ((err
= !_check_special_vars(name
, TRU1
, &vp
->v_value
))) {
316 char *cp
= vp
->v_value
;
327 __var_unset(char const *name
)
333 name
= _canonify(name
);
335 vp
= _lookup(name
, h
, TRU1
);
338 if (!sourcing
&& !var_clear_allow_undefined
) {
339 fprintf(stderr
, tr(203, "\"%s\": undefined variable\n"), name
);
343 if (_localopts
!= NULL
)
344 _localopts_add(_localopts
, name
, vp
);
346 /* Always listhead after _lookup() */
347 _vars
[h
] = _vars
[h
]->v_link
;
352 if (!_check_special_vars(name
, FAL0
, NULL
))
361 __var_lookup(char const *name
, bool_t look_environ
)
366 name
= _canonify(name
);
367 if ((vp
= _lookup(name
, 0, FAL0
)) != NULL
)
369 else if (! look_environ
)
371 else if ((rv
= getenv(name
)) != NULL
&& *rv
!= '\0')
377 _is_closing_angle(char const *cp
)
380 while (spacechar(*cp
))
384 while (spacechar(*cp
))
391 static struct macro
*
392 _malook(char const *name
, struct macro
*data
, enum ma_flags mafl
)
394 enum ma_flags save_mafl
;
396 struct macro
*lmp
, *mp
;
399 mafl
&= MA_TYPE_MASK
;
402 for (lmp
= NULL
, mp
= _macros
[h
]; mp
!= NULL
; lmp
= mp
, mp
= mp
->ma_next
) {
403 if ((mp
->ma_flags
& MA_TYPE_MASK
) == mafl
&&
404 strcmp(mp
->ma_name
, name
) == 0) {
405 if (save_mafl
& MA_UNDEF
) {
407 _macros
[h
] = mp
->ma_next
;
409 lmp
->ma_next
= mp
->ma_next
;
416 data
->ma_next
= _macros
[h
];
425 _maexec(struct macro
const *mp
, struct var
**unroll_store
)
429 struct mline
const *lp
;
430 char *buf
= ac_alloc(mp
->ma_maxlen
+ 1);
432 los
.s_up
= _localopts
;
433 los
.s_mac
= UNCONST(mp
);
434 los
.s_localopts
= NULL
;
438 for (lp
= mp
->ma_contents
; lp
; lp
= lp
->l_next
) {
439 var_clear_allow_undefined
= TRU1
;
440 memcpy(buf
, lp
->l_line
, lp
->l_length
+ 1);
441 rv
|= execute(buf
, 0, lp
->l_length
); /* XXX break if != 0 ? */
442 var_clear_allow_undefined
= FAL0
;
445 _localopts
= los
.s_up
;
446 if (unroll_store
== NULL
)
447 _localopts_unroll(&los
.s_localopts
);
449 *unroll_store
= los
.s_localopts
;
456 _list_macros(enum ma_flags mafl
)
465 if ((fp
= Ftemp(&cp
, "Ra", "w+", 0600, 1)) == NULL
) {
472 mafl
&= MA_TYPE_MASK
;
473 typestr
= (mafl
& MA_ACC
) ? "account" : "define";
475 for (ti
= mc
= 0; ti
< MA_PRIME
; ++ti
)
476 for (mq
= _macros
[ti
]; mq
; mq
= mq
->ma_next
)
477 if ((mq
->ma_flags
& MA_TYPE_MASK
) == mafl
) {
480 fprintf(fp
, "%s %s {\n", typestr
, mq
->ma_name
);
481 for (lp
= mq
->ma_contents
; lp
; lp
= lp
->l_next
)
482 fprintf(fp
, " %s\n", lp
->l_line
);
486 page_or_print(fp
, 0);
488 mc
= (ui_it
)ferror(fp
);
494 _define1(char const *name
, enum ma_flags mafl
)
498 struct mline
*lp
, *lst
= NULL
, *lnd
= NULL
;
499 char *linebuf
= NULL
, *cp
;
500 size_t linesize
= 0, maxlen
= 0;
503 mp
= scalloc(1, sizeof *mp
);
504 mp
->ma_name
= sstrdup(name
);
508 n
= readline_input(LNED_LF_ESC
, "", &linebuf
, &linesize
);
510 fprintf(stderr
, tr(75, "Unterminated %s definition: \"%s\".\n"),
511 (mafl
& MA_ACC
? "account" : "macro"), mp
->ma_name
);
516 if (_is_closing_angle(linebuf
))
520 for (cp
= linebuf
, i
= 0; i
< n
; ++cp
, ++i
)
521 if (! whitechar(*cp
))
526 while (whitechar(cp
[n
- 1]))
532 maxlen
= MAX(maxlen
, (size_t)n
);
535 lp
= scalloc(1, sizeof(*lp
) - VFIELD_SIZEOF(struct mline
, l_line
) + n
);
536 memcpy(lp
->l_line
, cp
, n
);
537 lp
->l_length
= (size_t)--n
;
544 mp
->ma_contents
= lst
;
545 mp
->ma_maxlen
= maxlen
;
547 if (_malook(mp
->ma_name
, mp
, mafl
) != NULL
) {
548 if (! (mafl
& MA_ACC
)) {
549 fprintf(stderr
, tr(76, "A macro named \"%s\" already exists.\n"),
551 lst
= mp
->ma_contents
;
554 _undef1(mp
->ma_name
, MA_ACC
);
555 _malook(mp
->ma_name
, mp
, MA_ACC
);
572 _undef1(char const *name
, enum ma_flags mafl
)
576 if ((mp
= _malook(name
, NULL
, mafl
| MA_UNDEF
)) != NULL
) {
577 _freelines(mp
->ma_contents
);
584 _freelines(struct mline
*lp
)
588 for (lq
= NULL
; lp
!= NULL
; ) {
599 __var_list_all_cmp(void const *s1
, void const *s2
)
601 return strcmp(*(char**)UNCONST(s1
), *(char**)UNCONST(s2
));
605 _localopts_add(struct lostack
*losp
, char const *name
, struct var
*ovap
)
610 /* Propagate unrolling up the stack, as necessary */
611 while (! losp
->s_unroll
&& (losp
= losp
->s_up
) != NULL
)
616 /* We have found a level that wants to unroll; check wether it does it yet */
617 for (vap
= losp
->s_localopts
; vap
!= NULL
; vap
= vap
->v_link
)
618 if (strcmp(vap
->v_name
, name
) == 0)
621 nl
= strlen(name
) + 1;
622 vl
= (ovap
!= NULL
) ? strlen(ovap
->v_value
) + 1 : 0;
623 vap
= smalloc(sizeof(*vap
) + nl
+ vl
);
624 vap
->v_link
= losp
->s_localopts
;
625 losp
->s_localopts
= vap
;
626 vap
->v_name
= (char*)(vap
+ 1);
627 memcpy(vap
->v_name
, name
, nl
);
631 vap
->v_value
= (char*)(vap
+ 1) + nl
;
632 memcpy(vap
->v_value
, ovap
->v_value
, vl
);
639 _localopts_unroll(struct var
**vapp
)
641 struct lostack
*save_los
;
647 save_los
= _localopts
;
649 while (vap
!= NULL
) {
652 __var_assign(x
->v_name
, x
->v_value
);
655 _localopts
= save_los
;
659 _var_oklook(enum okeys okey
)
661 char const *k
= _var_keydat
+ _var_map
[okey
].vm_keyoff
;
663 return __var_lookup(k
, TRU1
);
667 _var_okset(enum okeys okey
, uintptr_t val
)
669 char const *k
= _var_keydat
+ _var_map
[okey
].vm_keyoff
;
671 return __var_assign(k
, (val
== 0x1) ? "" : (char const*)val
);
675 _var_okclear(enum okeys okey
)
677 char const *k
= _var_keydat
+ _var_map
[okey
].vm_keyoff
;
679 return __var_unset(k
);
683 _var_voklook(char const *vokey
)
685 return __var_lookup(vokey
, TRU1
);
689 _var_vokset(char const *vokey
, uintptr_t val
)
691 return __var_assign(vokey
, (val
== 0x1) ? "" : (char const*)val
);
695 _var_vokclear(char const *vokey
)
697 return __var_unset(vokey
);
704 char *cp
, **vacp
, **cap
;
709 if ((fp
= Ftemp(&cp
, "Ra", "w+", 0600, 1)) == NULL
) {
716 for (no
= i
= 0; i
< MA_PRIME
; ++i
)
717 for (vp
= _vars
[i
]; vp
!= NULL
; vp
= vp
->v_link
)
719 vacp
= salloc(no
* sizeof(*vacp
));
720 for (cap
= vacp
, i
= 0; i
< MA_PRIME
; ++i
)
721 for (vp
= _vars
[i
]; vp
!= NULL
; vp
= vp
->v_link
)
725 qsort(vacp
, no
, sizeof *vacp
, &__var_list_all_cmp
);
727 i
= (ok_blook(bsdcompat
) || ok_blook(bsdset
));
728 fmt
= (i
!= 0) ? "%s\t%s\n" : "%s=\"%s\"\n";
730 for (cap
= vacp
; no
!= 0; ++cap
, --no
) {
731 cp
= vok_vlook(*cap
); /* XXX when lookup checks value/binary, change */
734 if (i
|| *cp
!= '\0')
735 fprintf(fp
, fmt
, *cap
, cp
);
737 fprintf(fp
, "%s\n", *cap
);
740 page_or_print(fp
, (size_t)(cap
- vacp
));
753 if (args
[0] == NULL
) {
754 errs
= tr(504, "Missing macro name to `define'");
757 if (args
[1] == NULL
|| strcmp(args
[1], "{") || args
[2] != NULL
) {
758 errs
= tr(505, "Syntax is: define <name> {");
761 rv
= ! _define1(args
[0], MA_NONE
);
765 fprintf(stderr
, "%s\n", errs
);
776 fprintf(stderr
, tr(506, "Missing macro name to `undef'\n"));
780 _undef1(*args
, MA_NONE
);
792 char const *errs
, *name
;
795 if (args
[0] == NULL
|| (args
[1] != NULL
&& args
[2] != NULL
)) {
796 errs
= tr(507, "Syntax is: call <%s>\n");
801 if ((mp
= _malook(*args
, NULL
, MA_NONE
)) == NULL
) {
802 errs
= tr(508, "Undefined macro called: \"%s\"\n");
807 rv
= _maexec(mp
, NULL
);
811 fprintf(stderr
, errs
, name
);
816 callhook(char const *name
, int nmail
)
822 var
= ac_alloc(len
= strlen(name
) + 13);
823 snprintf(var
, len
, "folder-hook-%s", name
);
824 if ((cp
= vok_vlook(var
)) == NULL
&& (cp
= ok_vlook(folder_hook
)) == NULL
) {
828 if ((mp
= _malook(cp
, NULL
, MA_NONE
)) == NULL
) {
829 fprintf(stderr
, tr(49, "Cannot call hook for folder \"%s\": "
830 "Macro \"%s\" does not exist.\n"), name
, cp
);
835 inhook
= nmail
? 3 : 1;
836 rv
= _maexec(mp
, NULL
);
847 return _list_macros(MA_NONE
);
855 int rv
= 1, i
, oqf
, nqf
;
857 if (args
[0] == NULL
) {
858 rv
= _list_macros(MA_ACC
);
862 if (args
[1] && args
[1][0] == '{' && args
[1][1] == '\0') {
863 if (args
[2] != NULL
) {
864 fprintf(stderr
, tr(517, "Syntax is: account <name> {\n"));
867 if (asccasecmp(args
[0], ACCOUNT_NULL
) == 0) {
868 fprintf(stderr
, tr(521, "Error: `%s' is a reserved name.\n"),
872 rv
= ! _define1(args
[0], MA_ACC
);
877 fprintf(stderr
, tr(518, "Cannot change account from within a hook.\n"));
881 save_mbox_for_possible_quitstuff();
884 if (asccasecmp(args
[0], ACCOUNT_NULL
) != 0 &&
885 (mp
= _malook(args
[0], NULL
, MA_ACC
)) == NULL
) {
886 fprintf(stderr
, tr(519, "Account `%s' does not exist.\n"), args
[0]);
890 oqf
= savequitflags();
891 if (_acc_curr
!= NULL
)
892 _localopts_unroll(&_acc_curr
->ma_localopts
);
893 account_name
= (mp
!= NULL
) ? mp
->ma_name
: NULL
;
896 if (mp
!= NULL
&& _maexec(mp
, &mp
->ma_localopts
) == CBAD
) {
897 /* XXX account switch incomplete, unroll? */
898 fprintf(stderr
, tr(520, "Switching to account `%s' failed.\n"), args
[0]);
902 if (! starting
&& ! inhook
) {
903 nqf
= savequitflags(); /* TODO obsolete (leave -> void -> new box!) */
904 restorequitflags(oqf
);
905 if ((i
= setfile("%", 0)) < 0)
907 callhook(mailname
, 0);
908 if (i
> 0 && !ok_blook(emptystart
))
910 announce(ok_blook(bsdcompat
) || ok_blook(bsdannounce
));
911 restorequitflags(nqf
);
924 if (_localopts
== NULL
) {
925 fprintf(stderr
, tr(522,
926 "Cannot use `localopts' but from within a `define' or `account'\n"));
930 _localopts
->s_unroll
= (**c
== '0') ? FAL0
: TRU1
;
936 /* vim:set fenc=utf-8:s-it-mode */