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 #include <lib-lib/lib-lib.h>
  11 #include <lib-lua/lib-lua.h>
  12 #include <lib-ui/curses.h>
  13 #include <lib-mx/mx.h>
  14 #include <lib-mx/compress.h>
  15
  16 #include "alias.h"
  17 #include "crypt.h"
  18 #include "pattern.h"
  19
  20 typedef struct hook_t {
  21   int type;                     /* hook type */
  22   rx_t rx;                      /* regular expression */
  23   char *command;                /* filename, command or pattern to execute */
  24   pattern_t *pattern;           /* used for fcc,save,send-hook */
  25   struct hook_t *next;
  26 } hook_t;
  27
  28 DO_INIT(hook_t, hook);
  29 static inline void hook_wipe(hook_t *hk) {
  30     p_delete(&hk->command);
  31     pattern_list_wipe(&hk->pattern);
  32 }
  33 DO_NEW(hook_t, hook);
  34 DO_DELETE(hook_t, hook);
  35 DO_SLIST(hook_t, hook, hook_delete);
  36
  37 static hook_t *Hooks = NULL;
  38 static unsigned long current_hook_type = 0;
  39
  40 int mutt_parse_hook (BUFFER * buf __attribute__ ((unused)), BUFFER * s,
  41                      unsigned long data, BUFFER * err)
  42 {
  43   hook_t *ptr;
  44   BUFFER command, pattern;
  45   int rc, neg = 0;
  46   regex_t *rx = NULL;
  47   pattern_t *pat = NULL;
  48   char path[_POSIX_PATH_MAX];
  49
  50   p_clear(&pattern, 1);
  51   p_clear(&command, 1);
  52
  53   if (*s->dptr == '!') {
  54     s->dptr = vskipspaces(s->dptr + 1);
  55     neg = 1;
  56   }
  57
  58   mutt_extract_token (&pattern, s, 0);
  59
  60   if (!MoreArgs (s)) {
  61     m_strcpy(err->data, err->dsize, _("too few arguments"));
  62     goto error;
  63   }
  64
  65   mutt_extract_token (&command, s,
  66                       (data &
  67                        (M_FOLDERHOOK | M_SENDHOOK | M_SEND2HOOK |
  68                         M_ACCOUNTHOOK | M_REPLYHOOK)) ? M_TOKEN_SPACE : 0);
  69
  70   if (!command.data) {
  71     m_strcpy(err->data, err->dsize, _("too few arguments"));
  72     goto error;
  73   }
  74
  75   if (MoreArgs (s)) {
  76     m_strcpy(err->data, err->dsize, _("too many arguments"));
  77     goto error;
  78   }
  79
  80   if (data & (M_FOLDERHOOK | M_MBOXHOOK)) {
  81     _mutt_expand_path (path, sizeof (path), pattern.data, 1);
  82     p_delete(&pattern.data);
  83     p_clear(&pattern, 1);
  84     pattern.data = m_strdup(path);
  85   }
  86   else if (data & (M_APPENDHOOK | M_OPENHOOK | M_CLOSEHOOK)) {
  87     if (mutt_test_compress_command (command.data)) {
  88       m_strcpy(err->data, err->dsize, _("bad formatted command string"));
  89       return (-1);
  90     }
  91   }
  92   else if (DefaultHook && !(data & M_ACCOUNTHOOK) && !(data & M_CRYPTHOOK))
  93   {
  94     char tmp[HUGE_STRING];
  95
  96     m_strcpy(tmp, sizeof(tmp), pattern.data);
  97     mutt_check_simple (tmp, sizeof (tmp), DefaultHook);
  98     p_delete(&pattern.data);
  99     p_clear(&pattern, 1);
 100     pattern.data = m_strdup(tmp);
 101   }
 102
 103   if (data & (M_MBOXHOOK | M_SAVEHOOK | M_FCCHOOK)) {
 104     m_strcpy(path, sizeof(path), command.data);
 105     mutt_expand_path (path, sizeof (path));
 106     p_delete(&command.data);
 107     p_clear(&command, 1);
 108     command.data = m_strdup(path);
 109   }
 110
 111   /* check to make sure that a matching hook doesn't already exist */
 112   for (ptr = Hooks; ptr; ptr = ptr->next) {
 113     if (ptr->type == (int)data &&
 114         ptr->rx.neg == neg && !m_strcmp(pattern.data, ptr->rx.pattern)) {
 115       if (data &
 116           (M_FOLDERHOOK | M_SENDHOOK | M_SEND2HOOK | M_MESSAGEHOOK |
 117            M_ACCOUNTHOOK | M_REPLYHOOK)) {
 118         /* these hooks allow multiple commands with the same
 119          * pattern, so if we've already seen this pattern/command pair, just
 120          * ignore it instead of creating a duplicate */
 121         if (!m_strcmp(ptr->command, command.data)) {
 122           p_delete(&command.data);
 123           p_delete(&pattern.data);
 124           return 0;
 125         }
 126       } else {
 127         /* other hooks only allow one command per pattern, so update the
 128          * entry with the new command.  this currently does not change the
 129          * order of execution of the hooks, which i think is desirable since
 130          * a common action to perform is to change the default (.) entry
 131          * based upon some other information. */
 132         p_delete(&ptr->command);
 133         ptr->command = command.data;
 134         p_delete(&pattern.data);
 135         return 0;
 136       }
 137     }
 138     if (!ptr->next)
 139       break;
 140   }
 141
 142   if (data & (M_SENDHOOK | M_SEND2HOOK | M_SAVEHOOK | M_FCCHOOK |
 143               M_MESSAGEHOOK | M_REPLYHOOK))
 144   {
 145     if ((pat =
 146          mutt_pattern_comp (pattern.data,
 147                             (data & (M_SENDHOOK | M_SEND2HOOK | M_FCCHOOK)) ?
 148                             0 : M_FULL_MSG, err)) == NULL)
 149       goto error;
 150   } else {
 151     rx = p_new(regex_t, 1);
 152     if ((rc = REGCOMP(rx, NONULL(pattern.data),
 153                   ((data & M_CRYPTHOOK) ? REG_ICASE : 0))) != 0)
 154     {
 155       regerror (rc, rx, err->data, err->dsize);
 156       regfree (rx);
 157       p_delete(&rx);
 158       goto error;
 159     }
 160   }
 161
 162   if (ptr) {
 163     ptr->next = p_new(hook_t, 1);
 164     ptr = ptr->next;
 165   } else {
 166     Hooks = ptr = p_new(hook_t, 1);
 167   }
 168   ptr->type = data;
 169   ptr->command = command.data;
 170   ptr->pattern = pat;
 171   ptr->rx.pattern = pattern.data;
 172   ptr->rx.rx = rx;
 173   ptr->rx.neg = neg;
 174   return 0;
 175
 176 error:
 177   p_delete(&pattern.data);
 178   p_delete(&command.data);
 179   return (-1);
 180 }
 181
 182 /* Deletes all hooks of type ``type'', or all defined hooks if ``type'' is 0 */
 183 static void delete_hooks (long type)
 184 {
 185     hook_t **l = &Hooks;
 186
 187     while (*l) {
 188         if ((*l)->type == type) {
 189             hook_t *tmp = hook_list_pop(l);
 190             hook_delete(&tmp);
 191         } else {
 192             l = &(*l)->next;
 193         }
 194     }
 195 }
 196
 197 int mutt_parse_unhook (BUFFER * buf, BUFFER * s, unsigned long data __attribute__ ((unused)),
 198                        BUFFER * err)
 199 {
 200   while (MoreArgs (s)) {
 201     mutt_extract_token (buf, s, 0);
 202     if (m_strcmp("*", buf->data) == 0) {
 203       if (current_hook_type) {
 204         snprintf (err->data, err->dsize,
 205                   _("unhook: Can't do unhook * from within a hook."));
 206         return -1;
 207       }
 208       hook_list_wipe(&Hooks);
 209     } else {
 210       unsigned long type = mutt_get_hook_type (buf->data);
 211
 212       if (!type) {
 213         snprintf (err->data, err->dsize,
 214                   _("unhook: unknown hook type: %s"), buf->data);
 215         return (-1);
 216       }
 217       if (current_hook_type == type) {
 218         snprintf (err->data, err->dsize,
 219                   _("unhook: Can't delete a %s from within a %s."), buf->data,
 220                   buf->data);
 221         return -1;
 222       }
 223       delete_hooks (type);
 224     }
 225   }
 226   return 0;
 227 }
 228
 229 void mutt_folder_hook (char *path)
 230 {
 231   hook_t *tmp = Hooks;
 232   BUFFER err, token;
 233   char buf[STRING];
 234
 235   current_hook_type = M_FOLDERHOOK;
 236
 237   err.data = buf;
 238   err.dsize = sizeof (buf);
 239   p_clear(&token, 1);
 240   for (; tmp; tmp = tmp->next) {
 241     if (!tmp->command)
 242       continue;
 243
 244     if (tmp->type & M_FOLDERHOOK) {
 245       if ((regexec (tmp->rx.rx, path, 0, NULL, 0) == 0) ^ tmp->rx.neg) {
 246         if (mutt_parse_rc_line (tmp->command, &token, &err) == -1) {
 247           mutt_error ("%s", err.data);
 248           mutt_sleep (1);       /* pause a moment to let the user see the error */
 249         }
 250       }
 251     }
 252   }
 253   p_delete(&token.data);
 254
 255   current_hook_type = 0;
 256
 257     {
 258         lua_State *L = luaM_getruntime();
 259         lua_getfield(L, LUA_GLOBALSINDEX, "MCore");
 260         lua_getfield(L, -1, "folder_hook");
 261         lua_remove(L, -2);
 262         if (lua_isfunction(L, -1)) {
 263             lua_pushstring(L, LastFolder);
 264             lua_pushstring(L, CurrentFolder);
 265             lua_pcall(L, 2, 0, 0);
 266         } else {
 267             lua_pop(L, 1);
 268         }
 269     }
 270 }
 271
 272 char *mutt_find_hook (int type, const char *pat)
 273 {
 274   hook_t *tmp = Hooks;
 275
 276   for (; tmp; tmp = tmp->next)
 277     if (tmp->type & type) {
 278       if (regexec (tmp->rx.rx, pat, 0, NULL, 0) == 0)
 279         return (tmp->command);
 280     }
 281   return (NULL);
 282 }
 283
 284 void mutt_message_hook (CONTEXT * ctx, HEADER * hdr, int type)
 285 {
 286   BUFFER err, token;
 287   hook_t *hook;
 288   char buf[STRING];
 289
 290   current_hook_type = type;
 291
 292   err.data = buf;
 293   err.dsize = sizeof (buf);
 294   p_clear(&token, 1);
 295   for (hook = Hooks; hook; hook = hook->next) {
 296     if (!hook->command)
 297       continue;
 298
 299     if (hook->type & type)
 300       if ((mutt_pattern_exec (hook->pattern, 0, ctx, hdr) > 0) ^ hook->rx.neg)
 301         if (mutt_parse_rc_line (hook->command, &token, &err) != 0) {
 302           mutt_error ("%s", err.data);
 303           mutt_sleep (1);
 304         }
 305   }
 306   p_delete(&token.data);
 307   current_hook_type = 0;
 308 }
 309
 310 static int
 311 mutt_addr_hook (char *path, ssize_t pathlen, unsigned long type, CONTEXT * ctx,
 312                 HEADER * hdr)
 313 {
 314   hook_t *hook;
 315
 316   /* determine if a matching hook exists */
 317   for (hook = Hooks; hook; hook = hook->next) {
 318     if (!hook->command)
 319       continue;
 320
 321     if (hook->type & type)
 322       if ((mutt_pattern_exec (hook->pattern, 0, ctx, hdr) > 0) ^ hook->rx.neg) {
 323         mutt_make_string (path, pathlen, hook->command, ctx, hdr);
 324         return 0;
 325       }
 326   }
 327
 328   return -1;
 329 }
 330
 331 void mutt_default_save (char *path, ssize_t pathlen, HEADER * hdr)
 332 {
 333   *path = 0;
 334   if (mutt_addr_hook (path, pathlen, M_SAVEHOOK, Context, hdr) != 0) {
 335     char tmp[_POSIX_PATH_MAX];
 336     address_t *adr;
 337     ENVELOPE *env = hdr->env;
 338     int fromMe = mutt_addr_is_user (env->from);
 339
 340     if (!fromMe && env->reply_to && env->reply_to->mailbox)
 341       adr = env->reply_to;
 342     else if (!fromMe && env->from && env->from->mailbox)
 343       adr = env->from;
 344     else if (env->to && env->to->mailbox)
 345       adr = env->to;
 346     else if (env->cc && env->cc->mailbox)
 347       adr = env->cc;
 348     else
 349       adr = NULL;
 350     if (adr) {
 351       mutt_safe_path (tmp, sizeof (tmp), adr);
 352       snprintf (path, pathlen, "=%s", tmp);
 353     }
 354   }
 355 }
 356
 357 void mutt_select_fcc (char *path, ssize_t pathlen, HEADER * hdr)
 358 {
 359     if (mutt_addr_hook (path, pathlen, M_FCCHOOK, NULL, hdr) != 0) {
 360         m_strcpy(path, pathlen, NONULL(MAlias.record));
 361     }
 362     mutt_pretty_mailbox (path);
 363 }
 364
 365 static const char *_mutt_string_hook (const char *match, int hook)
 366 {
 367   hook_t *tmp = Hooks;
 368
 369   for (; tmp; tmp = tmp->next) {
 370     if ((tmp->type & hook)
 371     && ((match && regexec(tmp->rx.rx, match, 0, NULL, 0) == 0) ^ tmp->rx.neg))
 372       return (tmp->command);
 373   }
 374   return (NULL);
 375 }
 376
 377 const char *mutt_crypt_hook (address_t * adr)
 378 {
 379   return _mutt_string_hook (adr->mailbox, M_CRYPTHOOK);
 380 }
 381
 382 void mutt_account_hook (const char *url)
 383 {
 384   hook_t *hook;
 385   BUFFER token;
 386   BUFFER err;
 387   char buf[STRING];
 388
 389   err.data = buf;
 390   err.dsize = sizeof (buf);
 391   p_clear(&token, 1);
 392
 393   for (hook = Hooks; hook; hook = hook->next) {
 394     if (!(hook->command && (hook->type & M_ACCOUNTHOOK)))
 395       continue;
 396
 397     if ((regexec (hook->rx.rx, url, 0, NULL, 0) == 0) ^ hook->rx.neg) {
 398       if (mutt_parse_rc_line (hook->command, &token, &err) == -1) {
 399         mutt_error ("%s", err.data);
 400         mutt_sleep (1);
 401       }
 402     }
 403   }
 404
 405   p_delete(&token.data);
 406 }