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