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