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
43 * TODO in general it would be nice if it would be possible to define "macros"
44 * TODO etc. inside of other "macros"
47 #define MA_PRIME HSHSIZE
48 #define MA_HASH(S) (strhash(S) % MA_PRIME)
53 MA_TYPE_MASK
= MA_ACC
,
54 MA_UNDEF
= 1<<1 /* Unlink after lookup */
58 struct macro
*ma_next
;
60 struct line
*ma_contents
;
61 size_t ma_maxlen
; /* Maximum line length */
62 enum ma_flags ma_flags
;
63 struct var
*ma_localopts
; /* `account' unroll list, for `localopts' */
69 char l_line
[VFIELD_SIZE(sizeof(size_t))];
79 struct lostack
*s_up
; /* Outer context */
80 struct macro
*s_mac
; /* Context (`account' or `define') */
81 struct var
*s_localopts
;
82 bool_t s_unroll
; /* Unroll? */
85 static struct macro
*_acc_curr
; /* Currently active account */
86 static struct lostack
*_localopts
; /* Currently executing macro unroll list */
88 /* TODO once we have a dynamically sized hashtable we could unite _macros and
89 * TODO _variables into a single hashtable, stripping down fun interface;
90 * TODO also, setting and clearing a variable can be easily joined */
91 static struct macro
*_macros
[MA_PRIME
]; /* TODO dynamically spaced */
92 static struct var
*_vars
[MA_PRIME
]; /* TODO dynamically spaced */
94 /* Special cased value string allocation */
95 static char * _vcopy(char const *str
);
96 static void _vfree(char *cp
);
98 /* Check for special housekeeping. */
99 static bool_t
_check_special_vars(char const *name
, bool_t enable
,
102 /* If a variable name begins with a lowercase-character and contains at
103 * least one '@', it is converted to all-lowercase. This is necessary
104 * for lookups of names based on email addresses.
106 * Following the standard, only the part following the last '@' should
107 * be lower-cased, but practice has established otherwise here */
108 static char const * _canonify(char const *vn
);
110 /* Locate a variable and return its variable node */
111 static struct var
* _lookup(char const *name
, ui_it h
, bool_t hisset
);
113 /* Line *cp* consists solely of WS and a } */
114 static bool_t
_is_closing_angle(char const *cp
);
116 /* Lookup for macros/accounts */
117 static struct macro
*_malook(char const *name
, struct macro
*data
,
120 /* Walk all lines of a macro and execute() them */
121 static int _maexec(struct macro
const *mp
, struct var
**unroll_store
);
123 /* User display helpers */
124 static int _list_macros(enum ma_flags mafl
);
127 static bool_t
_define1(char const *name
, enum ma_flags mafl
);
128 static void _undef1(char const *name
, enum ma_flags mafl
);
129 static void _freelines(struct line
*lp
);
131 /* qsort(3) helper */
132 static int __var_list_all_cmp(void const *s1
, void const *s2
);
134 /* Update replay-log */
135 static void _localopts_add(struct lostack
*losp
, char const *name
,
137 static void _localopts_unroll(struct var
**vapp
);
140 _vcopy(char const *str
)
148 len
= strlen(str
) + 1;
150 memcpy(news
, str
, len
);
163 _check_special_vars(char const *name
, bool_t enable
, char **val
)
165 /* TODO _check_special_vars --> value cache */
170 if (strcmp(name
, "debug") == 0)
172 else if (strcmp(name
, "header") == 0)
173 flag
= OPT_N_FLAG
, enable
= ! enable
;
174 else if (strcmp(name
, "skipemptybody") == 0)
176 else if (strcmp(name
, "verbose") == 0)
178 else if (strcmp(name
, "prompt") == 0)
179 flag
= OPT_NOPROMPT
, enable
= ! enable
;
180 else if (strcmp(name
, "folder") == 0) {
181 rv
= var_folder_updated(*val
, &cp
);
182 if (rv
&& cp
!= NULL
) {
184 /* It's smalloc()ed, but ensure we don't leak */
193 else if (strcmp(name
, "line-editor-cursor-right") == 0) {
194 char const *x
= cp
= *val
;
197 c
= expand_shell_escape(&x
, FAL0
);
216 _canonify(char const *vn
)
218 if (! upperchar(*vn
)) {
221 for (vp
= vn
; *vp
!= '\0' && *vp
!= '@'; ++vp
)
223 vn
= (*vp
== '@') ? i_strdup(vn
) : vn
;
229 _lookup(char const *name
, ui_it h
, bool_t hisset
)
231 struct var
**vap
, *lvp
, *vp
;
237 for (lvp
= NULL
, vp
= *vap
; vp
!= NULL
; lvp
= vp
, vp
= vp
->v_link
)
238 if (*vp
->v_name
== *name
&& strcmp(vp
->v_name
, name
) == 0) {
239 /* Relink as head, hope it "sorts on usage" over time */
241 lvp
->v_link
= vp
->v_link
;
253 _is_closing_angle(char const *cp
)
256 while (spacechar(*cp
))
260 while (spacechar(*cp
))
267 static struct macro
*
268 _malook(char const *name
, struct macro
*data
, enum ma_flags mafl
)
270 enum ma_flags save_mafl
;
272 struct macro
*lmp
, *mp
;
275 mafl
&= MA_TYPE_MASK
;
278 for (lmp
= NULL
, mp
= _macros
[h
]; mp
!= NULL
; lmp
= mp
, mp
= mp
->ma_next
) {
279 if ((mp
->ma_flags
& MA_TYPE_MASK
) == mafl
&&
280 strcmp(mp
->ma_name
, name
) == 0) {
281 if (save_mafl
& MA_UNDEF
) {
283 _macros
[h
] = mp
->ma_next
;
285 lmp
->ma_next
= mp
->ma_next
;
292 data
->ma_next
= _macros
[h
];
301 _maexec(struct macro
const *mp
, struct var
**unroll_store
)
305 struct line
const *lp
;
306 char *buf
= ac_alloc(mp
->ma_maxlen
+ 1);
308 los
.s_up
= _localopts
;
309 los
.s_mac
= UNCONST(mp
);
310 los
.s_localopts
= NULL
;
314 for (lp
= mp
->ma_contents
; lp
; lp
= lp
->l_next
) {
315 unset_allow_undefined
= TRU1
;
316 memcpy(buf
, lp
->l_line
, lp
->l_length
+ 1);
317 rv
|= execute(buf
, 0, lp
->l_length
); /* XXX break if != 0 ? */
318 unset_allow_undefined
= FAL0
;
321 _localopts
= los
.s_up
;
322 if (unroll_store
== NULL
)
323 _localopts_unroll(&los
.s_localopts
);
325 *unroll_store
= los
.s_localopts
;
332 _list_macros(enum ma_flags mafl
)
341 if ((fp
= Ftemp(&cp
, "Ra", "w+", 0600, 1)) == NULL
) {
348 mafl
&= MA_TYPE_MASK
;
349 typestr
= (mafl
& MA_ACC
) ? "account" : "define";
351 for (ti
= mc
= 0; ti
< MA_PRIME
; ++ti
)
352 for (mq
= _macros
[ti
]; mq
; mq
= mq
->ma_next
)
353 if ((mq
->ma_flags
& MA_TYPE_MASK
) == mafl
) {
356 fprintf(fp
, "%s %s {\n", typestr
, mq
->ma_name
);
357 for (lp
= mq
->ma_contents
; lp
; lp
= lp
->l_next
)
358 fprintf(fp
, " %s\n", lp
->l_line
);
362 page_or_print(fp
, 0);
364 mc
= (ui_it
)ferror(fp
);
370 _define1(char const *name
, enum ma_flags mafl
)
374 struct line
*lp
, *lst
= NULL
, *lnd
= NULL
;
375 char *linebuf
= NULL
, *cp
;
376 size_t linesize
= 0, maxlen
= 0;
379 mp
= scalloc(1, sizeof *mp
);
380 mp
->ma_name
= sstrdup(name
);
384 n
= readline_input(LNED_LF_ESC
, "", &linebuf
, &linesize
);
386 fprintf(stderr
, tr(75, "Unterminated %s definition: \"%s\".\n"),
387 (mafl
& MA_ACC
? "account" : "macro"), mp
->ma_name
);
392 if (_is_closing_angle(linebuf
))
396 for (cp
= linebuf
, i
= 0; i
< n
; ++cp
, ++i
)
397 if (! whitechar(*cp
))
402 while (whitechar(cp
[n
- 1]))
408 maxlen
= MAX(maxlen
, (size_t)n
);
411 lp
= scalloc(1, sizeof(*lp
) - VFIELD_SIZEOF(struct line
, l_line
) + n
);
412 memcpy(lp
->l_line
, cp
, n
);
413 lp
->l_length
= (size_t)--n
;
420 mp
->ma_contents
= lst
;
421 mp
->ma_maxlen
= maxlen
;
423 if (_malook(mp
->ma_name
, mp
, mafl
) != NULL
) {
424 if (! (mafl
& MA_ACC
)) {
425 fprintf(stderr
, tr(76, "A macro named \"%s\" already exists.\n"),
427 lst
= mp
->ma_contents
;
430 _undef1(mp
->ma_name
, MA_ACC
);
431 _malook(mp
->ma_name
, mp
, MA_ACC
);
448 _undef1(char const *name
, enum ma_flags mafl
)
452 if ((mp
= _malook(name
, NULL
, mafl
| MA_UNDEF
)) != NULL
) {
453 _freelines(mp
->ma_contents
);
460 _freelines(struct line
*lp
)
464 for (lq
= NULL
; lp
!= NULL
; ) {
475 __var_list_all_cmp(void const *s1
, void const *s2
)
477 return strcmp(*(char**)UNCONST(s1
), *(char**)UNCONST(s2
));
481 _localopts_add(struct lostack
*losp
, char const *name
, struct var
*ovap
)
486 /* Propagate unrolling up the stack, as necessary */
487 while (! losp
->s_unroll
&& (losp
= losp
->s_up
) != NULL
)
492 /* We have found a level that wants to unroll; check wether it does it yet */
493 for (vap
= losp
->s_localopts
; vap
!= NULL
; vap
= vap
->v_link
)
494 if (strcmp(vap
->v_name
, name
) == 0)
497 nl
= strlen(name
) + 1;
498 vl
= (ovap
!= NULL
) ? strlen(ovap
->v_value
) + 1 : 0;
499 vap
= smalloc(sizeof(*vap
) + nl
+ vl
);
500 vap
->v_link
= losp
->s_localopts
;
501 losp
->s_localopts
= vap
;
502 vap
->v_name
= (char*)(vap
+ 1);
503 memcpy(vap
->v_name
, name
, nl
);
507 vap
->v_value
= (char*)(vap
+ 1) + nl
;
508 memcpy(vap
->v_value
, ovap
->v_value
, vl
);
515 _localopts_unroll(struct var
**vapp
)
517 struct lostack
*save_los
;
523 save_los
= _localopts
;
525 while (vap
!= NULL
) {
528 var_assign(x
->v_name
, x
->v_value
);
531 _localopts
= save_los
;
535 var_assign(char const *name
, char const *val
)
542 bool_t tmp
= unset_allow_undefined
;
543 unset_allow_undefined
= TRU1
;
545 unset_allow_undefined
= tmp
;
549 name
= _canonify(name
);
551 vp
= _lookup(name
, h
, TRU1
);
553 /* Don't care what happens later on, store this in the unroll list */
554 if (_localopts
!= NULL
)
555 _localopts_add(_localopts
, name
, vp
);
558 vp
= (struct var
*)scalloc(1, sizeof *vp
);
559 vp
->v_name
= _vcopy(name
);
560 vp
->v_link
= _vars
[h
];
565 vp
->v_value
= _vcopy(val
);
567 /* Check if update allowed XXX wasteful on error! */
568 if (! _check_special_vars(name
, TRU1
, &vp
->v_value
)) {
569 char *cp
= vp
->v_value
;
580 var_unset(char const *name
)
586 name
= _canonify(name
);
588 vp
= _lookup(name
, h
, TRU1
);
591 if (! sourcing
&& ! unset_allow_undefined
) {
592 fprintf(stderr
, tr(203, "\"%s\": undefined variable\n"), name
);
596 if (_localopts
!= NULL
)
597 _localopts_add(_localopts
, name
, vp
);
599 /* Always listhead after _lookup() */
600 _vars
[h
] = _vars
[h
]->v_link
;
605 _check_special_vars(name
, FAL0
, NULL
);
613 var_lookup(char const *name
, bool_t look_environ
)
618 name
= _canonify(name
);
619 if ((vp
= _lookup(name
, 0, FAL0
)) != NULL
)
621 else if (! look_environ
)
623 else if ((rv
= getenv(name
)) != NULL
&& *rv
!= '\0')
632 char *cp
, **vacp
, **cap
;
637 if ((fp
= Ftemp(&cp
, "Ra", "w+", 0600, 1)) == NULL
) {
644 for (no
= i
= 0; i
< MA_PRIME
; ++i
)
645 for (vp
= _vars
[i
]; vp
!= NULL
; vp
= vp
->v_link
)
647 vacp
= salloc(no
* sizeof(*vacp
));
648 for (cap
= vacp
, i
= 0; i
< MA_PRIME
; ++i
)
649 for (vp
= _vars
[i
]; vp
!= NULL
; vp
= vp
->v_link
)
653 qsort(vacp
, no
, sizeof *vacp
, &__var_list_all_cmp
);
655 i
= (boption("bsdcompat") || boption("bsdset"));
656 fmt
= (i
!= 0) ? "%s\t%s\n" : "%s=\"%s\"\n";
658 for (cap
= vacp
; no
!= 0; ++cap
, --no
) {
659 cp
= value(*cap
); /* TODO internal lookup; binary? value? */
662 if (i
|| *cp
!= '\0')
663 fprintf(fp
, fmt
, *cap
, cp
);
665 fprintf(fp
, "%s\n", *cap
);
668 page_or_print(fp
, (size_t)(cap
- vacp
));
681 if (args
[0] == NULL
) {
682 errs
= tr(504, "Missing macro name to `define'");
685 if (args
[1] == NULL
|| strcmp(args
[1], "{") || args
[2] != NULL
) {
686 errs
= tr(505, "Syntax is: define <name> {");
689 rv
= ! _define1(args
[0], MA_NONE
);
693 fprintf(stderr
, "%s\n", errs
);
704 fprintf(stderr
, tr(506, "Missing macro name to `undef'\n"));
708 _undef1(*args
, MA_NONE
);
720 char const *errs
, *name
;
723 if (args
[0] == NULL
|| (args
[1] != NULL
&& args
[2] != NULL
)) {
724 errs
= tr(507, "Syntax is: call <%s>\n");
729 if ((mp
= _malook(*args
, NULL
, MA_NONE
)) == NULL
) {
730 errs
= tr(508, "Undefined macro called: \"%s\"\n");
735 rv
= _maexec(mp
, NULL
);
739 fprintf(stderr
, errs
, name
);
744 callhook(char const *name
, int nmail
)
750 var
= ac_alloc(len
= strlen(name
) + 13);
751 snprintf(var
, len
, "folder-hook-%s", name
);
752 if ((cp
= value(var
)) == NULL
&& (cp
= value("folder-hook")) == NULL
) {
756 if ((mp
= _malook(cp
, NULL
, MA_NONE
)) == NULL
) {
757 fprintf(stderr
, tr(49, "Cannot call hook for folder \"%s\": "
758 "Macro \"%s\" does not exist.\n"), name
, cp
);
763 inhook
= nmail
? 3 : 1;
764 rv
= _maexec(mp
, NULL
);
775 return _list_macros(MA_NONE
);
783 int rv
= 1, i
, oqf
, nqf
;
785 if (args
[0] == NULL
) {
786 rv
= _list_macros(MA_ACC
);
790 if (args
[1] && args
[1][0] == '{' && args
[1][1] == '\0') {
791 if (args
[2] != NULL
) {
792 fprintf(stderr
, tr(517, "Syntax is: account <name> {\n"));
795 if (asccasecmp(args
[0], ACCOUNT_NULL
) == 0) {
796 fprintf(stderr
, tr(521, "Error: `%s' is a reserved name.\n"),
800 rv
= ! _define1(args
[0], MA_ACC
);
805 fprintf(stderr
, tr(518, "Cannot change account from within a hook.\n"));
809 save_mbox_for_possible_quitstuff();
812 if (asccasecmp(args
[0], ACCOUNT_NULL
) != 0 &&
813 (mp
= _malook(args
[0], NULL
, MA_ACC
)) == NULL
) {
814 fprintf(stderr
, tr(519, "Account `%s' does not exist.\n"), args
[0]);
818 oqf
= savequitflags();
819 if (_acc_curr
!= NULL
)
820 _localopts_unroll(&_acc_curr
->ma_localopts
);
821 account_name
= (mp
!= NULL
) ? mp
->ma_name
: NULL
;
824 if (mp
!= NULL
&& _maexec(mp
, &mp
->ma_localopts
) == CBAD
) {
825 /* XXX account switch incomplete, unroll? */
826 fprintf(stderr
, tr(520, "Switching to account `%s' failed.\n"), args
[0]);
830 if (! starting
&& ! inhook
) {
831 nqf
= savequitflags(); /* TODO obsolete (leave -> void -> new box!) */
832 restorequitflags(oqf
);
833 if ((i
= setfile("%", 0)) < 0)
835 callhook(mailname
, 0);
836 if (i
> 0 && ! boption("emptystart"))
838 announce(boption("bsdcompat") || boption("bsdannounce"));
839 restorequitflags(nqf
);
852 if (_localopts
== NULL
) {
853 fprintf(stderr
, tr(522,
854 "Cannot use `localopts' but from within a `define' or `account'\n"));
858 _localopts
->s_unroll
= (**c
== '0') ? FAL0
: TRU1
;
864 /* vim:set fenc=utf-8:s-it-mode */