upstream/extra-patches/compressed-folders

   1 # vi: ft=diff
   2 This is the compressed folders patch by Roland Rosenfeld
   3 <roland@spinnaker.de>.
   4
   5 The home page for this patch is:
   6
   7   http://www.spinnaker.de/mutt/compressed/
   8
   9 * Patch last synced with upstream:
  10   - Date: 2005-08-14
  11   - File: http://www.spinnaker.de/mutt/compressed/patch-1.5.10.rr.compressed.1.gz
  12
  13 * Changes made:
  14   - filterdiff -p1 \
  15     $(for f in Makefile.in config.h.in configure 'Muttrc*' doc/manual.txt \
  16       doc/manual.sgml 'doc/manual*.html' doc/muttrc.man; do echo "-x $f"; done)
  17
  18 == END PATCH
  19 diff -urN mutt-1.5.10/compress.c mutt-1.5.10-ro/compress.c
  20 --- mutt-1.5.10/compress.c      1970-01-01 01:00:00.000000000 +0100
  21 +++ mutt-1.5.10-ro/compress.c   2005-08-14 12:10:21.000000000 +0200
  22 @@ -0,0 +1,487 @@
  23 +/*
  24 + * Copyright (C) 1997 Alain Penders <Alain@Finale-Dev.com>
  25 + *
  26 + *     This program is free software; you can redistribute it and/or modify
  27 + *     it under the terms of the GNU General Public License as published by
  28 + *     the Free Software Foundation; either version 2 of the License, or
  29 + *     (at your option) any later version.
  30 + *
  31 + *     This program is distributed in the hope that it will be useful,
  32 + *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  33 + *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  34 + *     GNU General Public License for more details.
  35 + *
  36 + *     You should have received a copy of the GNU General Public License
  37 + *     along with this program; if not, write to the Free Software
  38 + *     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  39 + */
  40 +
  41 +#if HAVE_CONFIG_H
  42 +# include "config.h"
  43 +#endif
  44 +
  45 +#include "mutt.h"
  46 +
  47 +#ifdef USE_COMPRESSED
  48 +
  49 +#include "mx.h"
  50 +#include "mailbox.h"
  51 +#include "mutt_curses.h"
  52 +
  53 +#include <errno.h>
  54 +#include <string.h>
  55 +#include <unistd.h>
  56 +#include <sys/stat.h>
  57 +
  58 +typedef struct
  59 +{
  60 +  const char *close;   /* close-hook  command */
  61 +  const char *open;    /* open-hook   command */
  62 +  const char *append;  /* append-hook command */
  63 +  off_t size;          /* size of real folder */
  64 +} COMPRESS_INFO;
  65 +
  66 +
  67 +/*
  68 + * ctx - context to lock
  69 + * excl - exclusive lock?
  70 + * retry - should retry if unable to lock?
  71 + */
  72 +int mbox_lock_compressed (CONTEXT *ctx, FILE *fp, int excl, int retry)
  73 +{
  74 +  int r;
  75 +
  76 +  if ((r = mx_lock_file (ctx->realpath, fileno (fp), excl, 1, retry)) == 0)
  77 +    ctx->locked = 1;
  78 +  else if (retry && !excl)
  79 +  {
  80 +    ctx->readonly = 1;
  81 +    return 0;
  82 +  }
  83 +
  84 +  return (r);
  85 +}
  86 +
  87 +void mbox_unlock_compressed (CONTEXT *ctx, FILE *fp)
  88 +{
  89 +  if (ctx->locked)
  90 +  {
  91 +    fflush (fp);
  92 +
  93 +    mx_unlock_file (ctx->realpath, fileno (fp), 1);
  94 +    ctx->locked = 0;
  95 +  }
  96 +}
  97 +
  98 +static int is_new (const char *path)
  99 +{
 100 +  return (access (path, W_OK) != 0 && errno == ENOENT) ? 1 : 0;
 101 +}
 102 +
 103 +static const char* find_compress_hook (int type, const char *path)
 104 +{
 105 +  const char* c = mutt_find_hook (type, path);
 106 +  return (!c || !*c) ? NULL : c;
 107 +}
 108 +
 109 +int mutt_can_read_compressed (const char *path)
 110 +{
 111 +  return find_compress_hook (M_OPENHOOK, path) ? 1 : 0;
 112 +}
 113 +
 114 +/*
 115 + * if the file is new, we really do not append, but create, and so use
 116 + * close-hook, and not append-hook
 117 + */
 118 +static const char* get_append_command (const char *path, const CONTEXT* ctx)
 119 +{
 120 +  COMPRESS_INFO *ci = (COMPRESS_INFO *) ctx->compressinfo;
 121 +  return (is_new (path)) ? ci->close : ci->append;
 122 +}
 123 +
 124 +int mutt_can_append_compressed (const char *path)
 125 +{
 126 +  int magic;
 127 +
 128 +  if (is_new (path))
 129 +    return (find_compress_hook (M_CLOSEHOOK, path) ? 1 : 0);
 130 +
 131 +  magic = mx_get_magic (path);
 132 +
 133 +  if (magic != 0 && magic != M_COMPRESSED)
 134 +    return 0;
 135 +
 136 +  return (find_compress_hook (M_APPENDHOOK, path)
 137 +         || (find_compress_hook (M_OPENHOOK, path)
 138 +             && find_compress_hook (M_CLOSEHOOK, path))) ? 1 : 0;
 139 +}
 140 +
 141 +/* open a compressed mailbox */
 142 +static COMPRESS_INFO *set_compress_info (CONTEXT *ctx)
 143 +{
 144 +  COMPRESS_INFO *ci;
 145 +
 146 +  /* Now lets uncompress this thing */
 147 +  ci = safe_malloc (sizeof (COMPRESS_INFO));
 148 +  ctx->compressinfo = (void*) ci;
 149 +  ci->append = find_compress_hook (M_APPENDHOOK, ctx->path);
 150 +  ci->open = find_compress_hook (M_OPENHOOK, ctx->path);
 151 +  ci->close = find_compress_hook (M_CLOSEHOOK, ctx->path);
 152 +  return ci;
 153 +}
 154 +
 155 +static void set_path (CONTEXT* ctx)
 156 +{
 157 +  char tmppath[_POSIX_PATH_MAX];
 158 +
 159 +  /* Setup the right paths */
 160 +  ctx->realpath = ctx->path;
 161 +
 162 +  /* Uncompress to /tmp */
 163 +  mutt_mktemp (tmppath);
 164 +  ctx->path = safe_malloc (strlen (tmppath) + 1);
 165 +  strcpy (ctx->path, tmppath);
 166 +}
 167 +
 168 +static int get_size (const char* path)
 169 +{
 170 +  struct stat sb;
 171 +  if (stat (path, &sb) != 0)
 172 +    return 0;
 173 +  return (sb.st_size);
 174 +}
 175 +
 176 +static void store_size (CONTEXT* ctx)
 177 +{
 178 +  COMPRESS_INFO *ci = (COMPRESS_INFO *) ctx->compressinfo;
 179 +  ci->size = get_size (ctx->realpath);
 180 +}
 181 +
 182 +static const char *
 183 +compresshook_format_str (char *dest, size_t destlen, char op, const char *src,
 184 +                        const char *fmt, const char *ifstring,
 185 +                        const char *elsestring, unsigned long data,
 186 +                        format_flag flags)
 187 +{
 188 +  char tmp[SHORT_STRING];
 189 +
 190 +  CONTEXT *ctx = (CONTEXT *) data;
 191 +  switch (op)
 192 +  {
 193 +  case 'f':
 194 +    snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
 195 +    snprintf (dest, destlen, tmp, ctx->realpath);
 196 +    break;
 197 +  case 't':
 198 +    snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
 199 +    snprintf (dest, destlen, tmp, ctx->path);
 200 +    break;
 201 +  }
 202 +  return (src);
 203 +}
 204 +
 205 +/*
 206 + * check that the command has both %f and %t
 207 + * 0 means OK, -1 means error
 208 + */
 209 +int mutt_test_compress_command (const char* cmd)
 210 +{
 211 +  return (strstr (cmd, "%f") && strstr (cmd, "%t")) ? 0 : -1;
 212 +}
 213 +
 214 +static char *get_compression_cmd (const char* cmd, const CONTEXT* ctx)
 215 +{
 216 +  char expanded[_POSIX_PATH_MAX];
 217 +  mutt_FormatString (expanded, sizeof (expanded), cmd, compresshook_format_str,
 218 +                    (unsigned long) ctx, 0);
 219 +  return safe_strdup (expanded);
 220 +}
 221 +
 222 +int mutt_check_mailbox_compressed (CONTEXT* ctx)
 223 +{
 224 +  COMPRESS_INFO *ci = (COMPRESS_INFO *) ctx->compressinfo;
 225 +  if (ci->size != get_size (ctx->realpath))
 226 +  {
 227 +    FREE (&ctx->compressinfo);
 228 +    FREE (&ctx->realpath);
 229 +    mutt_error _("Mailbox was corrupted!");
 230 +    return (-1);
 231 +  }
 232 +  return (0);
 233 +}
 234 +
 235 +int mutt_open_read_compressed (CONTEXT *ctx)
 236 +{
 237 +  char *cmd;
 238 +  FILE *fp;
 239 +  int rc;
 240 +
 241 +  COMPRESS_INFO *ci = set_compress_info (ctx);
 242 +  if (!ci->open) {
 243 +    ctx->magic = 0;
 244 +    FREE (ctx->compressinfo);
 245 +    return (-1);
 246 +  }
 247 +  if (!ci->close || access (ctx->path, W_OK) != 0)
 248 +    ctx->readonly = 1;
 249 +
 250 +  set_path (ctx);
 251 +  store_size (ctx);
 252 +
 253 +  if (!ctx->quiet)
 254 +    mutt_message (_("Decompressing %s..."), ctx->realpath);
 255 +
 256 +  cmd = get_compression_cmd (ci->open, ctx);
 257 +  if (cmd == NULL)
 258 +    return (-1);
 259 +  dprint (2, (debugfile, "DecompressCmd: '%s'\n", cmd));
 260 +
 261 +  if ((fp = fopen (ctx->realpath, "r")) == NULL)
 262 +  {
 263 +    mutt_perror (ctx->realpath);
 264 +    FREE (&cmd);
 265 +    return (-1);
 266 +  }
 267 +  mutt_block_signals ();
 268 +  if (mbox_lock_compressed (ctx, fp, 0, 1) == -1)
 269 +  {
 270 +    fclose (fp);
 271 +    mutt_unblock_signals ();
 272 +    mutt_error _("Unable to lock mailbox!");
 273 +    FREE (&cmd);
 274 +    return (-1);
 275 +  }
 276 +
 277 +  endwin ();
 278 +  fflush (stdout);
 279 +  fprintf (stderr, _("Decompressing %s...\n"),ctx->realpath);
 280 +  rc = mutt_system (cmd);
 281 +  mbox_unlock_compressed (ctx, fp);
 282 +  mutt_unblock_signals ();
 283 +  fclose (fp);
 284 +
 285 +  if (rc)
 286 +  {
 287 +    mutt_any_key_to_continue (NULL);
 288 +    ctx->magic = 0;
 289 +    FREE (ctx->compressinfo);
 290 +    mutt_error (_("Error executing: %s : unable to open the mailbox!\n"), cmd);
 291 +  }
 292 +  FREE (&cmd);
 293 +  if (rc)
 294 +    return (-1);
 295 +
 296 +  if (mutt_check_mailbox_compressed (ctx))
 297 +    return (-1);
 298 +
 299 +  ctx->magic = mx_get_magic (ctx->path);
 300 +
 301 +  return (0);
 302 +}
 303 +
 304 +void restore_path (CONTEXT* ctx)
 305 +{
 306 +  FREE (&ctx->path);
 307 +  ctx->path = ctx->realpath;
 308 +}
 309 +
 310 +/* remove the temporary mailbox */
 311 +void remove_file (CONTEXT* ctx)
 312 +{
 313 +  if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
 314 +    remove (ctx->path);
 315 +}
 316 +
 317 +int mutt_open_append_compressed (CONTEXT *ctx)
 318 +{
 319 +  FILE *fh;
 320 +  COMPRESS_INFO *ci = set_compress_info (ctx);
 321 +
 322 +  if (!get_append_command (ctx->path, ctx))
 323 +  {
 324 +    if (ci->open && ci->close)
 325 +      return (mutt_open_read_compressed (ctx));
 326 +
 327 +    ctx->magic = 0;
 328 +    FREE (&ctx->compressinfo);
 329 +    return (-1);
 330 +  }
 331 +
 332 +  set_path (ctx);
 333 +
 334 +  ctx->magic = DefaultMagic;
 335 +
 336 +  if (!is_new (ctx->realpath))
 337 +    if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
 338 +      if ((fh = fopen (ctx->path, "w")))
 339 +       fclose (fh);
 340 +  /* No error checking - the parent function will catch it */
 341 +
 342 +  return (0);
 343 +}
 344 +
 345 +/* close a compressed mailbox */
 346 +void mutt_fast_close_compressed (CONTEXT *ctx)
 347 +{
 348 +  dprint (2, (debugfile, "mutt_fast_close_compressed called on '%s'\n",
 349 +             ctx->path));
 350 +
 351 +  if (ctx->compressinfo)
 352 +  {
 353 +    if (ctx->fp)
 354 +      fclose (ctx->fp);
 355 +    ctx->fp = NULL;
 356 +    /* if the folder was removed, remove the gzipped folder too */
 357 +    if ((ctx->magic > 0)
 358 +       && (access (ctx->path, F_OK) != 0)
 359 +       && ! option (OPTSAVEEMPTY))
 360 +      remove (ctx->realpath);
 361 +    else
 362 +      remove_file (ctx);
 363 +
 364 +    restore_path (ctx);
 365 +    FREE (&ctx->compressinfo);
 366 +  }
 367 +}
 368 +
 369 +/* return 0 on success, -1 on failure */
 370 +int mutt_sync_compressed (CONTEXT* ctx)
 371 +{
 372 +  char *cmd;
 373 +  int rc = 0;
 374 +  FILE *fp;
 375 +  COMPRESS_INFO *ci = (COMPRESS_INFO *) ctx->compressinfo;
 376 +
 377 +  if (!ctx->quiet)
 378 +    mutt_message (_("Compressing %s..."), ctx->realpath);
 379 +
 380 +  cmd = get_compression_cmd (ci->close, ctx);
 381 +  if (cmd == NULL)
 382 +    return (-1);
 383 +
 384 +  if ((fp = fopen (ctx->realpath, "a")) == NULL)
 385 +  {
 386 +    mutt_perror (ctx->realpath);
 387 +    FREE (&cmd);
 388 +    return (-1);
 389 +  }
 390 +  mutt_block_signals ();
 391 +  if (mbox_lock_compressed (ctx, fp, 1, 1) == -1)
 392 +  {
 393 +    fclose (fp);
 394 +    mutt_unblock_signals ();
 395 +    mutt_error _("Unable to lock mailbox!");
 396 +    store_size (ctx);
 397 +    FREE (&cmd);
 398 +    return (-1);
 399 +  }
 400 +
 401 +  dprint (2, (debugfile, "CompressCommand: '%s'\n", cmd));
 402 +
 403 +  endwin ();
 404 +  fflush (stdout);
 405 +  fprintf (stderr, _("Compressing %s...\n"), ctx->realpath);
 406 +  if (mutt_system (cmd))
 407 +  {
 408 +    mutt_any_key_to_continue (NULL);
 409 +    mutt_error (_("%s: Error compressing mailbox! Original mailbox deleted, uncompressed one kept!\n"), ctx->path);
 410 +    rc = -1;
 411 +  }
 412 +
 413 +  mbox_unlock_compressed (ctx, fp);
 414 +  mutt_unblock_signals ();
 415 +  fclose (fp);
 416 +
 417 +  FREE (&cmd);
 418 +
 419 +  store_size (ctx);
 420 +
 421 +  return (rc);
 422 +}
 423 +
 424 +int mutt_slow_close_compressed (CONTEXT *ctx)
 425 +{
 426 +  FILE *fp;
 427 +  const char *append;
 428 +  char *cmd;
 429 +  COMPRESS_INFO *ci = (COMPRESS_INFO *) ctx->compressinfo;
 430 +
 431 +  dprint (2, (debugfile, "mutt_slow_close_compressed called on '%s'\n",
 432 +             ctx->path));
 433 +
 434 +  if (! (ctx->append
 435 +        && ((append = get_append_command (ctx->realpath, ctx))
 436 +            || (append = ci->close))))
 437 +  {
 438 +    /* if we can not or should not append, we only have to remove the */
 439 +    /* compressed info, because sync was already called               */
 440 +    mutt_fast_close_compressed (ctx);
 441 +    return (0);
 442 +  }
 443 +
 444 +  if (ctx->fp)
 445 +    fclose (ctx->fp);
 446 +  ctx->fp = NULL;
 447 +
 448 +  if (!ctx->quiet)
 449 +  {
 450 +    if (append == ci->close)
 451 +      mutt_message (_("Compressing %s..."), ctx->realpath);
 452 +    else
 453 +      mutt_message (_("Compressed-appending to %s..."), ctx->realpath);
 454 +  }
 455 +
 456 +  cmd = get_compression_cmd (append, ctx);
 457 +  if (cmd == NULL)
 458 +    return (-1);
 459 +
 460 +  if ((fp = fopen (ctx->realpath, "a")) == NULL)
 461 +  {
 462 +    mutt_perror (ctx->realpath);
 463 +    FREE (&cmd);
 464 +    return (-1);
 465 +  }
 466 +  mutt_block_signals ();
 467 +  if (mbox_lock_compressed (ctx, fp, 1, 1) == -1)
 468 +  {
 469 +    fclose (fp);
 470 +    mutt_unblock_signals ();
 471 +    mutt_error _("Unable to lock mailbox!");
 472 +    FREE (&cmd);
 473 +    return (-1);
 474 +  }
 475 +
 476 +  dprint (2, (debugfile, "CompressCmd: '%s'\n", cmd));
 477 +
 478 +  endwin ();
 479 +  fflush (stdout);
 480 +
 481 +  if (append == ci->close)
 482 +    fprintf (stderr, _("Compressing %s...\n"), ctx->realpath);
 483 +  else
 484 +    fprintf (stderr, _("Compressed-appending to %s...\n"), ctx->realpath);
 485 +
 486 +  if (mutt_system (cmd))
 487 +  {
 488 +    mutt_any_key_to_continue (NULL);
 489 +    mutt_error (_(" %s: Error compressing mailbox!  Uncompressed one kept!\n"),
 490 +               ctx->path);
 491 +    FREE (&cmd);
 492 +    mbox_unlock_compressed (ctx, fp);
 493 +    mutt_unblock_signals ();
 494 +    fclose (fp);
 495 +    return (-1);
 496 +  }
 497 +
 498 +  mbox_unlock_compressed (ctx, fp);
 499 +  mutt_unblock_signals ();
 500 +  fclose (fp);
 501 +  remove_file (ctx);
 502 +  restore_path (ctx);
 503 +  FREE (&cmd);
 504 +  FREE (&ctx->compressinfo);
 505 +
 506 +  return (0);
 507 +}
 508 +
 509 +#endif /* USE_COMPRESSED */
 510 diff -urN mutt-1.5.10/compress.h mutt-1.5.10-ro/compress.h
 511 --- mutt-1.5.10/compress.h      1970-01-01 01:00:00.000000000 +0100
 512 +++ mutt-1.5.10-ro/compress.h   2005-08-14 12:10:21.000000000 +0200
 513 @@ -0,0 +1,27 @@
 514 +/*
 515 + * Copyright (C) 1997 Alain Penders <Alain@Finale-Dev.com>
 516 + *
 517 + *     This program is free software; you can redistribute it and/or modify
 518 + *     it under the terms of the GNU General Public License as published by
 519 + *     the Free Software Foundation; either version 2 of the License, or
 520 + *     (at your option) any later version.
 521 + *
 522 + *     This program is distributed in the hope that it will be useful,
 523 + *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 524 + *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 525 + *     GNU General Public License for more details.
 526 + *
 527 + *     You should have received a copy of the GNU General Public License
 528 + *     along with this program; if not, write to the Free Software
 529 + *     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 530 + */
 531 +
 532 +int mutt_can_read_compressed (const char *);
 533 +int mutt_can_append_compressed (const char *);
 534 +int mutt_open_read_compressed (CONTEXT *);
 535 +int mutt_open_append_compressed (CONTEXT *);
 536 +int mutt_slow_close_compressed (CONTEXT *);
 537 +int mutt_sync_compressed (CONTEXT *);
 538 +int mutt_test_compress_command (const char *);
 539 +int mutt_check_mailbox_compressed (CONTEXT *);
 540 +void mutt_fast_close_compressed (CONTEXT *);
 541 diff -urN mutt-1.5.10/config.h.in mutt-1.5.10-ro/config.h.in
 542 diff -urN mutt-1.5.10/configure mutt-1.5.10-ro/configure
 543 diff -urN mutt-1.5.10/configure.in mutt-1.5.10-ro/configure.in
 544 --- mutt-1.5.10/configure.in    2005-08-11 23:49:24.000000000 +0200
 545 +++ mutt-1.5.10-ro/configure.in 2005-08-14 12:10:21.000000000 +0200
 546 @@ -753,6 +753,11 @@
 547                  AC_DEFINE(LOCALES_HACK,1,[ Define if the result of isprint() is unreliable. ])
 548          fi])
 549
 550 +AC_ARG_ENABLE(compressed, AC_HELP_STRING([--enable-compressed], [Enable compressed folders support]),
 551 +       [if test x$enableval = xyes; then
 552 +                AC_DEFINE(USE_COMPRESSED,1, [ Define to support compressed folders. ])
 553 +        fi])
 554 +
 555  AC_ARG_WITH(exec-shell, AC_HELP_STRING([--with-exec-shell=SHELL], [Specify alternate shell (ONLY if /bin/sh is broken)]),
 556          [if test $withval != yes; then
 557                  AC_DEFINE_UNQUOTED(EXECSHELL, "$withval",
 558 diff -urN mutt-1.5.10/curs_main.c mutt-1.5.10-ro/curs_main.c
 559 --- mutt-1.5.10/curs_main.c     2005-08-11 21:37:01.000000000 +0200
 560 +++ mutt-1.5.10-ro/curs_main.c  2005-08-14 12:10:21.000000000 +0200
 561 @@ -1087,6 +1087,11 @@
 562          {
 563           int check;
 564
 565 +#ifdef USE_COMPRESSED
 566 +         if (Context->compressinfo && Context->realpath)
 567 +           mutt_str_replace (&LastFolder, Context->realpath);
 568 +         else
 569 +#endif
 570           mutt_str_replace (&LastFolder, Context->path);
 571           oldcount = Context ? Context->msgcount : 0;
 572
 573 diff -urN mutt-1.5.10/doc/manual-4.html mutt-1.5.10-ro/doc/manual-4.html
 574 diff -urN mutt-1.5.10/doc/manual-6.html mutt-1.5.10-ro/doc/manual-6.html
 575 diff -urN mutt-1.5.10/doc/manual.html mutt-1.5.10-ro/doc/manual.html
 576 diff -urN mutt-1.5.10/doc/manual.sgml mutt-1.5.10-ro/doc/manual.sgml
 577 diff -urN mutt-1.5.10/doc/manual.sgml.head mutt-1.5.10-ro/doc/manual.sgml.head
 578 diff -urN mutt-1.5.10/doc/manual.txt mutt-1.5.10-ro/doc/manual.txt
 579 diff -urN mutt-1.5.10/doc/muttrc.man mutt-1.5.10-ro/doc/muttrc.man
 580 diff -urN mutt-1.5.10/doc/muttrc.man.head mutt-1.5.10-ro/doc/muttrc.man.head
 581 --- mutt-1.5.10/doc/muttrc.man.head     2005-01-15 10:42:45.000000000 +0100
 582 +++ mutt-1.5.10-ro/doc/muttrc.man.head  2005-08-14 12:10:21.000000000 +0200
 583 @@ -316,6 +316,24 @@
 584  to a certain recipient.  The meaning of "key ID" is to be taken
 585  broadly: This can be a different e-mail address, a numerical key ID,
 586  or even just an arbitrary search string.
 587 +.PP
 588 +.nf
 589 +\fBopen-hook\fP \fIregexp\fP "\fIcommand\fP"
 590 +\fBclose-hook\fP \fIregexp\fP "\fIcommand\fP"
 591 +\fBappend-hook\fP \fIregexp\fP "\fIcommand\fP"
 592 +.fi
 593 +.IP
 594 +These commands provide a way to handle compressed folders. The given
 595 +\fBregexp\fP specifies which folders are taken as compressed (e.g.
 596 +"\fI\\\\.gz$\fP"). The commands tell Mutt how to uncompress a folder
 597 +(\fBopen-hook\fP), compress a folder (\fBclose-hook\fP) or append a
 598 +compressed mail to a compressed folder (\fBappend-hook\fP). The
 599 +\fIcommand\fP string is the
 600 +.BR printf (3)
 601 +like format string, and it should accept two parameters: \fB%f\fP,
 602 +which is replaced with the (compressed) folder name, and \fB%t\fP
 603 +which is replaced with the name of the temporary folder to which to
 604 +write.
 605  .TP
 606  \fBpush\fP \fIstring\fP
 607  This command adds the named \fIstring\fP to the keyboard buffer.
 608 diff -urN mutt-1.5.10/hook.c mutt-1.5.10-ro/hook.c
 609 --- mutt-1.5.10/hook.c  2005-02-03 19:47:52.000000000 +0100
 610 +++ mutt-1.5.10-ro/hook.c       2005-08-14 12:10:21.000000000 +0200
 611 @@ -24,6 +24,10 @@
 612  #include "mailbox.h"
 613  #include "mutt_crypt.h"
 614
 615 +#ifdef USE_COMPRESSED
 616 +#include "compress.h"
 617 +#endif
 618 +
 619  #include <limits.h>
 620  #include <string.h>
 621  #include <stdlib.h>
 622 @@ -92,6 +96,16 @@
 623      memset (&pattern, 0, sizeof (pattern));
 624      pattern.data = safe_strdup (path);
 625    }
 626 +#ifdef USE_COMPRESSED
 627 +  else if (data & (M_APPENDHOOK | M_OPENHOOK | M_CLOSEHOOK))
 628 +  {
 629 +    if (mutt_test_compress_command (command.data))
 630 +    {
 631 +      strfcpy (err->data, _("bad formatted command string"), err->dsize);
 632 +      return (-1);
 633 +    }
 634 +  }
 635 +#endif
 636    else if (DefaultHook && !(data & (M_CHARSETHOOK | M_ACCOUNTHOOK))
 637             && (!WithCrypto || !(data & M_CRYPTHOOK))
 638        )
 639 diff -urN mutt-1.5.10/init.h mutt-1.5.10-ro/init.h
 640 --- mutt-1.5.10/init.h  2005-08-11 21:37:01.000000000 +0200
 641 +++ mutt-1.5.10-ro/init.h       2005-08-14 12:10:21.000000000 +0200
 642 @@ -2979,6 +2979,11 @@
 643    { "fcc-hook",                mutt_parse_hook,        M_FCCHOOK },
 644    { "fcc-save-hook",   mutt_parse_hook,        M_FCCHOOK | M_SAVEHOOK },
 645    { "folder-hook",     mutt_parse_hook,        M_FOLDERHOOK },
 646 +#ifdef USE_COMPRESSED
 647 +  { "open-hook",       mutt_parse_hook,        M_OPENHOOK },
 648 +  { "close-hook",      mutt_parse_hook,        M_CLOSEHOOK },
 649 +  { "append-hook",     mutt_parse_hook,        M_APPENDHOOK },
 650 +#endif
 651    { "hdr_order",       parse_list,             UL &HeaderOrderList },
 652  #ifdef HAVE_ICONV
 653    { "iconv-hook",      mutt_parse_hook,        M_ICONVHOOK },
 654 diff -urN mutt-1.5.10/main.c mutt-1.5.10-ro/main.c
 655 --- mutt-1.5.10/main.c  2005-08-11 21:37:01.000000000 +0200
 656 +++ mutt-1.5.10-ro/main.c       2005-08-14 12:10:21.000000000 +0200
 657 @@ -382,6 +382,12 @@
 658  #else
 659         "-LOCALES_HACK  "
 660  #endif
 661 +
 662 +#ifdef USE_COMPRESSED
 663 +       "+COMPRESSED  "
 664 +#else
 665 +       "-COMPRESSED  "
 666 +#endif
 667
 668  #ifdef HAVE_WC_FUNCS
 669         "+HAVE_WC_FUNCS  "
 670 diff -urN mutt-1.5.10/Makefile.am mutt-1.5.10-ro/Makefile.am
 671 --- mutt-1.5.10/Makefile.am     2005-08-11 23:27:28.000000000 +0200
 672 +++ mutt-1.5.10-ro/Makefile.am  2005-08-14 12:10:21.000000000 +0200
 673 @@ -18,7 +18,7 @@
 674  bin_PROGRAMS = mutt @DOTLOCK_TARGET@ @PGPAUX_TARGET@
 675  mutt_SOURCES = $(BUILT_SOURCES) \
 676         addrbook.c alias.c attach.c base64.c browser.c buffy.c color.c \
 677 -        crypt.c cryptglue.c \
 678 +        crypt.c cryptglue.c compress.c \
 679         commands.c complete.c compose.c copy.c curs_lib.c curs_main.c date.c \
 680         edit.c enter.c flags.c init.c filter.c from.c getdomain.c \
 681         handler.c hash.c hdrline.c headers.c help.c hook.c keymap.c \
 682 @@ -67,7 +67,7 @@
 683         crypt-gpgme.c crypt-mod-pgp-gpgme.c crypt-mod-smime-gpgme.c
 684
 685  EXTRA_DIST = COPYRIGHT GPL OPS OPS.PGP OPS.CRYPT OPS.SMIME TODO \
 686 -       configure account.h \
 687 +       configure account.h compress.h \
 688         attach.h buffy.h charset.h copy.h crypthash.h dotlock.h functions.h gen_defs \
 689         globals.h hash.h history.h init.h keymap.h mutt_crypt.h \
 690         mailbox.h mapping.h md5.h mime.h mutt.h mutt_curses.h mutt_menu.h \
 691 diff -urN mutt-1.5.10/Makefile.in mutt-1.5.10-ro/Makefile.in
 692 diff -urN mutt-1.5.10/mbox.c mutt-1.5.10-ro/mbox.c
 693 --- mutt-1.5.10/mbox.c  2005-08-02 09:08:00.000000000 +0200
 694 +++ mutt-1.5.10-ro/mbox.c       2005-08-14 12:10:21.000000000 +0200
 695 @@ -28,6 +28,10 @@
 696  #include "sort.h"
 697  #include "copy.h"
 698
 699 +#ifdef USE_COMPRESSED
 700 +#include "compress.h"
 701 +#endif
 702 +
 703  #include <sys/stat.h>
 704  #include <dirent.h>
 705  #include <string.h>
 706 @@ -1014,6 +1018,12 @@
 707  int mbox_close_mailbox (CONTEXT *ctx)
 708  {
 709    mx_unlock_file (ctx->path, fileno (ctx->fp), 1);
 710 +
 711 +#ifdef USE_COMPRESSED
 712 +  if (ctx->compressinfo)
 713 +    mutt_slow_close_compressed (ctx);
 714 +#endif
 715 +
 716    mutt_unblock_signals ();
 717    mx_fastclose_mailbox (ctx);
 718    return 0;
 719 diff -urN mutt-1.5.10/mutt.h mutt-1.5.10-ro/mutt.h
 720 --- mutt-1.5.10/mutt.h  2005-08-11 21:37:23.000000000 +0200
 721 +++ mutt-1.5.10-ro/mutt.h       2005-08-14 12:10:21.000000000 +0200
 722 @@ -161,6 +161,11 @@
 723  #define M_ACCOUNTHOOK  (1<<9)
 724  #define M_REPLYHOOK    (1<<10)
 725  #define M_SEND2HOOK     (1<<11)
 726 +#ifdef USE_COMPRESSED
 727 +#define M_OPENHOOK     (1<<12)
 728 +#define M_APPENDHOOK   (1<<13)
 729 +#define M_CLOSEHOOK    (1<<14)
 730 +#endif
 731
 732  /* tree characters for linearize_tree and print_enriched_string */
 733  #define M_TREE_LLCORNER                1
 734 @@ -829,6 +834,11 @@
 735    void *data;                  /* driver specific data */
 736  #endif /* USE_IMAP */
 737
 738 +#ifdef USE_COMPRESSED
 739 +  void *compressinfo;          /* compressed mbox module private data */
 740 +  char *realpath;              /* path to compressed mailbox */
 741 +#endif /* USE_COMPRESSED */
 742 +
 743    short magic;                 /* mailbox type */
 744
 745    unsigned int locked : 1;     /* is the mailbox locked? */
 746 diff -urN mutt-1.5.10/Muttrc mutt-1.5.10-ro/Muttrc
 747 diff -urN mutt-1.5.10/Muttrc.head mutt-1.5.10-ro/Muttrc.head
 748 diff -urN mutt-1.5.10/Muttrc.head.in mutt-1.5.10-ro/Muttrc.head.in
 749 diff -urN mutt-1.5.10/mx.c mutt-1.5.10-ro/mx.c
 750 --- mutt-1.5.10/mx.c    2005-08-02 09:08:01.000000000 +0200
 751 +++ mutt-1.5.10-ro/mx.c 2005-08-14 12:10:21.000000000 +0200
 752 @@ -30,6 +30,10 @@
 753  #include "keymap.h"
 754  #include "url.h"
 755
 756 +#ifdef USE_COMPRESSED
 757 +#include "compress.h"
 758 +#endif
 759 +
 760  #ifdef USE_IMAP
 761  #include "imap.h"
 762  #endif
 763 @@ -454,6 +458,10 @@
 764      return (-1);
 765    }
 766
 767 +#ifdef USE_COMPRESSED
 768 +  if (magic == 0 && mutt_can_read_compressed (path))
 769 +    return M_COMPRESSED;
 770 +#endif
 771    return (magic);
 772  }
 773
 774 @@ -493,6 +501,13 @@
 775  {
 776    struct stat sb;
 777
 778 +#ifdef USE_COMPRESSED
 779 +  /* special case for appending to compressed folders -
 780 +   * even if we can not open them for reading */
 781 +  if (mutt_can_append_compressed (ctx->path))
 782 +    mutt_open_append_compressed (ctx);
 783 +#endif
 784 +
 785    ctx->append = 1;
 786
 787  #ifdef USE_IMAP
 788 @@ -653,7 +668,12 @@
 789    }
 790
 791    ctx->magic = mx_get_magic (path);
 792 -
 793 +
 794 +#ifdef USE_COMPRESSED
 795 +  if (ctx->magic == M_COMPRESSED)
 796 +    mutt_open_read_compressed (ctx);
 797 +#endif
 798 +
 799    if(ctx->magic == 0)
 800      mutt_error (_("%s is not a mailbox."), path);
 801
 802 @@ -759,6 +779,10 @@
 803      mutt_free_header (&ctx->hdrs[i]);
 804    FREE (&ctx->hdrs);
 805    FREE (&ctx->v2r);
 806 +#ifdef USE_COMPRESSED
 807 +  if (ctx->compressinfo)
 808 +    mutt_fast_close_compressed (ctx);
 809 +#endif
 810    FREE (&ctx->path);
 811    FREE (&ctx->pattern);
 812    if (ctx->limit_pattern)
 813 @@ -816,6 +840,12 @@
 814    if (tmp && tmp->new == 0)
 815      mutt_update_mailbox (tmp);
 816  #endif
 817 +
 818 +#ifdef USE_COMPRESSED
 819 +  if (rc == 0 && ctx->compressinfo)
 820 +    return mutt_sync_compressed (ctx);
 821 +#endif
 822 +
 823    return rc;
 824  }
 825
 826 @@ -1021,6 +1051,11 @@
 827        !mutt_is_spool(ctx->path) && !option (OPTSAVEEMPTY))
 828      mx_unlink_empty (ctx->path);
 829
 830 +#ifdef USE_COMPRESSED
 831 +  if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
 832 +    return (-1);
 833 +#endif
 834 +
 835    mx_fastclose_mailbox (ctx);
 836
 837    return 0;
 838 @@ -1330,6 +1365,11 @@
 839  {
 840    int rc;
 841
 842 +#ifdef USE_COMPRESSED
 843 +  if (ctx->compressinfo)
 844 +    return mutt_check_mailbox_compressed (ctx);
 845 +#endif
 846 +
 847    if (ctx)
 848    {
 849      if (ctx->locked) lock = 0;
 850 diff -urN mutt-1.5.10/mx.h mutt-1.5.10-ro/mx.h
 851 --- mutt-1.5.10/mx.h    2003-08-05 15:58:16.000000000 +0200
 852 +++ mutt-1.5.10-ro/mx.h 2005-08-14 12:10:21.000000000 +0200
 853 @@ -40,6 +40,9 @@
 854  #ifdef USE_POP
 855    , M_POP
 856  #endif
 857 +#ifdef USE_COMPRESSED
 858 +  , M_COMPRESSED
 859 +#endif
 860  };
 861
 862  WHERE short DefaultMagic INITVAL (M_MBOX);
 863 diff -urN mutt-1.5.10/PATCHES mutt-1.5.10-ro/PATCHES
 864 --- mutt-1.5.10/PATCHES 2005-08-11 23:27:30.000000000 +0200
 865 +++ mutt-1.5.10-ro/PATCHES      2005-08-14 12:10:35.000000000 +0200
 866 @@ -0,0 +1 @@
 867 +patch-1.5.10.rr.compressed.1
 868 diff -urN mutt-1.5.10/po/de.po mutt-1.5.10-ro/po/de.po
 869 --- mutt-1.5.10/po/de.po        2005-08-11 23:50:35.000000000 +0200
 870 +++ mutt-1.5.10-ro/po/de.po     2005-08-14 12:12:20.000000000 +0200
 871 @@ -1281,6 +1281,48 @@
 872  msgid "Failed to figure out sender"
 873  msgstr "Kann Datei nicht öffnen, um Nachrichtenkopf zu untersuchen."
 874
 875 +#: compress.c:203 mbox.c:661
 876 +msgid "Mailbox was corrupted!"
 877 +msgstr "Mailbox wurde zerstört!"
 878 +
 879 +#: compress.c:228 compress.c:253
 880 +#, c-format
 881 +msgid "Decompressing %s...\n"
 882 +msgstr "Entpacke %s...\n"
 883 +
 884 +#: compress.c:246 compress.c:367 compress.c:443 mbox.c:706
 885 +msgid "Unable to lock mailbox!"
 886 +msgstr "Kann Mailbox nicht für exklusiven Zugriff sperren!"
 887 +
 888 +#: compress.c:264
 889 +#, c-format
 890 +msgid "Error executing: %s : unable to open the mailbox!\n"
 891 +msgstr "Fehler beim Ausführen von %s : Kann die Mailbox nicht öffnen!\n"
 892 +
 893 +#: compress.c:350 compress.c:377 compress.c:423 compress.c:454
 894 +#, c-format
 895 +msgid "Compressing %s...\n"
 896 +msgstr "Komprimiere %s...\n"
 897 +
 898 +#: compress.c:381
 899 +#, c-format
 900 +msgid ""
 901 +"%s: Error compressing mailbox! Original mailbox deleted, uncompressed one "
 902 +"kept!\n"
 903 +msgstr ""
 904 +"%s: Fehler beim Komprimieren der Mailbox! Ursprüngliche Mailbox gelöscht, "
 905 +"entpackte gespeichert!\n"
 906 +
 907 +#: compress.c:425 compress.c:456
 908 +#, c-format
 909 +msgid "Compressed-appending to %s...\n"
 910 +msgstr "Hänge komprimiert an %s... an\n"
 911 +
 912 +#: compress.c:461
 913 +#, c-format
 914 +msgid " %s: Error compressing mailbox!  Uncompressed one kept!\n"
 915 +msgstr " %s: Fehler beim packen der Mailbox! Entpackte Mailbox gespeichert!\n"
 916 +
 917  #: crypt.c:69
 918  #, c-format
 919  msgid " (current time: %c)"
 920 @@ -1901,6 +1943,10 @@
 921  msgid "Help for %s"
 922  msgstr "Hilfe für %s"
 923
 924 +#: hook.c:96
 925 +msgid "bad formatted command string"
 926 +msgstr "Hook enthält nicht die Muster %f und %t"
 927 +
 928  #: hook.c:246
 929  #, c-format
 930  msgid "unhook: Can't do unhook * from within a hook."
 931 @@ -3383,18 +3429,10 @@
 932  msgid "Mailbox is corrupt!"
 933  msgstr "Mailbox fehlerhaft!"
 934
 935 -#: mbox.c:662
 936 -msgid "Mailbox was corrupted!"
 937 -msgstr "Mailbox wurde zerstört!"
 938 -
 939  #: mbox.c:701 mbox.c:952
 940  msgid "Fatal error!  Could not reopen mailbox!"
 941  msgstr "Fataler Fehler, konnte Mailbox nicht erneut öffnen!"
 942
 943 -#: mbox.c:710
 944 -msgid "Unable to lock mailbox!"
 945 -msgstr "Kann Mailbox nicht für exklusiven Zugriff sperren!"
 946 -
 947  #. this means ctx->changed or ctx->deleted was set, but no
 948  #. * messages were found to be changed or deleted.  This should
 949  #. * never happen, is we presume it is a bug in mutt.
 950 diff -urN mutt-1.5.10/po/POTFILES.in mutt-1.5.10-ro/po/POTFILES.in
 951 --- mutt-1.5.10/po/POTFILES.in  2005-08-03 11:17:47.000000000 +0200
 952 +++ mutt-1.5.10-ro/po/POTFILES.in       2005-08-14 12:13:18.000000000 +0200
 953 @@ -8,6 +8,7 @@
 954  color.c
 955  commands.c
 956  compose.c
 957 +compress.c
 958  crypt-gpgme.c
 959  crypt.c
 960  cryptglue.c
 961 diff -urN mutt-1.5.10/status.c mutt-1.5.10-ro/status.c
 962 --- mutt-1.5.10/status.c        2005-02-03 19:47:53.000000000 +0100
 963 +++ mutt-1.5.10-ro/status.c     2005-08-14 12:10:21.000000000 +0200
 964 @@ -97,6 +97,14 @@
 965
 966      case 'f':
 967        snprintf (fmt, sizeof(fmt), "%%%ss", prefix);
 968 +#ifdef USE_COMPRESSED
 969 +      if (Context && Context->compressinfo && Context->realpath)
 970 +      {
 971 +        strfcpy (tmp, Context->realpath, sizeof (tmp));
 972 +        mutt_pretty_mailbox (tmp);
 973 +      }
 974 +      else
 975 +#endif
 976        if (Context && Context->path)
 977        {
 978         strfcpy (tmp, Context->path, sizeof (tmp));