2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or (at
5 * your option) any later version.
7 * This program is distributed in the hope that it will be useful, but
8 * WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 * General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
17 * Copyright © 2006 Pierre Habouzit
20 * Copyright notice from original mutt:
21 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
23 * This file is part of mutt-ng, see http://www.muttng.org/.
24 * It's licensed under the GNU General Public License,
25 * please see the file GPL in the top level source directory.
28 #include <lib-lib/lib-lib.h>
30 #include <lib-sys/unix.h>
32 #include <lib-ui/curses.h>
33 #include <lib-ui/enter.h>
34 #include <lib-ui/menu.h>
37 #include "mutt_idna.h"
45 #define RSORT(x) (SortAlias & SORT_REVERSE) ? -x : x
47 static struct mapping_t AliasHelp[] = {
48 {N_("Exit"), OP_EXIT},
49 {N_("Del"), OP_DELETE},
50 {N_("Undel"), OP_UNDELETE},
51 {N_("Select"), OP_GENERIC_SELECT_ENTRY},
52 {N_("Help"), OP_HELP},
56 static void mutt_alias_menu(char *, size_t, alias_t *);
58 const address_t *alias_lookup(const char *s)
62 for (list = Aliases; list; list = list->next) {
63 if (!m_strcasecmp(s, list->name))
70 /* This routine looks to see if the user has an alias defined for the given
72 const address_t *alias_reverse_lookup(const address_t *a)
76 if (!a || !a->mailbox)
79 for (list = Aliases; list; list = list->next) {
82 /* cycle through all addresses if this is a group alias */
83 for (ap = list->addr; ap; ap = ap->next) {
84 if (!ap->group && ap->mailbox
85 && !ascii_strcasecmp(ap->mailbox, a->mailbox))
93 static int string_is_address(const char *str, const char *u, const char *d)
95 char buf[LONG_STRING];
96 snprintf(buf, sizeof (buf), "%s@%s", NONULL(u), NONULL(d));
97 return !ascii_strcasecmp(str, buf);
100 /* returns TRUE if the given address belongs to the user. */
101 int mutt_addr_is_user(address_t *addr)
103 /* NULL address is assumed to be the user. */
110 if (!ascii_strcasecmp(addr->mailbox, Username)
111 || string_is_address(addr->mailbox, Username, Hostname)
112 || string_is_address(addr->mailbox, Username, mutt_fqdn(0))
113 || string_is_address(addr->mailbox, Username, mutt_fqdn(1))
114 || (From && !ascii_strcasecmp(From->mailbox, addr->mailbox)))
119 return rx_list_match(Alternates, addr->mailbox)
120 && !rx_list_match(UnAlternates, addr->mailbox);
123 address_t *mutt_get_address(ENVELOPE *env, const char **pfxp)
125 #define RETURN(s, adr) do { if (pfxp) *pfxp = s; return adr; } while (0)
127 if (mutt_addr_is_user(env->from)) {
128 if (env->to && !mutt_is_mail_list(env->to)) {
129 RETURN("To", env->to);
131 RETURN("Cc", env->cc);
134 if (env->reply_to && !mutt_is_mail_list(env->reply_to)) {
135 RETURN("Reply-To", env->reply_to);
137 RETURN("From", env->from);
144 /* Only characters which are non-special to both the RFC 822 and the mutt
145 configuration parser are permitted. */
146 static int alias_sanitize(const char *s, char *d)
151 if (isalnum((unsigned char)(*s)) || strchr("-_+=.", *s)) {
169 * if someone has an address like
170 * From: Michael `/bin/rm -f ~` Elkins <me@mutt.org>
171 * and the user creates an alias for this, Mutt could wind up executing
172 * the backtics because it writes aliases like
173 * alias me Michael `/bin/rm -f ~` Elkins <me@mutt.org>
174 * To avoid this problem, use a backslash (\) to quote any backtics. We also
175 * need to quote backslashes as well, since you could defeat the above by
177 * From: Michael \`/bin/rm -f ~\` Elkins <me@mutt.org>
178 * since that would get aliased as
179 * alias me Michael \\`/bin/rm -f ~\\` Elkins <me@mutt.org>
180 * which still gets evaluated because the double backslash is not a quote.
182 * Additionally, we need to quote ' and " characters - otherwise, mutt will
183 * interpret them on the wrong parsing step.
185 * $ wants to be quoted since it may indicate the start of an environment
188 static void write_safe_address(FILE *fp, const char *s)
191 if (strchr("\\`'\"$", *s)) {
199 void mutt_create_alias(ENVELOPE *cur, address_t *iadr)
201 char buf[LONG_STRING], prompt[STRING];
202 address_t *adr = iadr;
207 adr = mutt_get_address(cur, NULL);
210 if (adr && adr->mailbox) {
211 const char *p = m_strchrnul(adr->mailbox, '@');
212 m_strncpy(buf, sizeof(buf), adr->mailbox, p - adr->mailbox);
217 /* Don't suggest a bad alias name in the event of a strange local part. */
218 alias_sanitize(buf, buf);
220 /* add a new alias */
221 if (mutt_get_field(_("Alias as: "), buf, sizeof(buf), 0) || !buf[0])
224 /* check to see if the user already has an alias defined */
225 if (alias_lookup(buf)) {
226 mutt_error _("You already have an alias defined with that name!");
230 alias_sanitize(buf, buf);
232 new->name = m_strdup(buf);
234 mutt_addrlist_to_local(adr);
236 m_strcpy(buf, sizeof(buf), adr->mailbox);
241 mutt_addrlist_to_idna(adr, NULL);
246 if (mutt_get_field(_("Address: "), buf, sizeof(buf), 0) || !buf[0]) {
247 alias_list_wipe(&new);
251 new->addr = rfc822_parse_adrlist(new->addr, buf);
255 if (mutt_addrlist_to_idna(new->addr, &err)) {
256 mutt_error(_("Error: '%s' is a bad IDN."), err);
261 } while (!new->addr);
263 if (adr && adr->personal && !mutt_is_mail_list(adr)) {
264 m_strcpy(buf, sizeof(buf), adr->personal);
269 if (mutt_get_field(_("Personal name: "), buf, sizeof(buf), 0)) {
270 alias_list_wipe(&new);
273 new->addr->personal = m_strdup(buf);
276 rfc822_addrcat(buf, sizeof(buf), new->addr, 1);
277 snprintf(prompt, sizeof(prompt), _("[%s = %s] Accept?"), new->name, buf);
278 if (mutt_yesorno(prompt, M_YES) != M_YES) {
279 alias_list_wipe(&new);
283 alias_list_push(&Aliases, new);
285 m_strcpy(buf, sizeof(buf), NONULL(AliasFile));
286 if (mutt_get_field(_("Save to file: "), buf, sizeof(buf), M_FILE)) {
290 mutt_expand_path(buf, sizeof (buf));
291 rc = safe_fopen (buf, "a");
294 if (alias_sanitize(new->name, NULL)) {
295 mutt_quote_filename(buf, sizeof(buf), new->name);
296 fprintf(rc, "alias %s ", buf);
298 fprintf(rc, "alias %s ", new->name);
302 rfc822_addrcat(buf, sizeof(buf), new->addr, 0);
303 write_safe_address(rc, buf);
305 mutt_message _("Alias added.");
311 static address_t *mutt_expand_aliases_r(address_t *a, string_list_t **expn)
313 address_t *pop, *head = NULL;
314 address_t **last = &head;
316 while ((pop = address_list_pop(&a))) {
317 if (!pop->group && !pop->personal
318 && pop->mailbox && !strchr(pop->mailbox, '@'))
320 const address_t *t = alias_lookup(pop->mailbox);
325 for (u = *expn; u; u = u->next) {
326 if (!m_strcmp(pop->mailbox, u->data)) { /* alias already found */
327 address_list_wipe(&pop);
332 /* save the fact we saw it */
333 u = string_item_new();
334 u->data = m_strdup(pop->mailbox);
337 address_list_wipe(&pop);
340 last = address_list_last(last);
341 *last = mutt_expand_aliases_r(address_list_dup(t), expn);
344 struct passwd *pw = getpwnam(pop->mailbox);
347 char namebuf[STRING];
348 mutt_gecos_name(namebuf, sizeof(namebuf), pw, GecosMask.rx);
349 m_strreplace(&pop->personal, namebuf);
354 last = address_list_append(last, pop);
357 if (option(OPTUSEDOMAIN)) {
358 /* now qualify all local addresses */
359 rfc822_qualify(head, mutt_fqdn(1));
365 address_t *mutt_expand_aliases(address_t *a)
368 string_list_t *expn = NULL; /* previously expanded aliases to avoid loops */
370 t = mutt_expand_aliases_r(a, &expn);
371 string_list_wipe(&expn);
372 address_list_uniq(t);
376 void mutt_expand_aliases_env(ENVELOPE *env)
378 env->from = mutt_expand_aliases(env->from);
379 env->to = mutt_expand_aliases(env->to);
380 env->cc = mutt_expand_aliases(env->cc);
381 env->bcc = mutt_expand_aliases(env->bcc);
382 env->reply_to = mutt_expand_aliases(env->reply_to);
383 env->mail_followup_to = mutt_expand_aliases(env->mail_followup_to);
386 /************* READ MARK *********************/
388 /* alias_complete() -- alias completion routine
390 * given a partial alias, this routine attempts to fill in the alias
391 * from the alias list as much as possible. if given empty search string
392 * or found nothing, present all aliases
394 int mutt_alias_complete (char *s, size_t buflen)
396 alias_t *a = Aliases;
397 alias_t *a_list = NULL, *a_cur = NULL;
398 char bestname[HUGE_STRING];
401 #define min(a,b) ((a<b)?a:b)
403 if (s[0] != 0) { /* avoid empty string as strstr argument */
404 p_clear(bestname, countof(bestname));
407 if (a->name && strstr (a->name, s) == a->name) {
408 if (!bestname[0]) /* init */
409 m_strcpy(bestname, MIN(m_strlen(a->name) + 1, ssizeof(bestname)),
412 for (i = 0; a->name[i] && a->name[i] == bestname[i]; i++);
419 if (bestname[0] != 0) {
420 if (m_strcmp(bestname, s) != 0) {
421 /* we are adding something to the completion */
422 m_strcpy(s, m_strlen(bestname) + 1, bestname);
426 /* build alias list and show it */
430 if (a->name && (strstr (a->name, s) == a->name)) {
431 if (!a_list) /* init */
432 a_cur = a_list = alias_new();
434 a_cur->next = alias_new();
446 mutt_alias_menu (bestname, sizeof (bestname), a_list ? a_list : Aliases);
447 if (bestname[0] != 0)
448 m_strcpy(s, buflen, bestname);
450 /* free the alias list */
453 a_list = a_list->next;
457 /* remove any aliases marked for deletion */
459 for (a_cur = Aliases; a_cur;) {
462 a_list->next = a_cur->next;
464 Aliases = a_cur->next;
467 alias_list_wipe(&a_cur);
484 alias_format_str(char *dest, ssize_t destlen, char op, const char *src,
485 const char *fmt, const char *ifstr __attribute__ ((unused)),
486 const char *elstr __attribute__ ((unused)),
487 anytype data, format_flag flags __attribute__ ((unused)))
489 char tmp[STRING], adr[STRING];
490 alias_t *alias = data.ptr;
494 m_strputc(dest, destlen, alias->del ? 'D' : ' ');
497 mutt_format_s(dest, destlen, fmt, alias->name);
501 rfc822_addrcat(adr, sizeof(adr), alias->addr, 1);
502 snprintf(tmp, sizeof(tmp), "%%%ss", fmt);
503 snprintf(dest, destlen, tmp, adr);
506 snprintf(tmp, sizeof(tmp), "%%%sd", fmt);
507 snprintf(dest, destlen, tmp, alias->num + 1);
510 m_strputc(dest, destlen, alias->tagged ? '*' : ' ');
517 static void alias_entry(char *s, ssize_t slen, MUTTMENU *m, int num)
519 m_strformat(s, slen, COLS - SW, AliasFmt, alias_format_str,
520 ((alias_t **)m->data)[num],
521 option(OPTARROWCURSOR) ? M_FORMAT_ARROWCURSOR : 0);
524 static int alias_tag (MUTTMENU * menu, int n, int m)
526 alias_t *cur = ((alias_t **) menu->data)[n];
527 int ot = cur->tagged;
529 cur->tagged = (m >= 0 ? m : !cur->tagged);
531 return cur->tagged - ot;
534 static int alias_SortAlias (const void *a, const void *b)
536 alias_t *pa = *(alias_t **) a;
537 alias_t *pb = *(alias_t **) b;
538 int r = m_strcasecmp(pa->name, pb->name);
543 static int alias_SortAddress (const void *a, const void *b)
545 address_t *pa = (*(alias_t **) a)->addr;
546 address_t *pb = (*(alias_t **) b)->addr;
555 else if (pa->personal) {
557 r = m_strcasecmp(pa->personal, pb->personal);
561 else if (pb->personal)
564 r = ascii_strcasecmp (pa->mailbox, pb->mailbox);
568 void mutt_alias_menu (char *buf, size_t buflen, alias_t * aliases)
572 alias_t **AliasTable = NULL;
576 char helpstr[STRING];
581 mutt_error _("You have no aliases!");
586 /* tell whoever called me to redraw the screen when I return */
587 set_option (OPTNEEDREDRAW);
589 menu = mutt_new_menu ();
590 menu->make_entry = alias_entry;
591 menu->tag = alias_tag;
592 menu->menu = MENU_ALIAS;
593 menu->title = _("Aliases");
594 menu->help = mutt_compile_help(helpstr, sizeof(helpstr),
595 MENU_ALIAS, AliasHelp);
601 /* count the number of aliases */
602 for (aliasp = aliases; aliasp; aliasp = aliasp->next) {
608 p_realloc(&AliasTable, menu->max);
609 menu->data = AliasTable;
611 for (i = omax, aliasp = aliases; aliasp; aliasp = aliasp->next, i++) {
612 AliasTable[i] = aliasp;
616 if ((SortAlias & SORT_MASK) != SORT_ORDER) {
617 qsort (AliasTable, i, sizeof (alias_t *),
618 (SortAlias & SORT_MASK) ==
619 SORT_ADDRESS ? alias_SortAddress : alias_SortAlias);
622 for (i = 0; i < menu->max; i++)
623 AliasTable[i]->num = i;
627 menu->redraw |= REDRAW_FULL;
628 aliases = aliases->next;
632 switch ((op = mutt_menuLoop (menu))) {
635 if (menu->tagprefix) {
636 for (i = 0; i < menu->max; i++)
637 if (AliasTable[i]->tagged)
638 AliasTable[i]->del = (op == OP_DELETE) ? 1 : 0;
639 menu->redraw |= REDRAW_INDEX;
642 AliasTable[menu->current]->del = (op == OP_DELETE) ? 1 : 0;
643 menu->redraw |= REDRAW_CURRENT;
644 if (option (OPTRESOLVE) && menu->current < menu->max - 1) {
646 menu->redraw |= REDRAW_INDEX;
650 case OP_GENERIC_SELECT_ENTRY:
658 for (i = 0; i < menu->max; i++) {
659 if (AliasTable[i]->tagged) {
660 mutt_addrlist_to_local (AliasTable[i]->addr);
661 rfc822_addrcat(buf, buflen, AliasTable[i]->addr, 0);
667 mutt_addrlist_to_local (AliasTable[t]->addr);
668 rfc822_addrcat(buf, buflen, AliasTable[t]->addr, 0);
671 mutt_menuDestroy (&menu);
672 p_delete(&AliasTable);