lib-mx/compress.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1997 Alain Penders <Alain@Finale-Dev.com>
   4  *
   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.
   8  */
   9
  10 #include <lib-lib/lib-lib.h>
  11
  12 #include <lib-sys/mutt_signal.h>
  13 #include <lib-sys/unix.h>
  14
  15 #include <lib-ui/curses.h>
  16
  17 #include "mutt.h"
  18
  19 #include "mx.h"
  20 #include "mbox.h"
  21 #include "compress.h"
  22
  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 */
  28 };
  29
  30 char echo_cmd[HUGE_STRING];
  31
  32 /* parameters:
  33  * ctx - context to lock
  34  * excl - exclusive lock?
  35  * retry - should retry if unable to lock?
  36  */
  37 static int mbox_lock_compressed (CONTEXT * ctx, FILE * fp, int excl, int retry)
  38 {
  39   int r;
  40
  41   if ((r = mx_lock_file (ctx->realpath, fileno (fp), excl, 1, retry)) == 0)
  42     ctx->locked = 1;
  43   else if (retry && !excl) {
  44     ctx->readonly = 1;
  45     return 0;
  46   }
  47
  48   return (r);
  49 }
  50
  51 static void mbox_unlock_compressed (CONTEXT * ctx, FILE * fp)
  52 {
  53   if (ctx->locked) {
  54     fflush (fp);
  55
  56     mx_unlock_file (ctx->realpath, fileno (fp), 1);
  57     ctx->locked = 0;
  58   }
  59 }
  60
  61 static int is_new (const char *path)
  62 {
  63   return (access (path, W_OK) != 0 && errno == ENOENT) ? 1 : 0;
  64 }
  65
  66 static const char *find_compress_hook (int type, const char *path)
  67 {
  68   const char *c = mutt_find_hook (type, path);
  69
  70   return (!c || !*c) ? NULL : c;
  71 }
  72
  73 int mutt_can_read_compressed (const char *path)
  74 {
  75   return find_compress_hook (M_OPENHOOK, path) ? 1 : 0;
  76 }
  77
  78 /* if the file is new, we really do not append, but create, and so use
  79  * close-hook, and not append-hook
  80  */
  81 static const char *get_append_command (const char *path, const CONTEXT * ctx)
  82 {
  83   return is_new(path) ? ctx->cinfo->close : ctx->cinfo->append;
  84 }
  85
  86 int mutt_can_append_compressed (const char *path)
  87 {
  88   int magic;
  89
  90   if (is_new (path))
  91     return (find_compress_hook (M_CLOSEHOOK, path) ? 1 : 0);
  92
  93   magic = mx_get_magic (path);
  94
  95   if (magic != 0 && magic != M_COMPRESSED)
  96     return 0;
  97
  98   return (find_compress_hook (M_APPENDHOOK, path)
  99           || (find_compress_hook (M_OPENHOOK, path)
 100               && find_compress_hook (M_CLOSEHOOK, path))) ? 1 : 0;
 101 }
 102
 103 /* open a compressed mailbox */
 104 static compress_info *set_compress_info (CONTEXT * ctx)
 105 {
 106   compress_info *ci = p_new(compress_info, 1);
 107
 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);
 112
 113   return (ctx->cinfo = ci);
 114 }
 115
 116 static void set_path (CONTEXT * ctx)
 117 {
 118   char tmppath[_POSIX_PATH_MAX];
 119
 120   /* Setup the right paths */
 121   ctx->realpath = ctx->path;
 122
 123   /* Uncompress to /tmp */
 124   mutt_mktemp (tmppath);
 125   ctx->path = p_dupstr(tmppath, m_strlen(tmppath));
 126 }
 127
 128 static int get_size (const char *path)
 129 {
 130   struct stat sb;
 131
 132   if (stat (path, &sb) != 0)
 133     return 0;
 134   return (sb.st_size);
 135 }
 136
 137 static const char *
 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)),
 142                         anytype data,
 143                         format_flag flags __attribute__ ((unused)))
 144 {
 145   char tmp[STRING];
 146
 147   CONTEXT *ctx = data.ptr;
 148
 149   switch (op) {
 150   case 'f':
 151     snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
 152     snprintf (dest, destlen, tmp, ctx->realpath);
 153     break;
 154   case 't':
 155     snprintf (tmp, sizeof (tmp), "%%%ss", fmt);
 156     snprintf (dest, destlen, tmp, ctx->path);
 157     break;
 158   }
 159   return (src);
 160 }
 161
 162 /* check that the command has both %f and %t
 163  * 0 means OK, -1 means error
 164  */
 165 int mutt_test_compress_command (const char *cmd)
 166 {
 167   return (strstr (cmd, "%f") && strstr (cmd, "%t")) ? 0 : -1;
 168 }
 169
 170 static char *get_compression_cmd(const char *cmd, const CONTEXT *ctx)
 171 {
 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);
 175 }
 176
 177 int mutt_check_mailbox_compressed (CONTEXT * ctx)
 178 {
 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!");
 183
 184     return (-1);
 185   }
 186   return (0);
 187 }
 188
 189 int mutt_open_read_compressed (CONTEXT * ctx)
 190 {
 191   char *cmd;
 192   FILE *fp;
 193   int rc;
 194
 195   compress_info *ci = set_compress_info (ctx);
 196
 197   if (!ci->open) {
 198     ctx->magic = 0;
 199     p_delete(&ctx->cinfo);
 200     return (-1);
 201   }
 202   if (!ci->close || access (ctx->path, W_OK) != 0)
 203     ctx->readonly = 1;
 204
 205   set_path (ctx);
 206   ctx->cinfo->size = get_size(ctx->realpath);
 207
 208   if (!ctx->quiet)
 209     mutt_message (_("Decompressing %s..."), ctx->realpath);
 210
 211   cmd = get_compression_cmd (ci->open, ctx);
 212   if (cmd == NULL)
 213     return (-1);
 214
 215   if ((fp = fopen (ctx->realpath, "r")) == NULL) {
 216     mutt_perror (ctx->realpath);
 217     p_delete(&cmd);
 218     return (-1);
 219   }
 220   mutt_block_signals ();
 221   if (mbox_lock_compressed (ctx, fp, 0, 1) == -1) {
 222     m_fclose(&fp);
 223     mutt_unblock_signals ();
 224     mutt_error _("Unable to lock mailbox!");
 225
 226     p_delete(&cmd);
 227     return (-1);
 228   }
 229
 230   endwin ();
 231   fflush (stdout);
 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 ();
 237   m_fclose(&fp);
 238
 239   if (rc) {
 240     mutt_any_key_to_continue (NULL);
 241     ctx->magic = 0;
 242     p_delete(&ctx->cinfo);
 243     mutt_error(_("Error executing: %s : unable to open the mailbox!\n"), cmd);
 244   }
 245   p_delete(&cmd);
 246   if (rc)
 247     return (-1);
 248
 249   if (mutt_check_mailbox_compressed (ctx))
 250     return (-1);
 251
 252   ctx->magic = mx_get_magic (ctx->path);
 253
 254   return (0);
 255 }
 256
 257 static void restore_path (CONTEXT * ctx)
 258 {
 259   p_delete(&ctx->path);
 260   ctx->path = ctx->realpath;
 261 }
 262
 263 /* remove the temporary mailbox */
 264 static void remove_file (CONTEXT * ctx)
 265 {
 266   if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
 267     remove (ctx->path);
 268 }
 269
 270 int mutt_open_append_compressed (CONTEXT * ctx)
 271 {
 272   FILE *fh;
 273   compress_info *ci = set_compress_info (ctx);
 274
 275   if (!get_append_command (ctx->path, ctx)) {
 276     if (ci->open && ci->close)
 277       return (mutt_open_read_compressed (ctx));
 278
 279     ctx->magic = 0;
 280     p_delete(&ctx->cinfo);
 281     return (-1);
 282   }
 283
 284   set_path (ctx);
 285
 286   ctx->magic = DefaultMagic;
 287
 288   if (!is_new (ctx->realpath))
 289     if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
 290       if ((fh = safe_fopen (ctx->path, "w")))
 291         m_fclose(&fh);
 292   /* No error checking - the parent function will catch it */
 293
 294   return (0);
 295 }
 296
 297 /* close a compressed mailbox */
 298 void mutt_fast_close_compressed (CONTEXT * ctx)
 299 {
 300   if (ctx->cinfo) {
 301     m_fclose(&ctx->fp);
 302
 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);
 306     else
 307       remove_file (ctx);
 308
 309     restore_path (ctx);
 310     p_delete(&ctx->cinfo);
 311   }
 312 }
 313
 314 /* return 0 on success, -1 on failure */
 315 int mutt_sync_compressed (CONTEXT * ctx)
 316 {
 317   char *cmd;
 318   int rc = 0;
 319   FILE *fp;
 320
 321   if (!ctx->quiet)
 322     mutt_message (_("Compressing %s..."), ctx->realpath);
 323
 324   cmd = get_compression_cmd (ctx->cinfo->close, ctx);
 325   if (cmd == NULL)
 326     return (-1);
 327
 328   if ((fp = fopen (ctx->realpath, "a")) == NULL) {
 329     mutt_perror (ctx->realpath);
 330     p_delete(&cmd);
 331     return (-1);
 332   }
 333   mutt_block_signals ();
 334   if (mbox_lock_compressed (ctx, fp, 1, 1) == -1) {
 335     m_fclose(&fp);
 336     mutt_unblock_signals ();
 337     mutt_error _("Unable to lock mailbox!");
 338
 339     ctx->cinfo->size = get_size(ctx->realpath);
 340
 341     p_delete(&cmd);
 342     return (-1);
 343   }
 344
 345   endwin ();
 346   fflush (stdout);
 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);
 351     mutt_error (_
 352                 ("%s: Error compressing mailbox! Original mailbox deleted, uncompressed one kept!\n"),
 353                 ctx->path);
 354     rc = -1;
 355   }
 356
 357   mbox_unlock_compressed (ctx, fp);
 358   mutt_unblock_signals ();
 359   m_fclose(&fp);
 360
 361   p_delete(&cmd);
 362
 363   ctx->cinfo->size = get_size(ctx->realpath);
 364
 365   return (rc);
 366 }
 367
 368 int mutt_slow_close_compressed (CONTEXT * ctx)
 369 {
 370   FILE *fp;
 371   const char *append;
 372   char *cmd;
 373   compress_info *ci = ctx->cinfo;
 374
 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);
 380     return (0);
 381   }
 382
 383   m_fclose(&ctx->fp);
 384
 385   if (!ctx->quiet) {
 386     if (append == ci->close)
 387       mutt_message (_("Compressing %s..."), ctx->realpath);
 388     else
 389       mutt_message (_("Compressed-appending to %s..."), ctx->realpath);
 390   }
 391
 392   cmd = get_compression_cmd (append, ctx);
 393   if (cmd == NULL)
 394     return (-1);
 395
 396   if ((fp = fopen (ctx->realpath, "a")) == NULL) {
 397     mutt_perror (ctx->realpath);
 398     p_delete(&cmd);
 399     return (-1);
 400   }
 401   mutt_block_signals ();
 402   if (mbox_lock_compressed (ctx, fp, 1, 1) == -1) {
 403     m_fclose(&fp);
 404     mutt_unblock_signals ();
 405     mutt_error _("Unable to lock mailbox!");
 406
 407     p_delete(&cmd);
 408     return (-1);
 409   }
 410
 411   endwin ();
 412   fflush (stdout);
 413
 414   if (append == ci->close)
 415     sprintf (echo_cmd, _("echo Compressing %s..."), ctx->realpath);
 416   else
 417     sprintf (echo_cmd, _("echo Compressed-appending to %s..."),
 418              ctx->realpath);
 419   mutt_system (echo_cmd);
 420
 421   if (mutt_system (cmd)) {
 422     mutt_any_key_to_continue (NULL);
 423     mutt_error (_(" %s: Error compressing mailbox!  Uncompressed one kept!\n"),
 424                 ctx->path);
 425     p_delete(&cmd);
 426     mbox_unlock_compressed (ctx, fp);
 427     mutt_unblock_signals ();
 428     m_fclose(&fp);
 429     return (-1);
 430   }
 431
 432   mbox_unlock_compressed (ctx, fp);
 433   mutt_unblock_signals ();
 434   m_fclose(&fp);
 435   remove_file (ctx);
 436   restore_path (ctx);
 437   p_delete(&cmd);
 438   p_delete(&ctx->cinfo);
 439
 440   return (0);
 441 }
 442
 443 mx_t const compress_mx = {
 444     M_COMPRESSED,
 445     1,
 446     mbox_is_magic,
 447     mbox_check_empty,
 448     access,
 449     mutt_open_read_compressed,
 450     NULL,
 451     NULL,
 452     NULL,
 453     NULL,
 454     NULL,
 455     NULL,
 456 };