2 * Copyright notice from original mutt:
3 * Copyright (C) 1997 Alain Penders <Alain@Finale-Dev.com>
5 * This file is part of mutt-ng, see http://www.muttng.org/.
6 * It's licensed under the GNU General Public License,
7 * please see the file GPL in the top level source directory.
10 #include <lib-lib/lib-lib.h>
12 #include <lib-sys/mutt_signal.h>
13 #include <lib-sys/unix.h>
15 #include <lib-ui/lib-ui.h>
23 struct compress_info {
24 const char *close; /* close-hook command */
25 const char *open; /* open-hook command */
26 const char *append; /* append-hook command */
27 off_t size; /* size of real folder */
30 char echo_cmd[HUGE_STRING];
33 * ctx - context to lock
34 * excl - exclusive lock?
35 * retry - should retry if unable to lock?
37 static int mbox_lock_compressed (CONTEXT * ctx, FILE * fp, int excl, int retry)
41 if ((r = mx_lock_file (ctx->realpath, fileno (fp), excl, 1, retry)) == 0)
43 else if (retry && !excl) {
51 static void mbox_unlock_compressed (CONTEXT * ctx, FILE * fp)
56 mx_unlock_file (ctx->realpath, fileno (fp), 1);
61 static int is_new (const char *path)
63 return (access (path, W_OK) && errno == ENOENT);
66 static const char *find_compress_hook (int type, const char *path)
68 int len = strlen(path);
69 if (len > 3 && !strcmp(path + len - 3, ".gz")) {
71 case M_OPENHOOK: return "gzip -cd %f > %t";
72 case M_CLOSEHOOK: return "gzip -cd %t > %f";
73 case M_APPENDHOOK: return "gzip -cd %t >> %f";
77 if (len > 4 && !strcmp(path + len - 4, ".bz2")) {
79 case M_OPENHOOK: return "bzip2 -cd %f > %t";
80 case M_CLOSEHOOK: return "bzip2 -cd %t > %f";
81 case M_APPENDHOOK: return "bzip2 -cd %t >> %f";
88 int mutt_can_read_compressed (const char *path)
90 return find_compress_hook (M_OPENHOOK, path) ? 1 : 0;
93 /* if the file is new, we really do not append, but create, and so use
94 * close-hook, and not append-hook
96 static const char *get_append_command (const char *path, const CONTEXT * ctx)
98 return is_new(path) ? ctx->cinfo->close : ctx->cinfo->append;
101 int mutt_can_append_compressed (const char *path)
106 return (find_compress_hook (M_CLOSEHOOK, path) ? 1 : 0);
108 magic = mx_get_magic (path);
110 if (magic != 0 && magic != M_COMPRESSED)
113 return (find_compress_hook (M_APPENDHOOK, path)
114 || (find_compress_hook (M_OPENHOOK, path)
115 && find_compress_hook (M_CLOSEHOOK, path))) ? 1 : 0;
118 /* open a compressed mailbox */
119 static compress_info *set_compress_info (CONTEXT * ctx)
121 compress_info *ci = p_new(compress_info, 1);
123 /* Now lets uncompress this thing */
124 ci->append = find_compress_hook (M_APPENDHOOK, ctx->path);
125 ci->open = find_compress_hook (M_OPENHOOK, ctx->path);
126 ci->close = find_compress_hook (M_CLOSEHOOK, ctx->path);
128 return (ctx->cinfo = ci);
131 static int get_size (const char *path)
135 if (stat (path, &sb) != 0)
141 compresshook_format_str(char *dest, ssize_t destlen,
142 char op, const char *src, const char *fmt,
143 const char *ifstr __attribute__ ((unused)),
144 const char *elstr __attribute__ ((unused)),
146 format_flag flags __attribute__ ((unused)))
150 CONTEXT *ctx = data.ptr;
154 snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
155 snprintf (dest, destlen, tmp, ctx->realpath);
158 snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
159 snprintf (dest, destlen, tmp, ctx->path);
165 /* check that the command has both %f and %t
166 * 0 means OK, -1 means error
168 int mutt_test_compress_command (const char *cmd)
170 return (strstr (cmd, "%f") && strstr (cmd, "%t")) ? 0 : -1;
173 static char *get_compression_cmd(const char *cmd, const CONTEXT *ctx)
175 char buf[_POSIX_PATH_MAX];
176 m_strformat(buf, sizeof(buf), 0, cmd, compresshook_format_str, (void*)ctx, 0);
177 return m_strdup(buf);
180 int mutt_check_mailbox_compressed (CONTEXT * ctx)
182 if (ctx->cinfo->size != get_size (ctx->realpath)) {
183 p_delete(&ctx->cinfo);
184 p_delete(&ctx->realpath);
185 mutt_error _("Mailbox was corrupted!");
192 int mutt_open_read_compressed(CONTEXT * ctx)
197 char tmppath[_POSIX_PATH_MAX];
200 compress_info *ci = set_compress_info (ctx);
204 p_delete(&ctx->cinfo);
207 if (!ci->close || access (ctx->path, W_OK) != 0)
210 /* Setup the right paths */
211 ctx->realpath = ctx->path;
213 /* Uncompress to /tmp */
214 tmpfd = m_tempfd(tmppath, sizeof(tmppath), NONULL(mod_core.tmpdir), NULL);
215 /* If we cannot open tempfile, that means the file already exists (!?)
216 * or we are following a symlink, which is bad and insecure.
223 ctx->path = p_dupstr(tmppath, m_strlen(tmppath));
224 ctx->cinfo->size = get_size(ctx->realpath);
227 mutt_message (_("Decompressing %s..."), ctx->realpath);
229 cmd = get_compression_cmd (ci->open, ctx);
233 if ((fp = fopen (ctx->realpath, "r")) == NULL) {
234 mutt_perror (ctx->realpath);
238 mutt_block_signals ();
239 if (mbox_lock_compressed (ctx, fp, 0, 1) == -1) {
241 mutt_unblock_signals ();
242 mutt_error _("Unable to lock mailbox!");
250 sprintf (echo_cmd, _("echo Decompressing %s..."), ctx->realpath);
251 mutt_system (echo_cmd);
252 rc = mutt_system (cmd);
253 mbox_unlock_compressed (ctx, fp);
254 mutt_unblock_signals ();
258 mutt_any_key_to_continue (NULL);
260 p_delete(&ctx->cinfo);
261 mutt_error(_("Error executing: %s : unable to open the mailbox!\n"), cmd);
267 if (mutt_check_mailbox_compressed (ctx))
270 ctx->magic = mx_get_magic (ctx->path);
275 static void restore_path (CONTEXT * ctx)
277 p_delete(&ctx->path);
278 ctx->path = ctx->realpath;
281 /* remove the temporary mailbox */
282 static void remove_file (CONTEXT * ctx)
284 if (ctx->magic == M_MBOX)
288 int mutt_open_append_compressed (CONTEXT * ctx)
291 compress_info *ci = set_compress_info (ctx);
292 char tmppath[_POSIX_PATH_MAX];
294 if (!get_append_command (ctx->path, ctx)) {
295 if (ci->open && ci->close)
296 return mutt_open_read_compressed(ctx);
299 p_delete(&ctx->cinfo);
303 /* Setup the right paths */
304 ctx->realpath = ctx->path;
306 /* Uncompress to /tmp */
307 fh = m_tempfile(tmppath, sizeof(tmppath), NONULL(mod_core.tmpdir), NULL);
310 ctx->path = p_dupstr(tmppath, m_strlen(tmppath));
312 ctx->magic = DefaultMagic;
314 if (is_new (ctx->realpath) || ctx->magic != M_MBOX)
317 /* No error checking - the parent function will catch it */
321 /* close a compressed mailbox */
322 void mutt_fast_close_compressed (CONTEXT * ctx)
327 /* if the folder was removed, remove the gzipped folder too */
330 p_delete(&ctx->cinfo);
334 /* return 0 on success, -1 on failure */
335 int mutt_sync_compressed (CONTEXT * ctx)
342 mutt_message (_("Compressing %s..."), ctx->realpath);
344 cmd = get_compression_cmd (ctx->cinfo->close, ctx);
348 if ((fp = fopen (ctx->realpath, "a")) == NULL) {
349 mutt_perror (ctx->realpath);
353 mutt_block_signals ();
354 if (mbox_lock_compressed (ctx, fp, 1, 1) == -1) {
356 mutt_unblock_signals ();
357 mutt_error _("Unable to lock mailbox!");
359 ctx->cinfo->size = get_size(ctx->realpath);
367 sprintf (echo_cmd, _("echo Compressing %s..."), ctx->realpath);
368 mutt_system (echo_cmd);
369 if (mutt_system (cmd)) {
370 mutt_any_key_to_continue (NULL);
372 ("%s: Error compressing mailbox! Original mailbox deleted, uncompressed one kept!\n"),
377 mbox_unlock_compressed (ctx, fp);
378 mutt_unblock_signals ();
383 ctx->cinfo->size = get_size(ctx->realpath);
388 int mutt_slow_close_compressed (CONTEXT * ctx)
393 compress_info *ci = ctx->cinfo;
395 if (!(ctx->append && ((append = get_append_command (ctx->realpath, ctx))
396 || (append = ci->close)))) {
397 /* if we can not or should not append, we only have to remove the
398 compressed info, because sync was already called */
399 mutt_fast_close_compressed (ctx);
406 if (append == ci->close)
407 mutt_message (_("Compressing %s..."), ctx->realpath);
409 mutt_message (_("Compressed-appending to %s..."), ctx->realpath);
412 cmd = get_compression_cmd (append, ctx);
416 if ((fp = fopen (ctx->realpath, "a")) == NULL) {
417 mutt_perror (ctx->realpath);
421 mutt_block_signals ();
422 if (mbox_lock_compressed (ctx, fp, 1, 1) == -1) {
424 mutt_unblock_signals ();
425 mutt_error _("Unable to lock mailbox!");
434 if (append == ci->close)
435 sprintf (echo_cmd, _("echo Compressing %s..."), ctx->realpath);
437 sprintf (echo_cmd, _("echo Compressed-appending to %s..."),
439 mutt_system (echo_cmd);
441 if (mutt_system (cmd)) {
442 mutt_any_key_to_continue (NULL);
443 mutt_error (_(" %s: Error compressing mailbox! Uncompressed one kept!\n"),
446 mbox_unlock_compressed (ctx, fp);
447 mutt_unblock_signals ();
452 mbox_unlock_compressed (ctx, fp);
453 mutt_unblock_signals ();
458 p_delete(&ctx->cinfo);
463 mx_t const compress_mx = {
469 mutt_open_read_compressed,