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, retry)) == 0)
43 else if (retry && !excl) {
51 static void mbox_unlock_compressed (CONTEXT * ctx, FILE * fp)
55 mx_unlock_file(ctx->realpath, fileno(fp));
60 static int is_new (const char *path)
62 return (access (path, W_OK) && errno == ENOENT);
65 static const char *find_compress_hook (int type, const char *path)
67 const char *c = mutt_find_hook (type, path);
69 return (!c || !*c) ? NULL : c;
72 int mutt_can_read_compressed (const char *path)
74 return find_compress_hook (M_OPENHOOK, path) ? 1 : 0;
77 /* if the file is new, we really do not append, but create, and so use
78 * close-hook, and not append-hook
80 static const char *get_append_command (const char *path, const CONTEXT * ctx)
82 return is_new(path) ? ctx->cinfo->close : ctx->cinfo->append;
85 int mutt_can_append_compressed (const char *path)
90 return (find_compress_hook (M_CLOSEHOOK, path) ? 1 : 0);
92 magic = mx_get_magic (path);
94 if (magic != 0 && magic != M_COMPRESSED)
97 return (find_compress_hook (M_APPENDHOOK, path)
98 || (find_compress_hook (M_OPENHOOK, path)
99 && find_compress_hook (M_CLOSEHOOK, path))) ? 1 : 0;
102 /* open a compressed mailbox */
103 static compress_info *set_compress_info (CONTEXT * ctx)
105 compress_info *ci = p_new(compress_info, 1);
107 /* Now lets uncompress this thing */
108 ci->append = find_compress_hook (M_APPENDHOOK, ctx->path);
109 ci->open = find_compress_hook (M_OPENHOOK, ctx->path);
110 ci->close = find_compress_hook (M_CLOSEHOOK, ctx->path);
112 return (ctx->cinfo = ci);
115 static int get_size (const char *path)
119 if (stat (path, &sb) != 0)
125 compresshook_format_str(char *dest, ssize_t destlen,
126 char op, const char *src, const char *fmt,
127 const char *ifstr __attribute__ ((unused)),
128 const char *elstr __attribute__ ((unused)),
130 format_flag flags __attribute__ ((unused)))
134 CONTEXT *ctx = data.ptr;
138 snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
139 snprintf (dest, destlen, tmp, ctx->realpath);
142 snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
143 snprintf (dest, destlen, tmp, ctx->path);
149 /* check that the command has both %f and %t
150 * 0 means OK, -1 means error
152 int mutt_test_compress_command (const char *cmd)
154 return (strstr (cmd, "%f") && strstr (cmd, "%t")) ? 0 : -1;
157 static char *get_compression_cmd(const char *cmd, const CONTEXT *ctx)
159 char buf[_POSIX_PATH_MAX];
160 m_strformat(buf, sizeof(buf), 0, cmd, compresshook_format_str, (void*)ctx, 0);
161 return m_strdup(buf);
164 int mutt_check_mailbox_compressed (CONTEXT * ctx)
166 if (ctx->cinfo->size != get_size (ctx->realpath)) {
167 p_delete(&ctx->cinfo);
168 p_delete(&ctx->realpath);
169 mutt_error _("Mailbox was corrupted!");
176 int mutt_open_read_compressed(CONTEXT * ctx)
181 char tmppath[_POSIX_PATH_MAX];
184 compress_info *ci = set_compress_info (ctx);
188 p_delete(&ctx->cinfo);
191 if (!ci->close || access (ctx->path, W_OK) != 0)
194 /* Setup the right paths */
195 ctx->realpath = ctx->path;
197 /* Uncompress to /tmp */
198 tmpfd = m_tempfd(tmppath, sizeof(tmppath), NONULL(mod_core.tmpdir), NULL);
199 /* If we cannot open tempfile, that means the file already exists (!?)
200 * or we are following a symlink, which is bad and insecure.
207 ctx->path = p_dupstr(tmppath, m_strlen(tmppath));
208 ctx->cinfo->size = get_size(ctx->realpath);
211 mutt_message (_("Decompressing %s..."), ctx->realpath);
213 cmd = get_compression_cmd (ci->open, ctx);
217 if ((fp = fopen (ctx->realpath, "r")) == NULL) {
218 mutt_perror (ctx->realpath);
222 mutt_block_signals ();
223 if (mbox_lock_compressed (ctx, fp, 0, 1) == -1) {
225 mutt_unblock_signals ();
226 mutt_error _("Unable to lock mailbox!");
234 sprintf (echo_cmd, _("echo Decompressing %s..."), ctx->realpath);
235 mutt_system (echo_cmd);
236 rc = mutt_system (cmd);
237 mbox_unlock_compressed (ctx, fp);
238 mutt_unblock_signals ();
242 mutt_any_key_to_continue (NULL);
244 p_delete(&ctx->cinfo);
245 mutt_error(_("Error executing: %s : unable to open the mailbox!\n"), cmd);
251 if (mutt_check_mailbox_compressed (ctx))
254 ctx->magic = mx_get_magic (ctx->path);
259 static void restore_path (CONTEXT * ctx)
261 p_delete(&ctx->path);
262 ctx->path = ctx->realpath;
265 /* remove the temporary mailbox */
266 static void remove_file (CONTEXT * ctx)
268 if (ctx->magic == M_MBOX)
272 int mutt_open_append_compressed (CONTEXT * ctx)
275 compress_info *ci = set_compress_info (ctx);
276 char tmppath[_POSIX_PATH_MAX];
278 if (!get_append_command (ctx->path, ctx)) {
279 if (ci->open && ci->close)
280 return mutt_open_read_compressed(ctx);
283 p_delete(&ctx->cinfo);
287 /* Setup the right paths */
288 ctx->realpath = ctx->path;
290 /* Uncompress to /tmp */
291 fh = m_tempfile(tmppath, sizeof(tmppath), NONULL(mod_core.tmpdir), NULL);
294 ctx->path = p_dupstr(tmppath, m_strlen(tmppath));
296 ctx->magic = DefaultMagic;
298 if (is_new (ctx->realpath) || ctx->magic != M_MBOX)
301 /* No error checking - the parent function will catch it */
305 /* close a compressed mailbox */
306 void mutt_fast_close_compressed (CONTEXT * ctx)
311 /* if the folder was removed, remove the gzipped folder too */
314 p_delete(&ctx->cinfo);
318 /* return 0 on success, -1 on failure */
319 int mutt_sync_compressed (CONTEXT * ctx)
326 mutt_message (_("Compressing %s..."), ctx->realpath);
328 cmd = get_compression_cmd (ctx->cinfo->close, ctx);
332 if ((fp = fopen (ctx->realpath, "a")) == NULL) {
333 mutt_perror (ctx->realpath);
337 mutt_block_signals ();
338 if (mbox_lock_compressed (ctx, fp, 1, 1) == -1) {
340 mutt_unblock_signals ();
341 mutt_error _("Unable to lock mailbox!");
343 ctx->cinfo->size = get_size(ctx->realpath);
351 sprintf (echo_cmd, _("echo Compressing %s..."), ctx->realpath);
352 mutt_system (echo_cmd);
353 if (mutt_system (cmd)) {
354 mutt_any_key_to_continue (NULL);
356 ("%s: Error compressing mailbox! Original mailbox deleted, uncompressed one kept!\n"),
361 mbox_unlock_compressed (ctx, fp);
362 mutt_unblock_signals ();
367 ctx->cinfo->size = get_size(ctx->realpath);
372 int mutt_slow_close_compressed (CONTEXT * ctx)
377 compress_info *ci = ctx->cinfo;
379 if (!(ctx->append && ((append = get_append_command (ctx->realpath, ctx))
380 || (append = ci->close)))) {
381 /* if we can not or should not append, we only have to remove the
382 compressed info, because sync was already called */
383 mutt_fast_close_compressed (ctx);
390 if (append == ci->close)
391 mutt_message (_("Compressing %s..."), ctx->realpath);
393 mutt_message (_("Compressed-appending to %s..."), ctx->realpath);
396 cmd = get_compression_cmd (append, ctx);
400 if ((fp = fopen (ctx->realpath, "a")) == NULL) {
401 mutt_perror (ctx->realpath);
405 mutt_block_signals ();
406 if (mbox_lock_compressed (ctx, fp, 1, 1) == -1) {
408 mutt_unblock_signals ();
409 mutt_error _("Unable to lock mailbox!");
418 if (append == ci->close)
419 sprintf (echo_cmd, _("echo Compressing %s..."), ctx->realpath);
421 sprintf (echo_cmd, _("echo Compressed-appending to %s..."),
423 mutt_system (echo_cmd);
425 if (mutt_system (cmd)) {
426 mutt_any_key_to_continue (NULL);
427 mutt_error (_(" %s: Error compressing mailbox! Uncompressed one kept!\n"),
430 mbox_unlock_compressed (ctx, fp);
431 mutt_unblock_signals ();
436 mbox_unlock_compressed (ctx, fp);
437 mutt_unblock_signals ();
442 p_delete(&ctx->cinfo);
447 mx_t const compress_mx = {
453 mutt_open_read_compressed,