1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
|
/*
* Copyright (C) 1996-2002,2004,2007 Michael R. Elkins <me@mutt.org>, and others
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#if HAVE_CONFIG_H
# include "config.h"
#endif
#include "mutt.h"
#include "mailbox.h"
#include "mutt_crypt.h"
#ifdef USE_COMPRESSED
#include "compress.h"
#endif
#include <limits.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include <unistd.h>
typedef struct hook
{
int type; /* hook type */
REGEXP rx; /* regular expression */
char *command; /* filename, command or pattern to execute */
pattern_t *pattern; /* used for fcc,save,send-hook */
struct hook *next;
} HOOK;
static HOOK *Hooks = NULL;
static int current_hook_type = 0;
int mutt_parse_hook (BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err)
{
HOOK *ptr;
BUFFER command, pattern;
int rc, not = 0;
regex_t *rx = NULL;
pattern_t *pat = NULL;
char path[_POSIX_PATH_MAX];
mutt_buffer_init (&pattern);
mutt_buffer_init (&command);
if (~data & MUTT_GLOBALHOOK)
{
if (*s->dptr == '!')
{
s->dptr++;
SKIPWS (s->dptr);
not = 1;
}
mutt_extract_token (&pattern, s, 0);
if (!MoreArgs (s))
{
strfcpy (err->data, _("too few arguments"), err->dsize);
goto error;
}
}
else
{
mutt_extract_token (&pattern, s, 0);
}
mutt_extract_token (&command, s, (data & (MUTT_FOLDERHOOK | MUTT_SENDHOOK | MUTT_SEND2HOOK | MUTT_ACCOUNTHOOK | MUTT_REPLYHOOK)) ? MUTT_TOKEN_SPACE : 0);
if (!command.data)
{
strfcpy (err->data, _("too few arguments"), err->dsize);
goto error;
}
if (MoreArgs (s))
{
strfcpy (err->data, _("too many arguments"), err->dsize);
goto error;
}
if (data & (MUTT_FOLDERHOOK | MUTT_MBOXHOOK))
{
/* Accidentally using the ^ mailbox shortcut in the .muttrc is a
* common mistake */
if ((*pattern.data == '^') && (! CurrentFolder))
{
strfcpy (err->data, _("current mailbox shortcut '^' is unset"), err->dsize);
goto error;
}
strfcpy (path, pattern.data, sizeof (path));
_mutt_expand_path (path, sizeof (path), 1);
/* Check for other mailbox shortcuts that expand to the empty string.
* This is likely a mistake too */
if (!*path && *pattern.data)
{
strfcpy (err->data, _("mailbox shortcut expanded to empty regexp"), err->dsize);
goto error;
}
FREE (&pattern.data);
memset (&pattern, 0, sizeof (pattern));
pattern.data = safe_strdup (path);
}
#ifdef USE_COMPRESSED
else if (data & (MUTT_APPENDHOOK | MUTT_OPENHOOK | MUTT_CLOSEHOOK)) {
if (mutt_comp_valid_command (command.data) == 0) {
strfcpy (err->data, _("badly formatted command string"), err->dsize);
return -1;
}
}
#endif
else if (DefaultHook && !(data & (MUTT_CHARSETHOOK | MUTT_ICONVHOOK | MUTT_ACCOUNTHOOK))
&& (!WithCrypto || !(data & MUTT_CRYPTHOOK))
)
{
char tmp[HUGE_STRING];
/* At this stage remain only message-hooks, reply-hooks, send-hooks,
* send2-hooks, save-hooks, and fcc-hooks: All those allowing full
* patterns. If given a simple regexp, we expand $default_hook.
*/
strfcpy (tmp, pattern.data, sizeof (tmp));
mutt_check_simple (tmp, sizeof (tmp), DefaultHook);
FREE (&pattern.data);
memset (&pattern, 0, sizeof (pattern));
pattern.data = safe_strdup (tmp);
}
if (data & (MUTT_MBOXHOOK | MUTT_SAVEHOOK | MUTT_FCCHOOK))
{
strfcpy (path, command.data, sizeof (path));
mutt_expand_path (path, sizeof (path));
FREE (&command.data);
memset (&command, 0, sizeof (command));
command.data = safe_strdup (path);
}
/* check to make sure that a matching hook doesn't already exist */
for (ptr = Hooks; ptr; ptr = ptr->next)
{
if (ptr->type == data &&
ptr->rx.not == not &&
!mutt_strcmp (pattern.data, ptr->rx.pattern))
{
if (data & (MUTT_FOLDERHOOK | MUTT_SENDHOOK | MUTT_SEND2HOOK | MUTT_MESSAGEHOOK | MUTT_ACCOUNTHOOK | MUTT_REPLYHOOK | MUTT_CRYPTHOOK | MUTT_TIMEOUTHOOK | MUTT_STARTUPHOOK | MUTT_SHUTDOWNHOOK))
{
/* these hooks allow multiple commands with the same
* pattern, so if we've already seen this pattern/command pair, just
* ignore it instead of creating a duplicate */
if (!mutt_strcmp (ptr->command, command.data))
{
FREE (&command.data);
FREE (&pattern.data);
return 0;
}
}
else
{
/* other hooks only allow one command per pattern, so update the
* entry with the new command. this currently does not change the
* order of execution of the hooks, which i think is desirable since
* a common action to perform is to change the default (.) entry
* based upon some other information. */
FREE (&ptr->command);
ptr->command = command.data;
FREE (&pattern.data);
return 0;
}
}
if (!ptr->next)
break;
}
if (data & (MUTT_SENDHOOK | MUTT_SEND2HOOK | MUTT_SAVEHOOK | MUTT_FCCHOOK | MUTT_MESSAGEHOOK | MUTT_REPLYHOOK))
{
if ((pat = mutt_pattern_comp (pattern.data,
(data & (MUTT_SENDHOOK | MUTT_SEND2HOOK | MUTT_FCCHOOK)) ? 0 : MUTT_FULL_MSG,
err)) == NULL)
goto error;
}
else
{
/* Hooks not allowing full patterns: Check syntax of regexp */
rx = safe_malloc (sizeof (regex_t));
#ifdef MUTT_CRYPTHOOK
if ((rc = REGCOMP (rx, NONULL(pattern.data), ((data & (MUTT_CRYPTHOOK|MUTT_CHARSETHOOK|MUTT_ICONVHOOK)) ? REG_ICASE : 0))) != 0)
#else
if ((rc = REGCOMP (rx, NONULL(pattern.data), (data & (MUTT_CHARSETHOOK|MUTT_ICONVHOOK)) ? REG_ICASE : 0)) != 0)
#endif /* MUTT_CRYPTHOOK */
{
regerror (rc, rx, err->data, err->dsize);
FREE (&rx);
goto error;
}
}
if (ptr)
{
ptr->next = safe_calloc (1, sizeof (HOOK));
ptr = ptr->next;
}
else
Hooks = ptr = safe_calloc (1, sizeof (HOOK));
ptr->type = data;
ptr->command = command.data;
ptr->pattern = pat;
ptr->rx.pattern = pattern.data;
ptr->rx.rx = rx;
ptr->rx.not = not;
return 0;
error:
FREE (&pattern.data);
FREE (&command.data);
return (-1);
}
static void delete_hook (HOOK *h)
{
FREE (&h->command);
FREE (&h->rx.pattern);
if (h->rx.rx)
{
regfree (h->rx.rx);
}
mutt_pattern_free (&h->pattern);
FREE (&h);
}
/* Deletes all hooks of type ``type'', or all defined hooks if ``type'' is 0 */
static void delete_hooks (int type)
{
HOOK *h;
HOOK *prev;
while (h = Hooks, h && (type == 0 || type == h->type))
{
Hooks = h->next;
delete_hook (h);
}
prev = h; /* Unused assignment to avoid compiler warnings */
while (h)
{
if (type == h->type)
{
prev->next = h->next;
delete_hook (h);
}
else
prev = h;
h = prev->next;
}
}
int mutt_parse_unhook (BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err)
{
while (MoreArgs (s))
{
mutt_extract_token (buf, s, 0);
if (mutt_strcmp ("*", buf->data) == 0)
{
if (current_hook_type)
{
snprintf (err->data, err->dsize,
_("unhook: Can't do unhook * from within a hook."));
return -1;
}
delete_hooks (0);
}
else
{
int type = mutt_get_hook_type (buf->data);
if (!type)
{
snprintf (err->data, err->dsize,
_("unhook: unknown hook type: %s"), buf->data);
return (-1);
}
if (current_hook_type == type)
{
snprintf (err->data, err->dsize,
_("unhook: Can't delete a %s from within a %s."),
buf->data, buf->data);
return -1;
}
delete_hooks (type);
}
}
return 0;
}
void mutt_folder_hook (char *path)
{
HOOK *tmp = Hooks;
BUFFER err, token;
current_hook_type = MUTT_FOLDERHOOK;
mutt_buffer_init (&err);
err.dsize = STRING;
err.data = safe_malloc (err.dsize);
mutt_buffer_init (&token);
for (; tmp; tmp = tmp->next)
{
if(!tmp->command)
continue;
if (tmp->type & MUTT_FOLDERHOOK)
{
if ((regexec (tmp->rx.rx, path, 0, NULL, 0) == 0) ^ tmp->rx.not)
{
if (mutt_parse_rc_line (tmp->command, &token, &err) == -1)
{
mutt_error ("%s", err.data);
FREE (&token.data);
mutt_sleep (1); /* pause a moment to let the user see the error */
current_hook_type = 0;
FREE (&err.data);
return;
}
}
}
}
FREE (&token.data);
FREE (&err.data);
current_hook_type = 0;
}
char *mutt_find_hook (int type, const char *pat)
{
HOOK *tmp = Hooks;
for (; tmp; tmp = tmp->next)
if (tmp->type & type)
{
if (regexec (tmp->rx.rx, pat, 0, NULL, 0) == 0)
return (tmp->command);
}
return (NULL);
}
void mutt_message_hook (CONTEXT *ctx, HEADER *hdr, int type)
{
BUFFER err, token;
HOOK *hook;
current_hook_type = type;
mutt_buffer_init (&err);
err.dsize = STRING;
err.data = safe_malloc (err.dsize);
mutt_buffer_init (&token);
for (hook = Hooks; hook; hook = hook->next)
{
if(!hook->command)
continue;
if (hook->type & type)
if ((mutt_pattern_exec (hook->pattern, 0, ctx, hdr) > 0) ^ hook->rx.not)
if (mutt_parse_rc_line (hook->command, &token, &err) == -1)
{
FREE (&token.data);
mutt_error ("%s", err.data);
mutt_sleep (1);
current_hook_type = 0;
FREE (&err.data);
return;
}
}
FREE (&token.data);
FREE (&err.data);
current_hook_type = 0;
}
static int
mutt_addr_hook (char *path, size_t pathlen, int type, CONTEXT *ctx, HEADER *hdr)
{
HOOK *hook;
/* determine if a matching hook exists */
for (hook = Hooks; hook; hook = hook->next)
{
if(!hook->command)
continue;
if (hook->type & type)
if ((mutt_pattern_exec (hook->pattern, 0, ctx, hdr) > 0) ^ hook->rx.not)
{
mutt_make_string (path, pathlen, hook->command, ctx, hdr);
return 0;
}
}
return -1;
}
void mutt_default_save (char *path, size_t pathlen, HEADER *hdr)
{
*path = 0;
if (mutt_addr_hook (path, pathlen, MUTT_SAVEHOOK, Context, hdr) != 0)
{
char tmp[_POSIX_PATH_MAX];
ADDRESS *adr;
ENVELOPE *env = hdr->env;
int fromMe = mutt_addr_is_user (env->from);
if (!fromMe && env->reply_to && env->reply_to->mailbox)
adr = env->reply_to;
else if (!fromMe && env->from && env->from->mailbox)
adr = env->from;
else if (env->to && env->to->mailbox)
adr = env->to;
else if (env->cc && env->cc->mailbox)
adr = env->cc;
else
adr = NULL;
if (adr)
{
mutt_safe_path (tmp, sizeof (tmp), adr);
snprintf (path, pathlen, "=%s", tmp);
}
}
}
void mutt_select_fcc (char *path, size_t pathlen, HEADER *hdr)
{
ADDRESS *adr;
char buf[_POSIX_PATH_MAX];
ENVELOPE *env = hdr->env;
if (mutt_addr_hook (path, pathlen, MUTT_FCCHOOK, NULL, hdr) != 0)
{
if ((option (OPTSAVENAME) || option (OPTFORCENAME)) &&
(env->to || env->cc || env->bcc))
{
adr = env->to ? env->to : (env->cc ? env->cc : env->bcc);
mutt_safe_path (buf, sizeof (buf), adr);
mutt_concat_path (path, NONULL(Maildir), buf, pathlen);
if (!option (OPTFORCENAME) && mx_access (path, W_OK) != 0)
strfcpy (path, NONULL (Outbox), pathlen);
}
else
strfcpy (path, NONULL (Outbox), pathlen);
}
mutt_pretty_mailbox (path, pathlen);
}
static char *_mutt_string_hook (const char *match, int hook)
{
HOOK *tmp = Hooks;
for (; tmp; tmp = tmp->next)
{
if ((tmp->type & hook) && ((match &&
regexec (tmp->rx.rx, match, 0, NULL, 0) == 0) ^ tmp->rx.not))
return (tmp->command);
}
return (NULL);
}
static LIST *_mutt_list_hook (const char *match, int hook)
{
HOOK *tmp = Hooks;
LIST *matches = NULL;
for (; tmp; tmp = tmp->next)
{
if ((tmp->type & hook) &&
((match && regexec (tmp->rx.rx, match, 0, NULL, 0) == 0) ^ tmp->rx.not))
matches = mutt_add_list (matches, tmp->command);
}
return (matches);
}
char *mutt_charset_hook (const char *chs)
{
return _mutt_string_hook (chs, MUTT_CHARSETHOOK);
}
char *mutt_iconv_hook (const char *chs)
{
return _mutt_string_hook (chs, MUTT_ICONVHOOK);
}
LIST *mutt_crypt_hook (ADDRESS *adr)
{
return _mutt_list_hook (adr->mailbox, MUTT_CRYPTHOOK);
}
#ifdef USE_SOCKET
void mutt_account_hook (const char* url)
{
/* parsing commands with URLs in an account hook can cause a recursive
* call. We just skip processing if this occurs. Typically such commands
* belong in a folder-hook -- perhaps we should warn the user. */
static int inhook = 0;
HOOK* hook;
BUFFER token;
BUFFER err;
if (inhook)
return;
mutt_buffer_init (&err);
err.dsize = STRING;
err.data = safe_malloc (err.dsize);
mutt_buffer_init (&token);
for (hook = Hooks; hook; hook = hook->next)
{
if (! (hook->command && (hook->type & MUTT_ACCOUNTHOOK)))
continue;
if ((regexec (hook->rx.rx, url, 0, NULL, 0) == 0) ^ hook->rx.not)
{
inhook = 1;
if (mutt_parse_rc_line (hook->command, &token, &err) == -1)
{
FREE (&token.data);
mutt_error ("%s", err.data);
FREE (&err.data);
mutt_sleep (1);
inhook = 0;
return;
}
inhook = 0;
}
}
FREE (&token.data);
FREE (&err.data);
}
#endif
void mutt_timeout_hook (void)
{
HOOK *hook;
BUFFER token;
BUFFER err;
char buf[STRING];
err.data = buf;
err.dsize = sizeof (buf);
memset (&token, 0, sizeof (token));
for (hook = Hooks; hook; hook = hook->next)
{
if (!(hook->command && (hook->type & MUTT_TIMEOUTHOOK)))
continue;
if (mutt_parse_rc_line (hook->command, &token, &err) == -1)
{
FREE (&token.data);
mutt_error ("%s", err.data);
mutt_sleep (1);
/* The hooks should be independent of each other, so even though this on
* failed, we'll carry on with the others. */
}
}
}
/**
* mutt_startup_shutdown_hook - Execute any startup/shutdown hooks
* @type: Hook type: MUTT_STARTUPHOOK or MUTT_SHUTDOWNHOOK
*
* The user can configure hooks to be run on startup/shutdown.
* This function finds all the matching hooks and executes them.
*/
void mutt_startup_shutdown_hook (int type)
{
HOOK *hook;
BUFFER token;
BUFFER err;
char buf[STRING];
err.data = buf;
err.dsize = sizeof (buf);
memset (&token, 0, sizeof (token));
for (hook = Hooks; hook; hook = hook->next)
{
if (!(hook->command && (hook->type & type)))
continue;
if (mutt_parse_rc_line (hook->command, &token, &err) == -1)
{
FREE (&token.data);
mutt_error ("%s", err.data);
mutt_sleep (1);
}
}
}
|