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/curses.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) != 0 && errno == ENOENT) ? 1 : 0;
66 static const char *find_compress_hook (int type, const char *path)
68 const char *c = mutt_find_hook (type, path);
70 return (!c || !*c) ? NULL : c;
73 int mutt_can_read_compressed (const char *path)
75 return find_compress_hook (M_OPENHOOK, path) ? 1 : 0;
78 /* if the file is new, we really do not append, but create, and so use
79 * close-hook, and not append-hook
81 static const char *get_append_command (const char *path, const CONTEXT * ctx)
83 return is_new(path) ? ctx->cinfo->close : ctx->cinfo->append;
86 int mutt_can_append_compressed (const char *path)
91 return (find_compress_hook (M_CLOSEHOOK, path) ? 1 : 0);
93 magic = mx_get_magic (path);
95 if (magic != 0 && magic != M_COMPRESSED)
98 return (find_compress_hook (M_APPENDHOOK, path)
99 || (find_compress_hook (M_OPENHOOK, path)
100 && find_compress_hook (M_CLOSEHOOK, path))) ? 1 : 0;
103 /* open a compressed mailbox */
104 static compress_info *set_compress_info (CONTEXT * ctx)
106 compress_info *ci = p_new(compress_info, 1);
108 /* Now lets uncompress this thing */
109 ci->append = find_compress_hook (M_APPENDHOOK, ctx->path);
110 ci->open = find_compress_hook (M_OPENHOOK, ctx->path);
111 ci->close = find_compress_hook (M_CLOSEHOOK, ctx->path);
113 return (ctx->cinfo = ci);
116 static void set_path (CONTEXT * ctx)
118 char tmppath[_POSIX_PATH_MAX];
120 /* Setup the right paths */
121 ctx->realpath = ctx->path;
123 /* Uncompress to /tmp */
124 mutt_mktemp (tmppath);
125 ctx->path = p_dupstr(tmppath, m_strlen(tmppath));
128 static int get_size (const char *path)
132 if (stat (path, &sb) != 0)
138 compresshook_format_str(char *dest, ssize_t destlen,
139 char op, const char *src, const char *fmt,
140 const char *ifstr __attribute__ ((unused)),
141 const char *elstr __attribute__ ((unused)),
143 format_flag flags __attribute__ ((unused)))
147 CONTEXT *ctx = data.ptr;
151 snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
152 snprintf (dest, destlen, tmp, ctx->realpath);
155 snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
156 snprintf (dest, destlen, tmp, ctx->path);
162 /* check that the command has both %f and %t
163 * 0 means OK, -1 means error
165 int mutt_test_compress_command (const char *cmd)
167 return (strstr (cmd, "%f") && strstr (cmd, "%t")) ? 0 : -1;
170 static char *get_compression_cmd(const char *cmd, const CONTEXT *ctx)
172 char buf[_POSIX_PATH_MAX];
173 m_strformat(buf, sizeof(buf), 0, cmd, compresshook_format_str, (void*)ctx, 0);
174 return m_strdup(buf);
177 int mutt_check_mailbox_compressed (CONTEXT * ctx)
179 if (ctx->cinfo->size != get_size (ctx->realpath)) {
180 p_delete(&ctx->cinfo);
181 p_delete(&ctx->realpath);
182 mutt_error _("Mailbox was corrupted!");
189 int mutt_open_read_compressed (CONTEXT * ctx)
195 compress_info *ci = set_compress_info (ctx);
199 p_delete(&ctx->cinfo);
202 if (!ci->close || access (ctx->path, W_OK) != 0)
206 ctx->cinfo->size = get_size(ctx->realpath);
209 mutt_message (_("Decompressing %s..."), ctx->realpath);
211 cmd = get_compression_cmd (ci->open, ctx);
215 if ((fp = fopen (ctx->realpath, "r")) == NULL) {
216 mutt_perror (ctx->realpath);
220 mutt_block_signals ();
221 if (mbox_lock_compressed (ctx, fp, 0, 1) == -1) {
223 mutt_unblock_signals ();
224 mutt_error _("Unable to lock mailbox!");
232 sprintf (echo_cmd, _("echo Decompressing %s..."), ctx->realpath);
233 mutt_system (echo_cmd);
234 rc = mutt_system (cmd);
235 mbox_unlock_compressed (ctx, fp);
236 mutt_unblock_signals ();
240 mutt_any_key_to_continue (NULL);
242 p_delete(&ctx->cinfo);
243 mutt_error(_("Error executing: %s : unable to open the mailbox!\n"), cmd);
249 if (mutt_check_mailbox_compressed (ctx))
252 ctx->magic = mx_get_magic (ctx->path);
257 static void restore_path (CONTEXT * ctx)
259 p_delete(&ctx->path);
260 ctx->path = ctx->realpath;
263 /* remove the temporary mailbox */
264 static void remove_file (CONTEXT * ctx)
266 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
270 int mutt_open_append_compressed (CONTEXT * ctx)
273 compress_info *ci = set_compress_info (ctx);
275 if (!get_append_command (ctx->path, ctx)) {
276 if (ci->open && ci->close)
277 return (mutt_open_read_compressed (ctx));
280 p_delete(&ctx->cinfo);
286 ctx->magic = DefaultMagic;
288 if (!is_new (ctx->realpath))
289 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
290 if ((fh = safe_fopen (ctx->path, "w")))
292 /* No error checking - the parent function will catch it */
297 /* close a compressed mailbox */
298 void mutt_fast_close_compressed (CONTEXT * ctx)
303 /* if the folder was removed, remove the gzipped folder too */
304 if (access (ctx->path, F_OK) != 0 && !option (OPTSAVEEMPTY))
305 remove (ctx->realpath);
310 p_delete(&ctx->cinfo);
314 /* return 0 on success, -1 on failure */
315 int mutt_sync_compressed (CONTEXT * ctx)
322 mutt_message (_("Compressing %s..."), ctx->realpath);
324 cmd = get_compression_cmd (ctx->cinfo->close, ctx);
328 if ((fp = fopen (ctx->realpath, "a")) == NULL) {
329 mutt_perror (ctx->realpath);
333 mutt_block_signals ();
334 if (mbox_lock_compressed (ctx, fp, 1, 1) == -1) {
336 mutt_unblock_signals ();
337 mutt_error _("Unable to lock mailbox!");
339 ctx->cinfo->size = get_size(ctx->realpath);
347 sprintf (echo_cmd, _("echo Compressing %s..."), ctx->realpath);
348 mutt_system (echo_cmd);
349 if (mutt_system (cmd)) {
350 mutt_any_key_to_continue (NULL);
352 ("%s: Error compressing mailbox! Original mailbox deleted, uncompressed one kept!\n"),
357 mbox_unlock_compressed (ctx, fp);
358 mutt_unblock_signals ();
363 ctx->cinfo->size = get_size(ctx->realpath);
368 int mutt_slow_close_compressed (CONTEXT * ctx)
373 compress_info *ci = ctx->cinfo;
375 if (!(ctx->append && ((append = get_append_command (ctx->realpath, ctx))
376 || (append = ci->close)))) {
377 /* if we can not or should not append, we only have to remove the
378 compressed info, because sync was already called */
379 mutt_fast_close_compressed (ctx);
386 if (append == ci->close)
387 mutt_message (_("Compressing %s..."), ctx->realpath);
389 mutt_message (_("Compressed-appending to %s..."), ctx->realpath);
392 cmd = get_compression_cmd (append, ctx);
396 if ((fp = fopen (ctx->realpath, "a")) == NULL) {
397 mutt_perror (ctx->realpath);
401 mutt_block_signals ();
402 if (mbox_lock_compressed (ctx, fp, 1, 1) == -1) {
404 mutt_unblock_signals ();
405 mutt_error _("Unable to lock mailbox!");
414 if (append == ci->close)
415 sprintf (echo_cmd, _("echo Compressing %s..."), ctx->realpath);
417 sprintf (echo_cmd, _("echo Compressed-appending to %s..."),
419 mutt_system (echo_cmd);
421 if (mutt_system (cmd)) {
422 mutt_any_key_to_continue (NULL);
423 mutt_error (_(" %s: Error compressing mailbox! Uncompressed one kept!\n"),
426 mbox_unlock_compressed (ctx, fp);
427 mutt_unblock_signals ();
432 mbox_unlock_compressed (ctx, fp);
433 mutt_unblock_signals ();
438 p_delete(&ctx->cinfo);
443 mx_t const compress_mx = {
449 mutt_open_read_compressed,