hook.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>, and others
   4  *
   5  * This file is part of mutt-ng, see http://www.muttng.org/.
   6  * It's licensed under the GNU General Public License,
   7  * please see the file GPL in the top level source directory.
   8  */
   9
  10 #if HAVE_CONFIG_H
  11 # include "config.h"
  12 #endif
  13
  14 #include "mutt.h"
  15 #include "mailbox.h"
  16 #include "mutt_crypt.h"
  17
  18 #ifdef USE_COMPRESSED
  19 #include "compress.h"
  20 #endif
  21
  22 #include <limits.h>
  23 #include <string.h>
  24 #include <stdlib.h>
  25 #include <ctype.h>
  26 #include <unistd.h>
  27
  28 typedef struct hook {
  29   int type;                     /* hook type */
  30   REGEXP rx;                    /* regular expression */
  31   char *command;                /* filename, command or pattern to execute */
  32   pattern_t *pattern;           /* used for fcc,save,send-hook */
  33   struct hook *next;
  34 } HOOK;
  35
  36 static HOOK *Hooks = NULL;
  37
  38 static int current_hook_type = 0;
  39
  40 int mutt_parse_hook (BUFFER * buf, BUFFER * s, unsigned long data,
  41                      BUFFER * err)
  42 {
  43   HOOK *ptr;
  44   BUFFER command, pattern;
  45   int rc, not = 0;
  46   regex_t *rx = NULL;
  47   pattern_t *pat = NULL;
  48   char path[_POSIX_PATH_MAX];
  49
  50   memset (&pattern, 0, sizeof (pattern));
  51   memset (&command, 0, sizeof (command));
  52
  53   if (*s->dptr == '!') {
  54     s->dptr++;
  55     SKIPWS (s->dptr);
  56     not = 1;
  57   }
  58
  59   mutt_extract_token (&pattern, s, 0);
  60
  61   if (!MoreArgs (s)) {
  62     strfcpy (err->data, _("too few arguments"), err->dsize);
  63     goto error;
  64   }
  65
  66   mutt_extract_token (&command, s,
  67                       (data &
  68                        (M_FOLDERHOOK | M_SENDHOOK | M_SEND2HOOK |
  69                         M_ACCOUNTHOOK | M_REPLYHOOK)) ? M_TOKEN_SPACE : 0);
  70
  71   if (!command.data) {
  72     strfcpy (err->data, _("too few arguments"), err->dsize);
  73     goto error;
  74   }
  75
  76   if (MoreArgs (s)) {
  77     strfcpy (err->data, _("too many arguments"), err->dsize);
  78     goto error;
  79   }
  80
  81   if (data & (M_FOLDERHOOK | M_MBOXHOOK)) {
  82     strfcpy (path, pattern.data, sizeof (path));
  83     _mutt_expand_path (path, sizeof (path), 1);
  84     FREE (&pattern.data);
  85     memset (&pattern, 0, sizeof (pattern));
  86     pattern.data = safe_strdup (path);
  87   }
  88 #ifdef USE_COMPRESSED
  89   else if (data & (M_APPENDHOOK | M_OPENHOOK | M_CLOSEHOOK)) {
  90     if (mutt_test_compress_command (command.data)) {
  91       strfcpy (err->data, _("bad formatted command string"), err->dsize);
  92       return (-1);
  93     }
  94   }
  95 #endif
  96   else if (DefaultHook && !(data & (M_CHARSETHOOK | M_ACCOUNTHOOK))
  97            && (!WithCrypto || !(data & M_CRYPTHOOK))
  98     ) {
  99     char tmp[HUGE_STRING];
 100
 101     strfcpy (tmp, pattern.data, sizeof (tmp));
 102     mutt_check_simple (tmp, sizeof (tmp), DefaultHook);
 103     FREE (&pattern.data);
 104     memset (&pattern, 0, sizeof (pattern));
 105     pattern.data = safe_strdup (tmp);
 106   }
 107
 108   if (data & (M_MBOXHOOK | M_SAVEHOOK | M_FCCHOOK)) {
 109     strfcpy (path, command.data, sizeof (path));
 110     mutt_expand_path (path, sizeof (path));
 111     FREE (&command.data);
 112     memset (&command, 0, sizeof (command));
 113     command.data = safe_strdup (path);
 114   }
 115
 116   /* check to make sure that a matching hook doesn't already exist */
 117   for (ptr = Hooks; ptr; ptr = ptr->next) {
 118     if (ptr->type == data &&
 119         ptr->rx.not == not && !mutt_strcmp (pattern.data, ptr->rx.pattern)) {
 120       if (data &
 121           (M_FOLDERHOOK | M_SENDHOOK | M_SEND2HOOK | M_MESSAGEHOOK |
 122            M_ACCOUNTHOOK | M_REPLYHOOK)) {
 123         /* these hooks allow multiple commands with the same
 124          * pattern, so if we've already seen this pattern/command pair, just
 125          * ignore it instead of creating a duplicate */
 126         if (!mutt_strcmp (ptr->command, command.data)) {
 127           FREE (&command.data);
 128           FREE (&pattern.data);
 129           return 0;
 130         }
 131       }
 132       else {
 133         /* other hooks only allow one command per pattern, so update the
 134          * entry with the new command.  this currently does not change the
 135          * order of execution of the hooks, which i think is desirable since
 136          * a common action to perform is to change the default (.) entry
 137          * based upon some other information. */
 138         FREE (&ptr->command);
 139         ptr->command = command.data;
 140         FREE (&pattern.data);
 141         return 0;
 142       }
 143     }
 144     if (!ptr->next)
 145       break;
 146   }
 147
 148   if (data &
 149       (M_SENDHOOK | M_SEND2HOOK | M_SAVEHOOK | M_FCCHOOK | M_MESSAGEHOOK |
 150        M_REPLYHOOK)) {
 151     if ((pat =
 152          mutt_pattern_comp (pattern.data,
 153                             (data & (M_SENDHOOK | M_SEND2HOOK | M_FCCHOOK)) ?
 154                             0 : M_FULL_MSG, err)) == NULL)
 155       goto error;
 156   }
 157   else {
 158     rx = safe_malloc (sizeof (regex_t));
 159 #ifdef M_CRYPTHOOK
 160     if ((rc =
 161          REGCOMP (rx, NONULL (pattern.data),
 162                   ((data & (M_CRYPTHOOK | M_CHARSETHOOK)) ? REG_ICASE : 0)))
 163         != 0)
 164 #else
 165     if ((rc =
 166          REGCOMP (rx, NONULL (pattern.data),
 167                   (data & (M_CHARSETHOOK | M_ICONVHOOK)) ? REG_ICASE : 0)) !=
 168         0)
 169 #endif /* M_CRYPTHOOK */
 170     {
 171       regerror (rc, rx, err->data, err->dsize);
 172       regfree (rx);
 173       FREE (&rx);
 174       goto error;
 175     }
 176   }
 177
 178   if (ptr) {
 179     ptr->next = safe_calloc (1, sizeof (HOOK));
 180     ptr = ptr->next;
 181   }
 182   else
 183     Hooks = ptr = safe_calloc (1, sizeof (HOOK));
 184   ptr->type = data;
 185   ptr->command = command.data;
 186   ptr->pattern = pat;
 187   ptr->rx.pattern = pattern.data;
 188   ptr->rx.rx = rx;
 189   ptr->rx.not = not;
 190   return 0;
 191
 192 error:
 193   FREE (&pattern.data);
 194   FREE (&command.data);
 195   return (-1);
 196 }
 197
 198 static void delete_hook (HOOK * h)
 199 {
 200   FREE (&h->command);
 201   FREE (&h->rx.pattern);
 202   if (h->rx.rx) {
 203     regfree (h->rx.rx);
 204   }
 205   mutt_pattern_free (&h->pattern);
 206   FREE (&h);
 207 }
 208
 209 /* Deletes all hooks of type ``type'', or all defined hooks if ``type'' is 0 */
 210 static void delete_hooks (int type)
 211 {
 212   HOOK *h;
 213   HOOK *prev;
 214
 215   while (h = Hooks, h && (type == 0 || type == h->type)) {
 216     Hooks = h->next;
 217     delete_hook (h);
 218   }
 219
 220   prev = h;                     /* Unused assignment to avoid compiler warnings */
 221
 222   while (h) {
 223     if (type == h->type) {
 224       prev->next = h->next;
 225       delete_hook (h);
 226     }
 227     else
 228       prev = h;
 229     h = prev->next;
 230   }
 231 }
 232
 233 int mutt_parse_unhook (BUFFER * buf, BUFFER * s, unsigned long data,
 234                        BUFFER * err)
 235 {
 236   while (MoreArgs (s)) {
 237     mutt_extract_token (buf, s, 0);
 238     if (mutt_strcmp ("*", buf->data) == 0) {
 239       if (current_hook_type) {
 240         snprintf (err->data, err->dsize,
 241                   _("unhook: Can't do unhook * from within a hook."));
 242         return -1;
 243       }
 244       delete_hooks (0);
 245     }
 246     else {
 247       int type = mutt_get_hook_type (buf->data);
 248
 249       if (!type) {
 250         snprintf (err->data, err->dsize,
 251                   _("unhook: unknown hook type: %s"), buf->data);
 252         return (-1);
 253       }
 254       if (current_hook_type == type) {
 255         snprintf (err->data, err->dsize,
 256                   _("unhook: Can't delete a %s from within a %s."), buf->data,
 257                   buf->data);
 258         return -1;
 259       }
 260       delete_hooks (type);
 261     }
 262   }
 263   return 0;
 264 }
 265
 266 void mutt_folder_hook (char *path)
 267 {
 268   HOOK *tmp = Hooks;
 269   BUFFER err, token;
 270   char buf[STRING];
 271
 272   current_hook_type = M_FOLDERHOOK;
 273
 274   err.data = buf;
 275   err.dsize = sizeof (buf);
 276   memset (&token, 0, sizeof (token));
 277   for (; tmp; tmp = tmp->next) {
 278     if (!tmp->command)
 279       continue;
 280
 281     if (tmp->type & M_FOLDERHOOK) {
 282       if ((regexec (tmp->rx.rx, path, 0, NULL, 0) == 0) ^ tmp->rx.not) {
 283         if (mutt_parse_rc_line (tmp->command, &token, &err) == -1) {
 284           mutt_error ("%s", err.data);
 285           FREE (&token.data);
 286           mutt_sleep (1);       /* pause a moment to let the user see the error */
 287           current_hook_type = 0;
 288           return;
 289         }
 290       }
 291     }
 292   }
 293   FREE (&token.data);
 294
 295   current_hook_type = 0;
 296 }
 297
 298 char *mutt_find_hook (int type, const char *pat)
 299 {
 300   HOOK *tmp = Hooks;
 301
 302   for (; tmp; tmp = tmp->next)
 303     if (tmp->type & type) {
 304       if (regexec (tmp->rx.rx, pat, 0, NULL, 0) == 0)
 305         return (tmp->command);
 306     }
 307   return (NULL);
 308 }
 309
 310 void mutt_message_hook (CONTEXT * ctx, HEADER * hdr, int type)
 311 {
 312   BUFFER err, token;
 313   HOOK *hook;
 314   char buf[STRING];
 315
 316   current_hook_type = type;
 317
 318   err.data = buf;
 319   err.dsize = sizeof (buf);
 320   memset (&token, 0, sizeof (token));
 321   for (hook = Hooks; hook; hook = hook->next) {
 322     if (!hook->command)
 323       continue;
 324
 325     if (hook->type & type)
 326       if ((mutt_pattern_exec (hook->pattern, 0, ctx, hdr) > 0) ^ hook->rx.not)
 327         if (mutt_parse_rc_line (hook->command, &token, &err) != 0) {
 328           FREE (&token.data);
 329           mutt_error ("%s", err.data);
 330           mutt_sleep (1);
 331           current_hook_type = 0;
 332           return;
 333         }
 334   }
 335   FREE (&token.data);
 336   current_hook_type = 0;
 337 }
 338
 339 static int
 340 mutt_addr_hook (char *path, size_t pathlen, int type, CONTEXT * ctx,
 341                 HEADER * hdr)
 342 {
 343   HOOK *hook;
 344
 345   /* determine if a matching hook exists */
 346   for (hook = Hooks; hook; hook = hook->next) {
 347     if (!hook->command)
 348       continue;
 349
 350     if (hook->type & type)
 351       if ((mutt_pattern_exec (hook->pattern, 0, ctx, hdr) > 0) ^ hook->rx.not) {
 352         mutt_make_string (path, pathlen, hook->command, ctx, hdr);
 353         return 0;
 354       }
 355   }
 356
 357   return -1;
 358 }
 359
 360 void mutt_default_save (char *path, size_t pathlen, HEADER * hdr)
 361 {
 362   *path = 0;
 363   if (mutt_addr_hook (path, pathlen, M_SAVEHOOK, Context, hdr) != 0) {
 364     char tmp[_POSIX_PATH_MAX];
 365     ADDRESS *adr;
 366     ENVELOPE *env = hdr->env;
 367     int fromMe = mutt_addr_is_user (env->from);
 368
 369     if (!fromMe && env->reply_to && env->reply_to->mailbox)
 370       adr = env->reply_to;
 371     else if (!fromMe && env->from && env->from->mailbox)
 372       adr = env->from;
 373     else if (env->to && env->to->mailbox)
 374       adr = env->to;
 375     else if (env->cc && env->cc->mailbox)
 376       adr = env->cc;
 377     else
 378       adr = NULL;
 379     if (adr) {
 380       mutt_safe_path (tmp, sizeof (tmp), adr);
 381       snprintf (path, pathlen, "=%s", tmp);
 382     }
 383   }
 384 }
 385
 386 void mutt_select_fcc (char *path, size_t pathlen, HEADER * hdr)
 387 {
 388   ADDRESS *adr;
 389   char buf[_POSIX_PATH_MAX];
 390   ENVELOPE *env = hdr->env;
 391
 392   if (mutt_addr_hook (path, pathlen, M_FCCHOOK, NULL, hdr) != 0) {
 393     if ((option (OPTSAVENAME) || option (OPTFORCENAME)) &&
 394         (env->to || env->cc || env->bcc)) {
 395       adr = env->to ? env->to : (env->cc ? env->cc : env->bcc);
 396       mutt_safe_path (buf, sizeof (buf), adr);
 397       mutt_concat_path (path, NONULL (Maildir), buf, pathlen);
 398       if (!option (OPTFORCENAME) && mx_access (path, W_OK) != 0)
 399         strfcpy (path, NONULL (Outbox), pathlen);
 400     }
 401     else
 402       strfcpy (path, NONULL (Outbox), pathlen);
 403   }
 404   mutt_pretty_mailbox (path);
 405 }
 406
 407 static char *_mutt_string_hook (const char *match, int hook)
 408 {
 409   HOOK *tmp = Hooks;
 410
 411   for (; tmp; tmp = tmp->next) {
 412     if ((tmp->type & hook) && ((match &&
 413                                 regexec (tmp->rx.rx, match, 0, NULL,
 414                                          0) == 0) ^ tmp->rx.not))
 415       return (tmp->command);
 416   }
 417   return (NULL);
 418 }
 419
 420 char *mutt_charset_hook (const char *chs)
 421 {
 422   return _mutt_string_hook (chs, M_CHARSETHOOK);
 423 }
 424
 425 char *mutt_iconv_hook (const char *chs)
 426 {
 427   return _mutt_string_hook (chs, M_ICONVHOOK);
 428 }
 429
 430 char *mutt_crypt_hook (ADDRESS * adr)
 431 {
 432   return _mutt_string_hook (adr->mailbox, M_CRYPTHOOK);
 433 }
 434
 435 #ifdef USE_SOCKET
 436 void mutt_account_hook (const char *url)
 437 {
 438   HOOK *hook;
 439   BUFFER token;
 440   BUFFER err;
 441   char buf[STRING];
 442
 443   err.data = buf;
 444   err.dsize = sizeof (buf);
 445   memset (&token, 0, sizeof (token));
 446
 447   for (hook = Hooks; hook; hook = hook->next) {
 448     if (!(hook->command && (hook->type & M_ACCOUNTHOOK)))
 449       continue;
 450
 451     if ((regexec (hook->rx.rx, url, 0, NULL, 0) == 0) ^ hook->rx.not) {
 452       if (mutt_parse_rc_line (hook->command, &token, &err) == -1) {
 453         FREE (&token.data);
 454         mutt_error ("%s", err.data);
 455         mutt_sleep (1);
 456
 457         return;
 458       }
 459     }
 460   }
 461
 462   FREE (&token.data);
 463 }
 464 #endif