]> git.llucax.com Git - software/mutt-debian.git/blob - debian/patches/features/compressed-folders
Merge branch 'upstream' of ssh://antonio-guest@git.debian.org/git/pkg-mutt/mutt
[software/mutt-debian.git] / debian / patches / features / 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: 2008-05-20
11   - File: http://www.spinnaker.de/mutt/compressed/patch-1.5.18.rr.compressed.1.gz
12
13 * Changes made:
14   - 2008-05-20 myon: refreshed to remove hunks in auto* files
15   - 2009-09-15 myon: refreshed for mutt-1.5.19
16                      status.c:103: add sizeof (tmp) to mutt_pretty_mailbox
17   - 2009-09-15 scotton: removed doc/Muttrc for mutt-1.5.19 (only patch doc/Muttrc.head)
18
19 == END PATCH
20 Index: mutt/compress.c
21 ===================================================================
22 --- /dev/null   1970-01-01 00:00:00.000000000 +0000
23 +++ mutt/compress.c     2009-06-25 12:36:25.000000000 +0200
24 @@ -0,0 +1,499 @@
25 +/*
26 + * Copyright (C) 1997 Alain Penders <Alain@Finale-Dev.com>
27 + *
28 + *     This program is free software; you can redistribute it and/or modify
29 + *     it under the terms of the GNU General Public License as published by
30 + *     the Free Software Foundation; either version 2 of the License, or
31 + *     (at your option) any later version.
32 + *
33 + *     This program is distributed in the hope that it will be useful,
34 + *     but WITHOUT ANY WARRANTY; without even the implied warranty of
35 + *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
36 + *     GNU General Public License for more details.
37 + *
38 + *     You should have received a copy of the GNU General Public License
39 + *     along with this program; if not, write to the Free Software
40 + *     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
41 + */
42 +
43 +#if HAVE_CONFIG_H
44 +# include "config.h"
45 +#endif
46 +
47 +#include "mutt.h"
48 +
49 +#ifdef USE_COMPRESSED
50 +
51 +#include "mx.h"
52 +#include "mailbox.h"
53 +#include "mutt_curses.h"
54 +
55 +#include <errno.h>
56 +#include <string.h>
57 +#include <unistd.h>
58 +#include <sys/stat.h>
59 +
60 +typedef struct
61 +{
62 +  const char *close;   /* close-hook  command */
63 +  const char *open;    /* open-hook   command */
64 +  const char *append;  /* append-hook command */
65 +  off_t size;          /* size of real folder */
66 +} COMPRESS_INFO;
67 +
68 +
69 +/*
70 + * ctx - context to lock
71 + * excl - exclusive lock?
72 + * retry - should retry if unable to lock?
73 + */
74 +int mbox_lock_compressed (CONTEXT *ctx, FILE *fp, int excl, int retry)
75 +{
76 +  int r;
77 +
78 +  if ((r = mx_lock_file (ctx->realpath, fileno (fp), excl, 1, retry)) == 0)
79 +    ctx->locked = 1;
80 +  else if (retry && !excl)
81 +  {
82 +    ctx->readonly = 1;
83 +    return 0;
84 +  }
85 +
86 +  return (r);
87 +}
88 +
89 +void mbox_unlock_compressed (CONTEXT *ctx, FILE *fp)
90 +{
91 +  if (ctx->locked)
92 +  {
93 +    fflush (fp);
94 +
95 +    mx_unlock_file (ctx->realpath, fileno (fp), 1);
96 +    ctx->locked = 0;
97 +  }
98 +}
99 +
100 +static int is_new (const char *path)
101 +{
102 +  return (access (path, W_OK) != 0 && errno == ENOENT) ? 1 : 0;
103 +}
104 +
105 +static const char* find_compress_hook (int type, const char *path)
106 +{
107 +  const char* c = mutt_find_hook (type, path);
108 +  return (!c || !*c) ? NULL : c;
109 +}
110 +
111 +int mutt_can_read_compressed (const char *path)
112 +{
113 +  return find_compress_hook (M_OPENHOOK, path) ? 1 : 0;
114 +}
115 +
116 +/*
117 + * if the file is new, we really do not append, but create, and so use
118 + * close-hook, and not append-hook
119 + */
120 +static const char* get_append_command (const char *path, const CONTEXT* ctx)
121 +{
122 +  COMPRESS_INFO *ci = (COMPRESS_INFO *) ctx->compressinfo;
123 +  return (is_new (path)) ? ci->close : ci->append;
124 +}
125 +
126 +int mutt_can_append_compressed (const char *path)
127 +{
128 +  int magic;
129 +
130 +  if (is_new (path))
131 +  {
132 +    char *dir_path = safe_strdup(path);
133 +    char *aux = strrchr(dir_path, '/');
134 +    int dir_valid = 1;
135 +    if (aux)
136 +    {
137 +      *aux='\0';
138 +      if (access(dir_path, W_OK|X_OK))
139 +        dir_valid = 0;
140 +    }
141 +    safe_free((void**)&dir_path);
142 +    return dir_valid && (find_compress_hook (M_CLOSEHOOK, path) ? 1 : 0);
143 +  }
144 +
145 +  magic = mx_get_magic (path);
146 +
147 +  if (magic != 0 && magic != M_COMPRESSED)
148 +    return 0;
149 +
150 +  return (find_compress_hook (M_APPENDHOOK, path)
151 +         || (find_compress_hook (M_OPENHOOK, path)
152 +             && find_compress_hook (M_CLOSEHOOK, path))) ? 1 : 0;
153 +}
154 +
155 +/* open a compressed mailbox */
156 +static COMPRESS_INFO *set_compress_info (CONTEXT *ctx)
157 +{
158 +  COMPRESS_INFO *ci;
159 +
160 +  /* Now lets uncompress this thing */
161 +  ci = safe_malloc (sizeof (COMPRESS_INFO));
162 +  ctx->compressinfo = (void*) ci;
163 +  ci->append = find_compress_hook (M_APPENDHOOK, ctx->path);
164 +  ci->open = find_compress_hook (M_OPENHOOK, ctx->path);
165 +  ci->close = find_compress_hook (M_CLOSEHOOK, ctx->path);
166 +  return ci;
167 +}
168 +
169 +static void set_path (CONTEXT* ctx)
170 +{
171 +  char tmppath[_POSIX_PATH_MAX];
172 +
173 +  /* Setup the right paths */
174 +  ctx->realpath = ctx->path;
175 +
176 +  /* Uncompress to /tmp */
177 +  mutt_mktemp (tmppath);
178 +  ctx->path = safe_malloc (strlen (tmppath) + 1);
179 +  strcpy (ctx->path, tmppath);
180 +}
181 +
182 +static int get_size (const char* path)
183 +{
184 +  struct stat sb;
185 +  if (stat (path, &sb) != 0)
186 +    return 0;
187 +  return (sb.st_size);
188 +}
189 +
190 +static void store_size (CONTEXT* ctx)
191 +{
192 +  COMPRESS_INFO *ci = (COMPRESS_INFO *) ctx->compressinfo;
193 +  ci->size = get_size (ctx->realpath);
194 +}
195 +
196 +static const char *
197 +compresshook_format_str (char *dest, size_t destlen, size_t col, char op,
198 +                        const char *src, const char *fmt,
199 +                        const char *ifstring, const char *elsestring,
200 +                        unsigned long data, format_flag flags)
201 +{
202 +  char tmp[SHORT_STRING];
203 +
204 +  CONTEXT *ctx = (CONTEXT *) data;
205 +  switch (op)
206 +  {
207 +  case 'f':
208 +    snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
209 +    snprintf (dest, destlen, tmp, ctx->realpath);
210 +    break;
211 +  case 't':
212 +    snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
213 +    snprintf (dest, destlen, tmp, ctx->path);
214 +    break;
215 +  }
216 +  return (src);
217 +}
218 +
219 +/*
220 + * check that the command has both %f and %t
221 + * 0 means OK, -1 means error
222 + */
223 +int mutt_test_compress_command (const char* cmd)
224 +{
225 +  return (strstr (cmd, "%f") && strstr (cmd, "%t")) ? 0 : -1;
226 +}
227 +
228 +static char *get_compression_cmd (const char* cmd, const CONTEXT* ctx)
229 +{
230 +  char expanded[_POSIX_PATH_MAX];
231 +  mutt_FormatString (expanded, sizeof (expanded), 0, cmd,
232 +                    compresshook_format_str, (unsigned long) ctx, 0);
233 +  return safe_strdup (expanded);
234 +}
235 +
236 +int mutt_check_mailbox_compressed (CONTEXT* ctx)
237 +{
238 +  COMPRESS_INFO *ci = (COMPRESS_INFO *) ctx->compressinfo;
239 +  if (ci->size != get_size (ctx->realpath))
240 +  {
241 +    FREE (&ctx->compressinfo);
242 +    FREE (&ctx->realpath);
243 +    mutt_error _("Mailbox was corrupted!");
244 +    return (-1);
245 +  }
246 +  return (0);
247 +}
248 +
249 +int mutt_open_read_compressed (CONTEXT *ctx)
250 +{
251 +  char *cmd;
252 +  FILE *fp;
253 +  int rc;
254 +
255 +  COMPRESS_INFO *ci = set_compress_info (ctx);
256 +  if (!ci->open) {
257 +    ctx->magic = 0;
258 +    FREE (&ctx->compressinfo);
259 +    return (-1);
260 +  }
261 +  if (!ci->close || access (ctx->path, W_OK) != 0)
262 +    ctx->readonly = 1;
263 +
264 +  set_path (ctx);
265 +  store_size (ctx);
266 +
267 +  if (!ctx->quiet)
268 +    mutt_message (_("Decompressing %s..."), ctx->realpath);
269 +
270 +  cmd = get_compression_cmd (ci->open, ctx);
271 +  if (cmd == NULL)
272 +    return (-1);
273 +  dprint (2, (debugfile, "DecompressCmd: '%s'\n", cmd));
274 +
275 +  if ((fp = fopen (ctx->realpath, "r")) == NULL)
276 +  {
277 +    mutt_perror (ctx->realpath);
278 +    FREE (&cmd);
279 +    return (-1);
280 +  }
281 +  mutt_block_signals ();
282 +  if (mbox_lock_compressed (ctx, fp, 0, 1) == -1)
283 +  {
284 +    fclose (fp);
285 +    mutt_unblock_signals ();
286 +    mutt_error _("Unable to lock mailbox!");
287 +    FREE (&cmd);
288 +    return (-1);
289 +  }
290 +
291 +  endwin ();
292 +  fflush (stdout);
293 +  fprintf (stderr, _("Decompressing %s...\n"),ctx->realpath);
294 +  rc = mutt_system (cmd);
295 +  mbox_unlock_compressed (ctx, fp);
296 +  mutt_unblock_signals ();
297 +  fclose (fp);
298 +
299 +  if (rc)
300 +  {
301 +    mutt_any_key_to_continue (NULL);
302 +    ctx->magic = 0;
303 +    FREE (&ctx->compressinfo);
304 +    mutt_error (_("Error executing: %s : unable to open the mailbox!\n"), cmd);
305 +  }
306 +  FREE (&cmd);
307 +  if (rc)
308 +    return (-1);
309 +
310 +  if (mutt_check_mailbox_compressed (ctx))
311 +    return (-1);
312 +
313 +  ctx->magic = mx_get_magic (ctx->path);
314 +
315 +  return (0);
316 +}
317 +
318 +void restore_path (CONTEXT* ctx)
319 +{
320 +  FREE (&ctx->path);
321 +  ctx->path = ctx->realpath;
322 +}
323 +
324 +/* remove the temporary mailbox */
325 +void remove_file (CONTEXT* ctx)
326 +{
327 +  if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
328 +    remove (ctx->path);
329 +}
330 +
331 +int mutt_open_append_compressed (CONTEXT *ctx)
332 +{
333 +  FILE *fh;
334 +  COMPRESS_INFO *ci = set_compress_info (ctx);
335 +
336 +  if (!get_append_command (ctx->path, ctx))
337 +  {
338 +    if (ci->open && ci->close)
339 +      return (mutt_open_read_compressed (ctx));
340 +
341 +    ctx->magic = 0;
342 +    FREE (&ctx->compressinfo);
343 +    return (-1);
344 +  }
345 +
346 +  set_path (ctx);
347 +
348 +  ctx->magic = DefaultMagic;
349 +
350 +  if (!is_new (ctx->realpath))
351 +    if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
352 +      if ((fh = fopen (ctx->path, "w")))
353 +       fclose (fh);
354 +  /* No error checking - the parent function will catch it */
355 +
356 +  return (0);
357 +}
358 +
359 +/* close a compressed mailbox */
360 +void mutt_fast_close_compressed (CONTEXT *ctx)
361 +{
362 +  dprint (2, (debugfile, "mutt_fast_close_compressed called on '%s'\n",
363 +             ctx->path));
364 +
365 +  if (ctx->compressinfo)
366 +  {
367 +    if (ctx->fp)
368 +      fclose (ctx->fp);
369 +    ctx->fp = NULL;
370 +    /* if the folder was removed, remove the gzipped folder too */
371 +    if ((ctx->magic > 0)
372 +       && (access (ctx->path, F_OK) != 0)
373 +       && ! option (OPTSAVEEMPTY))
374 +      remove (ctx->realpath);
375 +    else
376 +      remove_file (ctx);
377 +
378 +    restore_path (ctx);
379 +    FREE (&ctx->compressinfo);
380 +  }
381 +}
382 +
383 +/* return 0 on success, -1 on failure */
384 +int mutt_sync_compressed (CONTEXT* ctx)
385 +{
386 +  char *cmd;
387 +  int rc = 0;
388 +  FILE *fp;
389 +  COMPRESS_INFO *ci = (COMPRESS_INFO *) ctx->compressinfo;
390 +
391 +  if (!ctx->quiet)
392 +    mutt_message (_("Compressing %s..."), ctx->realpath);
393 +
394 +  cmd = get_compression_cmd (ci->close, ctx);
395 +  if (cmd == NULL)
396 +    return (-1);
397 +
398 +  if ((fp = fopen (ctx->realpath, "a")) == NULL)
399 +  {
400 +    mutt_perror (ctx->realpath);
401 +    FREE (&cmd);
402 +    return (-1);
403 +  }
404 +  mutt_block_signals ();
405 +  if (mbox_lock_compressed (ctx, fp, 1, 1) == -1)
406 +  {
407 +    fclose (fp);
408 +    mutt_unblock_signals ();
409 +    mutt_error _("Unable to lock mailbox!");
410 +    store_size (ctx);
411 +    FREE (&cmd);
412 +    return (-1);
413 +  }
414 +
415 +  dprint (2, (debugfile, "CompressCommand: '%s'\n", cmd));
416 +
417 +  endwin ();
418 +  fflush (stdout);
419 +  fprintf (stderr, _("Compressing %s...\n"), ctx->realpath);
420 +  if (mutt_system (cmd))
421 +  {
422 +    mutt_any_key_to_continue (NULL);
423 +    mutt_error (_("%s: Error compressing mailbox! Original mailbox deleted, uncompressed one kept!\n"), ctx->path);
424 +    rc = -1;
425 +  }
426 +
427 +  mbox_unlock_compressed (ctx, fp);
428 +  mutt_unblock_signals ();
429 +  fclose (fp);
430 +
431 +  FREE (&cmd);
432 +
433 +  store_size (ctx);
434 +
435 +  return (rc);
436 +}
437 +
438 +int mutt_slow_close_compressed (CONTEXT *ctx)
439 +{
440 +  FILE *fp;
441 +  const char *append;
442 +  char *cmd;
443 +  COMPRESS_INFO *ci = (COMPRESS_INFO *) ctx->compressinfo;
444 +
445 +  dprint (2, (debugfile, "mutt_slow_close_compressed called on '%s'\n",
446 +             ctx->path));
447 +
448 +  if (! (ctx->append
449 +        && ((append = get_append_command (ctx->realpath, ctx))
450 +            || (append = ci->close))))
451 +  {
452 +    /* if we can not or should not append, we only have to remove the */
453 +    /* compressed info, because sync was already called               */
454 +    mutt_fast_close_compressed (ctx);
455 +    return (0);
456 +  }
457 +
458 +  if (ctx->fp)
459 +    fclose (ctx->fp);
460 +  ctx->fp = NULL;
461 +
462 +  if (!ctx->quiet)
463 +  {
464 +    if (append == ci->close)
465 +      mutt_message (_("Compressing %s..."), ctx->realpath);
466 +    else
467 +      mutt_message (_("Compressed-appending to %s..."), ctx->realpath);
468 +  }
469 +
470 +  cmd = get_compression_cmd (append, ctx);
471 +  if (cmd == NULL)
472 +    return (-1);
473 +
474 +  if ((fp = fopen (ctx->realpath, "a")) == NULL)
475 +  {
476 +    mutt_perror (ctx->realpath);
477 +    FREE (&cmd);
478 +    return (-1);
479 +  }
480 +  mutt_block_signals ();
481 +  if (mbox_lock_compressed (ctx, fp, 1, 1) == -1)
482 +  {
483 +    fclose (fp);
484 +    mutt_unblock_signals ();
485 +    mutt_error _("Unable to lock mailbox!");
486 +    FREE (&cmd);
487 +    return (-1);
488 +  }
489 +
490 +  dprint (2, (debugfile, "CompressCmd: '%s'\n", cmd));
491 +
492 +  endwin ();
493 +  fflush (stdout);
494 +
495 +  if (append == ci->close)
496 +    fprintf (stderr, _("Compressing %s...\n"), ctx->realpath);
497 +  else
498 +    fprintf (stderr, _("Compressed-appending to %s...\n"), ctx->realpath);
499 +
500 +  if (mutt_system (cmd))
501 +  {
502 +    mutt_any_key_to_continue (NULL);
503 +    mutt_error (_(" %s: Error compressing mailbox!  Uncompressed one kept!\n"),
504 +               ctx->path);
505 +    FREE (&cmd);
506 +    mbox_unlock_compressed (ctx, fp);
507 +    mutt_unblock_signals ();
508 +    fclose (fp);
509 +    return (-1);
510 +  }
511 +
512 +  mbox_unlock_compressed (ctx, fp);
513 +  mutt_unblock_signals ();
514 +  fclose (fp);
515 +  remove_file (ctx);
516 +  restore_path (ctx);
517 +  FREE (&cmd);
518 +  FREE (&ctx->compressinfo);
519 +
520 +  return (0);
521 +}
522 +
523 +#endif /* USE_COMPRESSED */
524 Index: mutt/compress.h
525 ===================================================================
526 --- /dev/null   1970-01-01 00:00:00.000000000 +0000
527 +++ mutt/compress.h     2009-06-25 12:36:26.000000000 +0200
528 @@ -0,0 +1,27 @@
529 +/*
530 + * Copyright (C) 1997 Alain Penders <Alain@Finale-Dev.com>
531 + *
532 + *     This program is free software; you can redistribute it and/or modify
533 + *     it under the terms of the GNU General Public License as published by
534 + *     the Free Software Foundation; either version 2 of the License, or
535 + *     (at your option) any later version.
536 + *
537 + *     This program is distributed in the hope that it will be useful,
538 + *     but WITHOUT ANY WARRANTY; without even the implied warranty of
539 + *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
540 + *     GNU General Public License for more details.
541 + *
542 + *     You should have received a copy of the GNU General Public License
543 + *     along with this program; if not, write to the Free Software
544 + *     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
545 + */
546 +
547 +int mutt_can_read_compressed (const char *);
548 +int mutt_can_append_compressed (const char *);
549 +int mutt_open_read_compressed (CONTEXT *);
550 +int mutt_open_append_compressed (CONTEXT *);
551 +int mutt_slow_close_compressed (CONTEXT *);
552 +int mutt_sync_compressed (CONTEXT *);
553 +int mutt_test_compress_command (const char *);
554 +int mutt_check_mailbox_compressed (CONTEXT *);
555 +void mutt_fast_close_compressed (CONTEXT *);
556 Index: mutt/configure.ac
557 ===================================================================
558 --- mutt.orig/configure.ac      2009-06-25 12:35:38.000000000 +0200
559 +++ mutt/configure.ac   2009-06-25 12:36:26.000000000 +0200
560 @@ -805,6 +805,11 @@
561                  AC_DEFINE(LOCALES_HACK,1,[ Define if the result of isprint() is unreliable. ])
562          fi])
563  
564 +AC_ARG_ENABLE(compressed, AC_HELP_STRING([--enable-compressed], [Enable compressed folders support]),
565 +       [if test x$enableval = xyes; then
566 +                AC_DEFINE(USE_COMPRESSED,1, [ Define to support compressed folders. ])
567 +        fi])
568 +
569  AC_ARG_WITH(exec-shell, AC_HELP_STRING([--with-exec-shell=SHELL], [Specify alternate shell (ONLY if /bin/sh is broken)]),
570          [if test $withval != yes; then
571                  AC_DEFINE_UNQUOTED(EXECSHELL, "$withval",
572 Index: mutt/curs_main.c
573 ===================================================================
574 --- mutt.orig/curs_main.c       2009-06-25 12:36:14.000000000 +0200
575 +++ mutt/curs_main.c    2009-06-25 12:36:26.000000000 +0200
576 @@ -1135,6 +1135,11 @@
577          {
578           int check;
579  
580 +#ifdef USE_COMPRESSED
581 +         if (Context->compressinfo && Context->realpath)
582 +           mutt_str_replace (&LastFolder, Context->realpath);
583 +         else
584 +#endif
585           mutt_str_replace (&LastFolder, Context->path);
586           oldcount = Context ? Context->msgcount : 0;
587  
588 Index: mutt/doc/manual.xml.head
589 ===================================================================
590 --- mutt.orig/doc/manual.xml.head       2009-06-25 12:35:42.000000000 +0200
591 +++ mutt/doc/manual.xml.head    2009-06-25 12:36:26.000000000 +0200
592 @@ -5678,6 +5678,205 @@
593  
594  </chapter>
595  
596 +<sect1 id="compressedfolders">
597 +<title>Compressed folders Support (OPTIONAL)</title>
598 +
599 +<para>
600 +If Mutt was compiled with compressed folders support (by running the
601 +<emphasis>configure</emphasis> script with the
602 +<emphasis>--enable-compressed</emphasis> flag), Mutt can open folders
603 +stored in an arbitrary format, provided that the user has a script to
604 +convert from/to this format to one of the accepted.
605 +
606 +The most common use is to open compressed archived folders e.g. with
607 +gzip.
608 +
609 +In addition, the user can provide a script that gets a folder in an
610 +accepted format and appends its context to the folder in the
611 +user-defined format, which may be faster than converting the entire
612 +folder to the accepted format, appending to it and converting back to
613 +the user-defined format.
614 +
615 +There are three hooks defined (<link
616 +linkend="open-hook">open-hook</link>, <link
617 +linkend="close-hook">close-hook</link> and <link
618 +linkend="append-hook">append-hook</link>) which define commands to
619 +uncompress and compress a folder and to append messages to an existing
620 +compressed folder respectively.
621 +
622 +For example:
623 +
624 +<screen>
625 +open-hook \\.gz$ "gzip -cd %f &gt; %t"
626 +close-hook \\.gz$ "gzip -c %t &gt; %f"
627 +append-hook \\.gz$ "gzip -c %t &gt;&gt; %f"
628 +</screen>
629 +
630 +You do not have to specify all of the commands. If you omit <link
631 +linkend="append-hook">append-hook</link>, the folder will be open and
632 +closed again each time you will add to it. If you omit <link
633 +linkend="close-hook">close-hook</link> (or give empty command) , the
634 +folder will be open in the mode. If you specify <link
635 +linkend="append-hook">append-hook</link> though you'll be able to
636 +append to the folder.
637 +
638 +Note that Mutt will only try to use hooks if the file is not in one of
639 +the accepted formats. In particular, if the file is empty, mutt
640 +supposes it is not compressed. This is important because it allows the
641 +use of programs that do not have well defined extensions. Just use
642 +&quot;.&quot; as a regexp. But this may be surprising if your
643 +compressing script produces empty files. In this situation, unset
644 +<link linkend="save-empty">&dollar;save&lowbar;empty</link>, so that
645 +the compressed file will be removed if you delete all of the messages.
646 +</para>
647 +
648 +<sect2 id="open-hook">
649 +<title>Open a compressed mailbox for reading</title>
650 +
651 +<para>
652 +Usage: <literal>open-hook</literal> <emphasis>regexp</emphasis> &quot;<emphasis>command</emphasis>&quot;
653 +
654 +The <emphasis>command</emphasis> is the command that can be used for
655 +opening the folders whose names match <emphasis>regexp</emphasis>.
656 +
657 +The <emphasis>command</emphasis> string is the printf-like format
658 +string, and it should accept two parameters: &percnt;f, which is
659 +replaced with the (compressed) folder name, and &percnt;t which is
660 +replaced with the name of the temporary folder to which to write.
661 +
662 +&percnt;f and &percnt;t can be repeated any number of times in the
663 +command string, and all of the entries are replaced with the
664 +appropriate folder name. In addition, &percnt;&percnt; is replaced by
665 +&percnt;, as in printf, and any other &percnt;anything is left as is.
666 +
667 +The <emphasis>command</emphasis> should <emphasis
668 +role="bold">not</emphasis> remove the original compressed file.  The
669 +<emphasis>command</emphasis> should return non-zero exit status if it
670 +fails, so mutt knows something's wrong.
671 +
672 +Example:
673 +
674 +<screen>
675 +open-hook \\.gz$ "gzip -cd %f &gt; %t"
676 +</screen>
677 +
678 +If the <emphasis>command</emphasis> is empty, this operation is
679 +disabled for this file type.
680 +</para>
681 +</sect2>
682 +
683 +<sect2 id="close-hook">
684 +<title>Write a compressed mailbox</title>
685 +
686 +<para>
687 +Usage: <literal>close-hook</literal> <emphasis>regexp</emphasis> &quot;<emphasis>command</emphasis>&quot;
688 +
689 +This is used to close the folder that was open with the <link
690 +linkend="open-hook">open-hook</link> command after some changes were
691 +made to it.
692 +
693 +The <emphasis>command</emphasis> string is the command that can be
694 +used for closing the folders whose names match
695 +<emphasis>regexp</emphasis>. It has the same format as in the <link
696 +linkend="open-hook">open-hook</link> command. Temporary folder in this
697 +case is the folder previously produced by the <link
698 +linkend="open-hook">open-hook</link> command.
699 +
700 +The <emphasis>command</emphasis> should <emphasis
701 +role="bold">not</emphasis> remove the decompressed file. The
702 +<emphasis>command</emphasis> should return non-zero exit status if it
703 +fails, so mutt knows something's wrong.
704 +
705 +Example:
706 +
707 +<screen>
708 +close-hook \\.gz$ "gzip -c %t &gt; %f"
709 +</screen>
710 +
711 +If the <emphasis>command</emphasis> is empty, this operation is
712 +disabled for this file type, and the file can only be open in the
713 +read-only mode.
714 +
715 +<link linkend="close-hook">close-hook</link> is not called when you
716 +exit from the folder if the folder was not changed.
717 +</para>
718 +</sect2>
719 +
720 +<sect2 id="append-hook">
721 +<title>Append a message to a compressed mailbox</title>
722 +
723 +<para>
724 +Usage: <literal>append-hook</literal> <emphasis>regexp</emphasis> &quot;<emphasis>command</emphasis>&quot;
725 +
726 +This command is used for saving to an existing compressed folder.  The
727 +<emphasis>command</emphasis> is the command that can be used for
728 +appending to the folders whose names match
729 +<emphasis>regexp</emphasis>. It has the same format as in the <link
730 +linkend="open-hook">open-hook</link> command.  The temporary folder in
731 +this case contains the messages that are being appended.
732 +
733 +The <emphasis>command</emphasis> should <emphasis
734 +role="bold">not</emphasis> remove the decompressed file. The
735 +<emphasis>command</emphasis> should return non-zero exit status if it
736 +fails, so mutt knows something's wrong.
737 +
738 +Example:
739 +
740 +<screen>
741 +append-hook \\.gz$ "gzip -c %t &gt;&gt; %f"
742 +</screen>
743 +
744 +When <link linkend="append-hook">append-hook</link> is used, the folder
745 +is not opened, which saves time, but this means that we can not find
746 +out what the folder type is. Thus the default (<link
747 +linkend="mbox-type">&dollar;mbox&lowbar;type</link>) type is always
748 +supposed (i.e.  this is the format used for the temporary folder).
749 +
750 +If the file does not exist when you save to it, <link
751 +linkend="close-hook">close-hook</link> is called, and not <link
752 +linkend="append-hook">append-hook</link>. <link
753 +linkend="append-hook">append-hook</link> is only for appending to
754 +existing folders.
755 +
756 +If the <emphasis>command</emphasis> is empty, this operation is
757 +disabled for this file type. In this case, the folder will be open and
758 +closed again (using <link linkend="open-hook">open-hook</link> and
759 +<link linkend="close-hook">close-hook</link>respectively) each time you
760 +will add to it.
761 +</para>
762 +</sect2>
763 +
764 +<sect2>
765 +<title>Encrypted folders</title>
766 +
767 +<para>
768 +The compressed folders support can also be used to handle encrypted
769 +folders. If you want to encrypt a folder with PGP, you may want to use
770 +the following hooks:
771 +
772 +<screen>
773 +open-hook  \\.pgp$ "pgp -f &lt; %f &gt; %t"
774 +close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId &lt; %t &gt; %f"
775 +</screen>
776 +
777 +Please note, that PGP does not support appending to an encrypted
778 +folder, so there is no append-hook defined.
779 +
780 +If you are using GnuPG instead of PGP, you may use the following hooks
781 +instead:
782 +
783 +<screen>
784 +open-hook  \\.gpg$ "gpg --decrypt &lt; %f &gt; %t"
785 +close-hook \\.gpg$ "gpg --encrypt --recipient YourGpgUserIdOrKeyId &lt; %t &gt; %f"
786 +</screen>
787 +
788 +<emphasis role="bold">Note:</emphasis> the folder is temporary stored
789 +decrypted in the /tmp directory, where it can be read by your system
790 +administrator. So think about the security aspects of this.
791 +</para>
792 +</sect2>
793 +</sect1>
794 +
795  <chapter id="mimesupport">
796  <title>Mutt's MIME Support</title>
797  
798 Index: mutt/doc/Muttrc.head
799 ===================================================================
800 --- mutt.orig/doc/Muttrc.head   2009-06-25 12:35:36.000000000 +0200
801 +++ mutt/doc/Muttrc.head        2009-06-25 12:36:26.000000000 +0200
802 @@ -29,6 +29,11 @@
803  macro index,pager y "<change-folder>?<toggle-mailboxes>" "show incoming mailboxes list"
804  bind browser y exit
805  
806 +# Use folders which match on \\.gz$ as gzipped folders:
807 +# open-hook \\.gz$ "gzip -cd %f > %t"
808 +# close-hook \\.gz$ "gzip -c %t > %f"
809 +# append-hook \\.gz$ "gzip -c %t >> %f"
810 +
811  # If Mutt is unable to determine your site's domain name correctly, you can
812  # set the default here.
813  #
814 Index: mutt/doc/muttrc.man.head
815 ===================================================================
816 --- mutt.orig/doc/muttrc.man.head       2009-06-25 12:35:36.000000000 +0200
817 +++ mutt/doc/muttrc.man.head    2009-06-25 12:36:26.000000000 +0200
818 @@ -345,6 +345,24 @@
819  to a certain recipient.  The meaning of "key ID" is to be taken
820  broadly: This can be a different e-mail address, a numerical key ID,
821  or even just an arbitrary search string.
822 +.PP
823 +.nf
824 +\fBopen-hook\fP \fIregexp\fP "\fIcommand\fP"
825 +\fBclose-hook\fP \fIregexp\fP "\fIcommand\fP"
826 +\fBappend-hook\fP \fIregexp\fP "\fIcommand\fP"
827 +.fi
828 +.IP
829 +These commands provide a way to handle compressed folders. The given
830 +\fBregexp\fP specifies which folders are taken as compressed (e.g.
831 +"\fI\\\\.gz$\fP"). The commands tell Mutt how to uncompress a folder
832 +(\fBopen-hook\fP), compress a folder (\fBclose-hook\fP) or append a
833 +compressed mail to a compressed folder (\fBappend-hook\fP). The
834 +\fIcommand\fP string is the
835 +.BR printf (3)
836 +like format string, and it should accept two parameters: \fB%f\fP,
837 +which is replaced with the (compressed) folder name, and \fB%t\fP
838 +which is replaced with the name of the temporary folder to which to
839 +write.
840  .TP
841  \fBpush\fP \fIstring\fP
842  This command adds the named \fIstring\fP to the keyboard buffer.
843 Index: mutt/hook.c
844 ===================================================================
845 --- mutt.orig/hook.c    2009-06-25 12:35:36.000000000 +0200
846 +++ mutt/hook.c 2009-06-25 12:36:26.000000000 +0200
847 @@ -24,6 +24,10 @@
848  #include "mailbox.h"
849  #include "mutt_crypt.h"
850  
851 +#ifdef USE_COMPRESSED
852 +#include "compress.h"
853 +#endif
854 +
855  #include <limits.h>
856  #include <string.h>
857  #include <stdlib.h>
858 @@ -92,6 +96,16 @@
859      memset (&pattern, 0, sizeof (pattern));
860      pattern.data = safe_strdup (path);
861    }
862 +#ifdef USE_COMPRESSED
863 +  else if (data & (M_APPENDHOOK | M_OPENHOOK | M_CLOSEHOOK))
864 +  {
865 +    if (mutt_test_compress_command (command.data))
866 +    {
867 +      strfcpy (err->data, _("badly formatted command string"), err->dsize);
868 +      return (-1);
869 +    }
870 +  }
871 +#endif
872    else if (DefaultHook && !(data & (M_CHARSETHOOK | M_ICONVHOOK | M_ACCOUNTHOOK))
873             && (!WithCrypto || !(data & M_CRYPTHOOK))
874        )
875 Index: mutt/init.h
876 ===================================================================
877 --- mutt.orig/init.h    2009-06-25 12:36:22.000000000 +0200
878 +++ mutt/init.h 2009-06-25 12:36:26.000000000 +0200
879 @@ -3504,6 +3504,11 @@
880    { "fcc-hook",                mutt_parse_hook,        M_FCCHOOK },
881    { "fcc-save-hook",   mutt_parse_hook,        M_FCCHOOK | M_SAVEHOOK },
882    { "folder-hook",     mutt_parse_hook,        M_FOLDERHOOK },
883 +#ifdef USE_COMPRESSED
884 +  { "open-hook",       mutt_parse_hook,        M_OPENHOOK },
885 +  { "close-hook",      mutt_parse_hook,        M_CLOSEHOOK },
886 +  { "append-hook",     mutt_parse_hook,        M_APPENDHOOK },
887 +#endif
888    { "group",           parse_group,            0 },
889    { "ungroup",         parse_ungroup,          0 },
890    { "hdr_order",       parse_list,             UL &HeaderOrderList },
891 Index: mutt/main.c
892 ===================================================================
893 --- mutt.orig/main.c    2009-06-25 12:35:36.000000000 +0200
894 +++ mutt/main.c 2009-06-25 12:36:26.000000000 +0200
895 @@ -402,6 +402,12 @@
896  #else
897         "-LOCALES_HACK  "
898  #endif
899 +
900 +#ifdef USE_COMPRESSED
901 +       "+COMPRESSED  "
902 +#else
903 +       "-COMPRESSED  "
904 +#endif
905               
906  #ifdef HAVE_WC_FUNCS
907         "+HAVE_WC_FUNCS  "
908 Index: mutt/Makefile.am
909 ===================================================================
910 --- mutt.orig/Makefile.am       2009-06-25 12:35:36.000000000 +0200
911 +++ mutt/Makefile.am    2009-06-25 12:36:26.000000000 +0200
912 @@ -18,7 +18,7 @@
913  bin_PROGRAMS = mutt @DOTLOCK_TARGET@ @PGPAUX_TARGET@
914  mutt_SOURCES = \
915         addrbook.c alias.c attach.c base64.c browser.c buffy.c color.c \
916 -       crypt.c cryptglue.c \
917 +       crypt.c cryptglue.c compress.c \
918         commands.c complete.c compose.c copy.c curs_lib.c curs_main.c date.c \
919         edit.c enter.c flags.c init.c filter.c from.c \
920         getdomain.c group.c \
921 @@ -57,7 +57,7 @@
922         bcache.h browser.h hcache.h mbyte.h mutt_idna.h remailer.h url.h
923  
924  EXTRA_DIST = COPYRIGHT GPL OPS OPS.PGP OPS.CRYPT OPS.SMIME TODO UPDATING \
925 -       configure account.h \
926 +       configure account.h compress.h \
927         attach.h buffy.h charset.h copy.h crypthash.h dotlock.h functions.h gen_defs \
928         globals.h hash.h history.h init.h keymap.h mutt_crypt.h \
929         mailbox.h mapping.h md5.h mime.h mutt.h mutt_curses.h mutt_menu.h \
930 Index: mutt/mbox.c
931 ===================================================================
932 --- mutt.orig/mbox.c    2009-06-25 12:35:36.000000000 +0200
933 +++ mutt/mbox.c 2009-06-25 12:36:26.000000000 +0200
934 @@ -29,6 +29,10 @@
935  #include "copy.h"
936  #include "mutt_curses.h"
937  
938 +#ifdef USE_COMPRESSED
939 +#include "compress.h"
940 +#endif
941 +
942  #include <sys/stat.h>
943  #include <dirent.h>
944  #include <string.h>
945 @@ -1048,6 +1052,12 @@
946  int mbox_close_mailbox (CONTEXT *ctx)
947  {
948    mx_unlock_file (ctx->path, fileno (ctx->fp), 1);
949 +
950 +#ifdef USE_COMPRESSED
951 +  if (ctx->compressinfo)
952 +    mutt_slow_close_compressed (ctx);
953 +#endif
954 +
955    mutt_unblock_signals ();
956    mx_fastclose_mailbox (ctx);
957    return 0;
958 Index: mutt/mutt.h
959 ===================================================================
960 --- mutt.orig/mutt.h    2009-06-25 12:36:14.000000000 +0200
961 +++ mutt/mutt.h 2009-06-25 12:36:26.000000000 +0200
962 @@ -146,6 +146,11 @@
963  #define M_ACCOUNTHOOK  (1<<9)
964  #define M_REPLYHOOK    (1<<10)
965  #define M_SEND2HOOK     (1<<11)
966 +#ifdef USE_COMPRESSED
967 +#define M_OPENHOOK     (1<<12)
968 +#define M_APPENDHOOK   (1<<13)
969 +#define M_CLOSEHOOK    (1<<14)
970 +#endif
971  
972  /* tree characters for linearize_tree and print_enriched_string */
973  #define M_TREE_LLCORNER                1
974 @@ -882,6 +887,11 @@
975    int flagged;                 /* how many flagged messages */
976    int msgnotreadyet;           /* which msg "new" in pager, -1 if none */
977  
978 +#ifdef USE_COMPRESSED
979 +  void *compressinfo;          /* compressed mbox module private data */
980 +  char *realpath;              /* path to compressed mailbox */
981 +#endif /* USE_COMPRESSED */
982 +
983    short magic;                 /* mailbox type */
984  
985    unsigned char rights[(RIGHTSMAX + 7)/8];     /* ACL bits */
986 Index: mutt/mx.c
987 ===================================================================
988 --- mutt.orig/mx.c      2009-06-25 12:36:14.000000000 +0200
989 +++ mutt/mx.c   2009-06-25 12:36:26.000000000 +0200
990 @@ -30,6 +30,10 @@
991  #include "keymap.h"
992  #include "url.h"
993  
994 +#ifdef USE_COMPRESSED
995 +#include "compress.h"
996 +#endif
997 +
998  #ifdef USE_IMAP
999  #include "imap.h"
1000  #endif
1001 @@ -415,6 +419,10 @@
1002      return (-1);
1003    }
1004  
1005 +#ifdef USE_COMPRESSED
1006 +  if (magic == 0 && mutt_can_read_compressed (path))
1007 +    return M_COMPRESSED;
1008 +#endif
1009    return (magic);
1010  }
1011  
1012 @@ -454,6 +462,13 @@
1013  {
1014    struct stat sb;
1015  
1016 +#ifdef USE_COMPRESSED
1017 +  /* special case for appending to compressed folders -
1018 +   * even if we can not open them for reading */
1019 +  if (mutt_can_append_compressed (ctx->path))
1020 +    mutt_open_append_compressed (ctx);
1021 +#endif
1022 +
1023    ctx->append = 1;
1024  
1025  #ifdef USE_IMAP
1026 @@ -617,7 +632,12 @@
1027    }
1028  
1029    ctx->magic = mx_get_magic (path);
1030 -  
1031 +
1032 +#ifdef USE_COMPRESSED
1033 +  if (ctx->magic == M_COMPRESSED)
1034 +    mutt_open_read_compressed (ctx);
1035 +#endif
1036 +
1037    if(ctx->magic == 0)
1038      mutt_error (_("%s is not a mailbox."), path);
1039  
1040 @@ -718,6 +738,10 @@
1041      mutt_free_header (&ctx->hdrs[i]);
1042    FREE (&ctx->hdrs);
1043    FREE (&ctx->v2r);
1044 +#ifdef USE_COMPRESSED
1045 +  if (ctx->compressinfo)
1046 +    mutt_fast_close_compressed (ctx);
1047 +#endif
1048    FREE (&ctx->path);
1049    FREE (&ctx->pattern);
1050    if (ctx->limit_pattern) 
1051 @@ -770,6 +794,12 @@
1052    
1053    if (tmp && tmp->new == 0)
1054      mutt_update_mailbox (tmp);
1055 +
1056 +#ifdef USE_COMPRESSED
1057 +  if (rc == 0 && ctx->compressinfo)
1058 +    return mutt_sync_compressed (ctx);
1059 +#endif
1060 +
1061    return rc;
1062  }
1063  
1064 @@ -1033,6 +1063,11 @@
1065        !mutt_is_spool(ctx->path) && !option (OPTSAVEEMPTY))
1066      mx_unlink_empty (ctx->path);
1067  
1068 +#ifdef USE_COMPRESSED
1069 +  if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
1070 +    return (-1);
1071 +#endif
1072 +
1073    mx_fastclose_mailbox (ctx);
1074  
1075    return 0;
1076 @@ -1355,6 +1390,11 @@
1077  {
1078    int rc;
1079  
1080 +#ifdef USE_COMPRESSED
1081 +  if (ctx->compressinfo)
1082 +    return mutt_check_mailbox_compressed (ctx);
1083 +#endif
1084 +
1085    if (ctx)
1086    {
1087      if (ctx->locked) lock = 0;
1088 Index: mutt/mx.h
1089 ===================================================================
1090 --- mutt.orig/mx.h      2009-06-25 12:35:36.000000000 +0200
1091 +++ mutt/mx.h   2009-06-25 12:36:26.000000000 +0200
1092 @@ -40,6 +40,9 @@
1093  #ifdef USE_POP
1094    , M_POP
1095  #endif
1096 +#ifdef USE_COMPRESSED
1097 +  , M_COMPRESSED
1098 +#endif
1099  };
1100  
1101  WHERE short DefaultMagic INITVAL (M_MBOX);
1102 Index: mutt/po/de.po
1103 ===================================================================
1104 --- mutt.orig/po/de.po  2009-06-25 12:35:36.000000000 +0200
1105 +++ mutt/po/de.po       2009-06-25 12:36:26.000000000 +0200
1106 @@ -2005,6 +2005,10 @@
1107  msgid "Bad history file format (line %d)"
1108  msgstr "Falsches Format der Datei früherer Eingaben (Zeile %d)"
1109  
1110 +#: hook.c:96
1111 +msgid "badly formatted command string"
1112 +msgstr "Hook enthält nicht die Muster %f und %t"
1113 +
1114  #: hook.c:251
1115  #, c-format
1116  msgid "unhook: Can't do unhook * from within a hook."
1117 @@ -2766,7 +2770,7 @@
1118  msgid "Mailbox is corrupt!"
1119  msgstr "Mailbox fehlerhaft!"
1120  
1121 -#: mbox.c:678
1122 +#: mbox.c:678 compress.c:203 mbox.c:661
1123  msgid "Mailbox was corrupted!"
1124  msgstr "Mailbox wurde zerstört!"
1125  
1126 @@ -2774,10 +2778,11 @@
1127  msgid "Fatal error!  Could not reopen mailbox!"
1128  msgstr "Fataler Fehler, konnte Mailbox nicht erneut öffnen!"
1129  
1130 -#: mbox.c:746
1131 +#: mbox.c:746 compress.c:264 compress.c:246 compress.c:367 compress.c:443 mbox.c:706
1132  msgid "Unable to lock mailbox!"
1133  msgstr "Kann Mailbox nicht für exklusiven Zugriff sperren!"
1134  
1135 +
1136  #. this means ctx->changed or ctx->deleted was set, but no
1137  #. * messages were found to be changed or deleted.  This should
1138  #. * never happen, is we presume it is a bug in mutt.
1139 @@ -5378,3 +5383,32 @@
1140  
1141  #~ msgid "Authentication method is unknown."
1142  #~ msgstr "Authentifizierungsmethode unbekannt."
1143 +
1144 +#: compress.c:228 compress.c:253
1145 +#, c-format
1146 +msgid "Decompressing %s...\n"
1147 +msgstr "Entpacke %s...\n"
1148 +
1149 +#: compress.c:350 compress.c:377 compress.c:423 compress.c:454
1150 +#, c-format
1151 +msgid "Compressing %s...\n"
1152 +msgstr "Komprimiere %s...\n"
1153 +
1154 +#: compress.c:381
1155 +#, c-format
1156 +msgid ""
1157 +"%s: Error compressing mailbox! Original mailbox deleted, uncompressed one "
1158 +"kept!\n"
1159 +msgstr ""
1160 +"%s: Fehler beim Komprimieren der Mailbox! Ursprüngliche Mailbox gelöscht, "
1161 +"entpackte gespeichert!\n"
1162 +
1163 +#: compress.c:425 compress.c:456
1164 +#, c-format
1165 +msgid "Compressed-appending to %s...\n"
1166 +msgstr "Hänge komprimiert an %s... an\n"
1167 +
1168 +#: compress.c:461
1169 +#, c-format
1170 +msgid " %s: Error compressing mailbox!  Uncompressed one kept!\n"
1171 +msgstr " %s: Fehler beim packen der Mailbox! Entpackte Mailbox gespeichert!\n"
1172 Index: mutt/po/POTFILES.in
1173 ===================================================================
1174 --- mutt.orig/po/POTFILES.in    2009-06-25 12:35:36.000000000 +0200
1175 +++ mutt/po/POTFILES.in 2009-06-25 12:36:26.000000000 +0200
1176 @@ -8,6 +8,7 @@
1177  color.c
1178  commands.c
1179  compose.c
1180 +compress.c
1181  crypt-gpgme.c
1182  crypt.c
1183  cryptglue.c
1184 Index: mutt/status.c
1185 ===================================================================
1186 --- mutt.orig/status.c  2009-06-25 12:35:44.000000000 +0200
1187 +++ mutt/status.c       2009-06-25 12:36:26.000000000 +0200
1188 @@ -96,6 +96,14 @@
1189  
1190      case 'f':
1191        snprintf (fmt, sizeof(fmt), "%%%ss", prefix);
1192 +#ifdef USE_COMPRESSED
1193 +      if (Context && Context->compressinfo && Context->realpath)
1194 +      {
1195 +        strfcpy (tmp, Context->realpath, sizeof (tmp));
1196 +        mutt_pretty_mailbox (tmp, sizeof (tmp));
1197 +      }
1198 +      else
1199 +#endif
1200        if (Context && Context->path)
1201        {
1202         strfcpy (tmp, Context->path, sizeof (tmp));