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 * TODO in general it would be nice if it would be possible to define "macros"
46 * TODO etc. inside of other "macros"
49 #define MA_PRIME HSHSIZE
50 #define MA_HASH(S) (strhash(S) % MA_PRIME)
55 MA_TYPE_MASK
= MA_ACC
,
56 MA_UNDEF
= 1<<1 /* Unlink after lookup */
60 struct macro
*ma_next
;
62 struct mline
*ma_contents
;
63 size_t ma_maxlen
; /* Maximum line length */
64 enum ma_flags ma_flags
;
65 struct var
*ma_localopts
; /* `account' unroll list, for `localopts' */
71 char l_line
[VFIELD_SIZE(sizeof(size_t))];
81 struct lostack
*s_up
; /* Outer context */
82 struct macro
*s_mac
; /* Context (`account' or `define') */
83 struct var
*s_localopts
;
84 bool_t s_unroll
; /* Unroll? */
87 static struct macro
*_acc_curr
; /* Currently active account */
88 static struct lostack
*_localopts
; /* Currently executing macro unroll list */
90 /* TODO once we have a dynamically sized hashtable we could unite _macros and
91 * TODO _variables into a single hashtable, stripping down fun interface;
92 * TODO also, setting and clearing a variable can be easily joined */
93 static struct macro
*_macros
[MA_PRIME
]; /* TODO dynamically spaced */
94 static struct var
*_vars
[MA_PRIME
]; /* TODO dynamically spaced */
96 /* Special cased value string allocation */
97 static char * _vcopy(char const *str
);
98 static void _vfree(char *cp
);
100 /* Check for special housekeeping. */
101 static bool_t
_check_special_vars(char const *name
, bool_t enable
,
104 /* If a variable name begins with a lowercase-character and contains at
105 * least one '@', it is converted to all-lowercase. This is necessary
106 * for lookups of names based on email addresses.
108 * Following the standard, only the part following the last '@' should
109 * be lower-cased, but practice has established otherwise here */
110 static char const * _canonify(char const *vn
);
112 /* Locate a variable and return its variable node */
113 static struct var
* _lookup(char const *name
, ui_it h
, bool_t hisset
);
115 /* Line *cp* consists solely of WS and a } */
116 static bool_t
_is_closing_angle(char const *cp
);
118 /* Lookup for macros/accounts */
119 static struct macro
*_malook(char const *name
, struct macro
*data
,
122 /* Walk all lines of a macro and execute() them */
123 static int _maexec(struct macro
const *mp
, struct var
**unroll_store
);
125 /* User display helpers */
126 static int _list_macros(enum ma_flags mafl
);
129 static bool_t
_define1(char const *name
, enum ma_flags mafl
);
130 static void _undef1(char const *name
, enum ma_flags mafl
);
131 static void _freelines(struct mline
*lp
);
133 /* qsort(3) helper */
134 static int __var_list_all_cmp(void const *s1
, void const *s2
);
136 /* Update replay-log */
137 static void _localopts_add(struct lostack
*losp
, char const *name
,
139 static void _localopts_unroll(struct var
**vapp
);
142 _vcopy(char const *str
)
150 len
= strlen(str
) + 1;
152 memcpy(news
, str
, len
);
165 _check_special_vars(char const *name
, bool_t enable
, char **val
)
167 /* TODO _check_special_vars --> value cache
168 * TODO in general: some may not be unset etc. etc. All this shouldn't
169 * TODO be handled like this, but through a generic value-cache interface,
170 * TODO which may apply constaints *before* use; also see below */
175 if (strcmp(name
, "debug") == 0)
177 else if (strcmp(name
, "header") == 0)
178 flag
= OPT_N_FLAG
, enable
= !enable
;
179 else if (strcmp(name
, "skipemptybody") == 0)
181 else if (strcmp(name
, "verbose") == 0)
183 else if (strcmp(name
, "prompt") == 0)
184 flag
= OPT_NOPROMPT
, enable
= !enable
;
185 else if (strcmp(name
, "folder") == 0) {
186 rv
= (val
== NULL
|| var_folder_updated(*val
, &cp
));
187 if (rv
&& cp
!= NULL
) {
189 /* It's smalloc()ed, but ensure we don't leak */
198 else if (strcmp(name
, "line-editor-cursor-right") == 0 &&
199 (rv
= (val
!= NULL
&& *val
!= NULL
))) {
200 char const *x
= cp
= *val
;
203 /* Set with no value? *//*TODO invalid,but no way to "re-unset";see above
204 * TODO adjust tty.c when line-editor-cursor-right is properly handled in
208 c
= expand_shell_escape(&x
, FAL0
);
212 } while (*x
!= '\0');
228 _canonify(char const *vn
)
230 if (! upperchar(*vn
)) {
233 for (vp
= vn
; *vp
!= '\0' && *vp
!= '@'; ++vp
)
235 vn
= (*vp
== '@') ? i_strdup(vn
) : vn
;
241 _lookup(char const *name
, ui_it h
, bool_t hisset
)
243 struct var
**vap
, *lvp
, *vp
;
249 for (lvp
= NULL
, vp
= *vap
; vp
!= NULL
; lvp
= vp
, vp
= vp
->v_link
)
250 if (*vp
->v_name
== *name
&& strcmp(vp
->v_name
, name
) == 0) {
251 /* Relink as head, hope it "sorts on usage" over time */
253 lvp
->v_link
= vp
->v_link
;
265 _is_closing_angle(char const *cp
)
268 while (spacechar(*cp
))
272 while (spacechar(*cp
))
279 static struct macro
*
280 _malook(char const *name
, struct macro
*data
, enum ma_flags mafl
)
282 enum ma_flags save_mafl
;
284 struct macro
*lmp
, *mp
;
287 mafl
&= MA_TYPE_MASK
;
290 for (lmp
= NULL
, mp
= _macros
[h
]; mp
!= NULL
; lmp
= mp
, mp
= mp
->ma_next
) {
291 if ((mp
->ma_flags
& MA_TYPE_MASK
) == mafl
&&
292 strcmp(mp
->ma_name
, name
) == 0) {
293 if (save_mafl
& MA_UNDEF
) {
295 _macros
[h
] = mp
->ma_next
;
297 lmp
->ma_next
= mp
->ma_next
;
304 data
->ma_next
= _macros
[h
];
313 _maexec(struct macro
const *mp
, struct var
**unroll_store
)
317 struct mline
const *lp
;
318 char *buf
= ac_alloc(mp
->ma_maxlen
+ 1);
320 los
.s_up
= _localopts
;
321 los
.s_mac
= UNCONST(mp
);
322 los
.s_localopts
= NULL
;
326 for (lp
= mp
->ma_contents
; lp
; lp
= lp
->l_next
) {
327 unset_allow_undefined
= TRU1
;
328 memcpy(buf
, lp
->l_line
, lp
->l_length
+ 1);
329 rv
|= execute(buf
, 0, lp
->l_length
); /* XXX break if != 0 ? */
330 unset_allow_undefined
= FAL0
;
333 _localopts
= los
.s_up
;
334 if (unroll_store
== NULL
)
335 _localopts_unroll(&los
.s_localopts
);
337 *unroll_store
= los
.s_localopts
;
344 _list_macros(enum ma_flags mafl
)
353 if ((fp
= Ftemp(&cp
, "Ra", "w+", 0600, 1)) == NULL
) {
360 mafl
&= MA_TYPE_MASK
;
361 typestr
= (mafl
& MA_ACC
) ? "account" : "define";
363 for (ti
= mc
= 0; ti
< MA_PRIME
; ++ti
)
364 for (mq
= _macros
[ti
]; mq
; mq
= mq
->ma_next
)
365 if ((mq
->ma_flags
& MA_TYPE_MASK
) == mafl
) {
368 fprintf(fp
, "%s %s {\n", typestr
, mq
->ma_name
);
369 for (lp
= mq
->ma_contents
; lp
; lp
= lp
->l_next
)
370 fprintf(fp
, " %s\n", lp
->l_line
);
374 page_or_print(fp
, 0);
376 mc
= (ui_it
)ferror(fp
);
382 _define1(char const *name
, enum ma_flags mafl
)
386 struct mline
*lp
, *lst
= NULL
, *lnd
= NULL
;
387 char *linebuf
= NULL
, *cp
;
388 size_t linesize
= 0, maxlen
= 0;
391 mp
= scalloc(1, sizeof *mp
);
392 mp
->ma_name
= sstrdup(name
);
396 n
= readline_input(LNED_LF_ESC
, "", &linebuf
, &linesize
);
398 fprintf(stderr
, tr(75, "Unterminated %s definition: \"%s\".\n"),
399 (mafl
& MA_ACC
? "account" : "macro"), mp
->ma_name
);
404 if (_is_closing_angle(linebuf
))
408 for (cp
= linebuf
, i
= 0; i
< n
; ++cp
, ++i
)
409 if (! whitechar(*cp
))
414 while (whitechar(cp
[n
- 1]))
420 maxlen
= MAX(maxlen
, (size_t)n
);
423 lp
= scalloc(1, sizeof(*lp
) - VFIELD_SIZEOF(struct mline
, l_line
) + n
);
424 memcpy(lp
->l_line
, cp
, n
);
425 lp
->l_length
= (size_t)--n
;
432 mp
->ma_contents
= lst
;
433 mp
->ma_maxlen
= maxlen
;
435 if (_malook(mp
->ma_name
, mp
, mafl
) != NULL
) {
436 if (! (mafl
& MA_ACC
)) {
437 fprintf(stderr
, tr(76, "A macro named \"%s\" already exists.\n"),
439 lst
= mp
->ma_contents
;
442 _undef1(mp
->ma_name
, MA_ACC
);
443 _malook(mp
->ma_name
, mp
, MA_ACC
);
460 _undef1(char const *name
, enum ma_flags mafl
)
464 if ((mp
= _malook(name
, NULL
, mafl
| MA_UNDEF
)) != NULL
) {
465 _freelines(mp
->ma_contents
);
472 _freelines(struct mline
*lp
)
476 for (lq
= NULL
; lp
!= NULL
; ) {
487 __var_list_all_cmp(void const *s1
, void const *s2
)
489 return strcmp(*(char**)UNCONST(s1
), *(char**)UNCONST(s2
));
493 _localopts_add(struct lostack
*losp
, char const *name
, struct var
*ovap
)
498 /* Propagate unrolling up the stack, as necessary */
499 while (! losp
->s_unroll
&& (losp
= losp
->s_up
) != NULL
)
504 /* We have found a level that wants to unroll; check wether it does it yet */
505 for (vap
= losp
->s_localopts
; vap
!= NULL
; vap
= vap
->v_link
)
506 if (strcmp(vap
->v_name
, name
) == 0)
509 nl
= strlen(name
) + 1;
510 vl
= (ovap
!= NULL
) ? strlen(ovap
->v_value
) + 1 : 0;
511 vap
= smalloc(sizeof(*vap
) + nl
+ vl
);
512 vap
->v_link
= losp
->s_localopts
;
513 losp
->s_localopts
= vap
;
514 vap
->v_name
= (char*)(vap
+ 1);
515 memcpy(vap
->v_name
, name
, nl
);
519 vap
->v_value
= (char*)(vap
+ 1) + nl
;
520 memcpy(vap
->v_value
, ovap
->v_value
, vl
);
527 _localopts_unroll(struct var
**vapp
)
529 struct lostack
*save_los
;
535 save_los
= _localopts
;
537 while (vap
!= NULL
) {
540 var_assign(x
->v_name
, x
->v_value
);
543 _localopts
= save_los
;
547 var_assign(char const *name
, char const *val
)
555 bool_t tmp
= unset_allow_undefined
;
556 unset_allow_undefined
= TRU1
;
557 err
= var_unset(name
);
558 unset_allow_undefined
= tmp
;
562 name
= _canonify(name
);
564 vp
= _lookup(name
, h
, TRU1
);
566 /* Don't care what happens later on, store this in the unroll list */
567 if (_localopts
!= NULL
)
568 _localopts_add(_localopts
, name
, vp
);
571 vp
= (struct var
*)scalloc(1, sizeof *vp
);
572 vp
->v_name
= _vcopy(name
);
573 vp
->v_link
= _vars
[h
];
578 vp
->v_value
= _vcopy(val
);
580 /* Check if update allowed XXX wasteful on error! */
581 if ((err
= !_check_special_vars(name
, TRU1
, &vp
->v_value
))) {
582 char *cp
= vp
->v_value
;
593 var_unset(char const *name
)
599 name
= _canonify(name
);
601 vp
= _lookup(name
, h
, TRU1
);
604 if (!sourcing
&& !unset_allow_undefined
) {
605 fprintf(stderr
, tr(203, "\"%s\": undefined variable\n"), name
);
609 if (_localopts
!= NULL
)
610 _localopts_add(_localopts
, name
, vp
);
612 /* Always listhead after _lookup() */
613 _vars
[h
] = _vars
[h
]->v_link
;
618 if (!_check_special_vars(name
, FAL0
, NULL
))
627 var_lookup(char const *name
, bool_t look_environ
)
632 name
= _canonify(name
);
633 if ((vp
= _lookup(name
, 0, FAL0
)) != NULL
)
635 else if (! look_environ
)
637 else if ((rv
= getenv(name
)) != NULL
&& *rv
!= '\0')
646 char *cp
, **vacp
, **cap
;
651 if ((fp
= Ftemp(&cp
, "Ra", "w+", 0600, 1)) == NULL
) {
658 for (no
= i
= 0; i
< MA_PRIME
; ++i
)
659 for (vp
= _vars
[i
]; vp
!= NULL
; vp
= vp
->v_link
)
661 vacp
= salloc(no
* sizeof(*vacp
));
662 for (cap
= vacp
, i
= 0; i
< MA_PRIME
; ++i
)
663 for (vp
= _vars
[i
]; vp
!= NULL
; vp
= vp
->v_link
)
667 qsort(vacp
, no
, sizeof *vacp
, &__var_list_all_cmp
);
669 i
= (boption("bsdcompat") || boption("bsdset"));
670 fmt
= (i
!= 0) ? "%s\t%s\n" : "%s=\"%s\"\n";
672 for (cap
= vacp
; no
!= 0; ++cap
, --no
) {
673 cp
= value(*cap
); /* TODO internal lookup; binary? value? */
676 if (i
|| *cp
!= '\0')
677 fprintf(fp
, fmt
, *cap
, cp
);
679 fprintf(fp
, "%s\n", *cap
);
682 page_or_print(fp
, (size_t)(cap
- vacp
));
695 if (args
[0] == NULL
) {
696 errs
= tr(504, "Missing macro name to `define'");
699 if (args
[1] == NULL
|| strcmp(args
[1], "{") || args
[2] != NULL
) {
700 errs
= tr(505, "Syntax is: define <name> {");
703 rv
= ! _define1(args
[0], MA_NONE
);
707 fprintf(stderr
, "%s\n", errs
);
718 fprintf(stderr
, tr(506, "Missing macro name to `undef'\n"));
722 _undef1(*args
, MA_NONE
);
734 char const *errs
, *name
;
737 if (args
[0] == NULL
|| (args
[1] != NULL
&& args
[2] != NULL
)) {
738 errs
= tr(507, "Syntax is: call <%s>\n");
743 if ((mp
= _malook(*args
, NULL
, MA_NONE
)) == NULL
) {
744 errs
= tr(508, "Undefined macro called: \"%s\"\n");
749 rv
= _maexec(mp
, NULL
);
753 fprintf(stderr
, errs
, name
);
758 callhook(char const *name
, int nmail
)
764 var
= ac_alloc(len
= strlen(name
) + 13);
765 snprintf(var
, len
, "folder-hook-%s", name
);
766 if ((cp
= value(var
)) == NULL
&& (cp
= value("folder-hook")) == NULL
) {
770 if ((mp
= _malook(cp
, NULL
, MA_NONE
)) == NULL
) {
771 fprintf(stderr
, tr(49, "Cannot call hook for folder \"%s\": "
772 "Macro \"%s\" does not exist.\n"), name
, cp
);
777 inhook
= nmail
? 3 : 1;
778 rv
= _maexec(mp
, NULL
);
789 return _list_macros(MA_NONE
);
797 int rv
= 1, i
, oqf
, nqf
;
799 if (args
[0] == NULL
) {
800 rv
= _list_macros(MA_ACC
);
804 if (args
[1] && args
[1][0] == '{' && args
[1][1] == '\0') {
805 if (args
[2] != NULL
) {
806 fprintf(stderr
, tr(517, "Syntax is: account <name> {\n"));
809 if (asccasecmp(args
[0], ACCOUNT_NULL
) == 0) {
810 fprintf(stderr
, tr(521, "Error: `%s' is a reserved name.\n"),
814 rv
= ! _define1(args
[0], MA_ACC
);
819 fprintf(stderr
, tr(518, "Cannot change account from within a hook.\n"));
823 save_mbox_for_possible_quitstuff();
826 if (asccasecmp(args
[0], ACCOUNT_NULL
) != 0 &&
827 (mp
= _malook(args
[0], NULL
, MA_ACC
)) == NULL
) {
828 fprintf(stderr
, tr(519, "Account `%s' does not exist.\n"), args
[0]);
832 oqf
= savequitflags();
833 if (_acc_curr
!= NULL
)
834 _localopts_unroll(&_acc_curr
->ma_localopts
);
835 account_name
= (mp
!= NULL
) ? mp
->ma_name
: NULL
;
838 if (mp
!= NULL
&& _maexec(mp
, &mp
->ma_localopts
) == CBAD
) {
839 /* XXX account switch incomplete, unroll? */
840 fprintf(stderr
, tr(520, "Switching to account `%s' failed.\n"), args
[0]);
844 if (! starting
&& ! inhook
) {
845 nqf
= savequitflags(); /* TODO obsolete (leave -> void -> new box!) */
846 restorequitflags(oqf
);
847 if ((i
= setfile("%", 0)) < 0)
849 callhook(mailname
, 0);
850 if (i
> 0 && ! boption("emptystart"))
852 announce(boption("bsdcompat") || boption("bsdannounce"));
853 restorequitflags(nqf
);
866 if (_localopts
== NULL
) {
867 fprintf(stderr
, tr(522,
868 "Cannot use `localopts' but from within a `define' or `account'\n"));
872 _localopts
->s_unroll
= (**c
== '0') ? FAL0
: TRU1
;
878 /* vim:set fenc=utf-8:s-it-mode */