src/plugins/archive/libarchive_archive.c

   1 /*
   2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2008 Michael Rasmussen and the Claws Mail Team
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include "config.h"
  22 #include "claws-features.h"
  23 #endif
  24
  25 #include <glib.h>
  26 #include <glib/gi18n.h>
  27
  28 #include "libarchive_archive.h"
  29
  30 #ifndef _TEST
  31 #       include "archiver.h"
  32 #       include "utils.h"
  33 #       include "mainwindow.h"
  34 #   include "folder.h"
  35 #endif
  36
  37 #include <sys/types.h>
  38 #include <sys/stat.h>
  39
  40 #include <archive.h>
  41 #include <archive_entry.h>
  42 #include <fcntl.h>
  43 #include <stdio.h>
  44 #include <stdlib.h>
  45 #include <string.h>
  46 #include <unistd.h>
  47 #include <dirent.h>
  48 #include <glib.h>
  49 #include <libgen.h>
  50
  51 #define READ_BLOCK_SIZE 10240
  52
  53 struct file_info {
  54         char* path;
  55         char* name;
  56 };
  57
  58 static GSList* msg_trash_list = NULL;
  59 static GSList* file_list = NULL;
  60 static gboolean stop_action = FALSE;
  61
  62 #ifdef _TEST
  63 static int permissions = 0;
  64 #endif
  65
  66 static void free_msg_trash(MsgTrash* trash) {
  67     if (trash) {
  68         debug_print("Freeing files in %s\n", folder_item_get_name(trash->item));
  69         if (trash->msgs) {
  70             g_slist_free(trash->msgs);
  71         }
  72         g_free(trash);
  73     }
  74 }
  75
  76 MsgTrash* new_msg_trash(FolderItem* item) {
  77     MsgTrash* msg_trash;
  78     FolderType  type;
  79
  80     g_return_val_if_fail(item != NULL, NULL);
  81
  82     /* FolderType must be F_MH, F_MBOX, F_MAILDIR or F_IMAP */
  83     type = item->folder->klass->type;
  84     if (!(type == F_MH || type == F_MBOX ||
  85             type == F_MAILDIR || type == F_IMAP))
  86        return NULL;
  87     msg_trash = g_new0(MsgTrash, 1);
  88     msg_trash->item = item;
  89     msg_trash->msgs = NULL;
  90     msg_trash_list = g_slist_prepend(msg_trash_list, msg_trash);
  91
  92     return msg_trash;
  93     }
  94
  95 void archive_free_archived_files() {
  96     MsgTrash* mt = NULL;
  97     gint    res;
  98     GSList* l = NULL;
  99
 100     for (l = msg_trash_list; l; l = g_slist_next(l)) {
 101         mt = (MsgTrash *) l->data;
 102         debug_print("Trashing messages in folder: %s\n",
 103                 folder_item_get_name(mt->item));
 104         res = folder_item_remove_msgs(mt->item, mt->msgs);
 105         debug_print("Result was %d\n", res);
 106         free_msg_trash(mt);
 107     }
 108     g_slist_free(msg_trash_list);
 109     msg_trash_list = NULL;
 110 }
 111
 112 void archive_add_msg_mark(MsgTrash* trash, MsgInfo* msg) {
 113     g_return_if_fail(trash != NULL || msg != NULL);
 114     debug_print("Marking msg #%d for removal\n", msg->msgnum);
 115     trash->msgs = g_slist_prepend(trash->msgs, msg);
 116 }
 117
 118 static void free_all(GDate* date, gchar** parts) {
 119     if (date)
 120         g_date_free(date);
 121     if (parts)
 122         g_strfreev(parts);
 123 }
 124
 125 static gboolean is_iso_string(gchar** items) {
 126     int i = -1;
 127     gchar* item;
 128
 129     while (*items) {
 130         i++;
 131         item = *items++;
 132         debug_print("Date part %d: %s\n", i, item);
 133         switch(i) {
 134             case 0:
 135                 if (strlen(item) != 4)
 136                     return FALSE;
 137                 break;
 138             case 1:
 139             case 2:
 140                 if (strlen(item) != 2)
 141                     return FALSE;
 142                 break;
 143             default:
 144                 return FALSE;
 145         }
 146     }
 147     debug_print("Leaving\n");
 148     return (i == 2);
 149 }
 150
 151 static GDate* iso2GDate(const gchar* date) {
 152     GDate*  gdate;
 153     gchar** parts = NULL;
 154     int     i;
 155
 156     g_return_val_if_fail(date != NULL, NULL);
 157
 158     gdate = g_date_new();
 159     parts = g_strsplit(date, "-", 3);
 160     if (! is_iso_string(parts))
 161         return NULL;
 162     if (!parts)
 163         return NULL;
 164     for (i = 0; i < 3; i++) {
 165         int t = atoi(parts[i]);
 166         switch (i) {
 167             case 0:
 168                 if (t < 1 || t > 9999) {
 169                     free_all(gdate, parts);
 170                     return NULL;
 171                 }
 172                 g_date_set_year(gdate, t);
 173                 break;
 174             case 1:
 175                 if (t < 1 || t > 12) {
 176                     free_all(gdate, parts);
 177                     return NULL;
 178                 }
 179                 g_date_set_month(gdate, t);
 180                 break;
 181             case 2:
 182                 if (t < 1 || t > 31) {
 183                     free_all(gdate, parts);
 184                     return NULL;
 185                 }
 186                 g_date_set_day(gdate, t);
 187                 break;
 188         }
 189     }
 190     g_strfreev(parts);
 191     return gdate;
 192 }
 193
 194 gboolean before_date(time_t msg_mtime, const gchar* before) {
 195     gchar*      pos = NULL;
 196     GDate*      date;
 197     GDate*      file_t;
 198     gboolean    res;
 199
 200     debug_print("Cut-off date: %s\n", before);
 201     if ((date = iso2GDate(before)) == NULL) {
 202         g_warning("Bad date format: %s\n", before);
 203         return FALSE;
 204     }
 205
 206     file_t = g_date_new();
 207     g_date_set_time_t(file_t, msg_mtime);
 208
 209     if (debug_get_mode()) {
 210         pos = g_new0(char, 100);
 211         g_date_strftime(pos, 100, "%F", file_t);
 212         fprintf(stderr, "File date: %s\n", pos);
 213         g_free(pos);
 214     }
 215
 216     if (! g_date_valid(file_t)) {
 217         g_warning("Invalid msg date\n");
 218         return FALSE;
 219     }
 220
 221     res = (g_date_compare(file_t, date) >= 0) ? FALSE : TRUE;
 222     g_date_free(file_t);
 223     return res;
 224 }
 225
 226 static void archive_free_file_info(struct file_info* file) {
 227         if (! file)
 228                 return;
 229         if (file->path)
 230                 g_free(file->path);
 231         if (file->name)
 232                 g_free(file->name);
 233         g_free(file);
 234         file = NULL;
 235 }
 236
 237 void stop_archiving() {
 238         debug_print("stop action set to true\n");
 239         stop_action = TRUE;
 240 }
 241
 242 void archive_free_file_list(gboolean md5, gboolean rename) {
 243         struct file_info* file = NULL;
 244         gchar* path = NULL;
 245
 246         debug_print("freeing file list\n");
 247         if (! file_list)
 248                 return;
 249         while (file_list) {
 250                 file = (struct file_info *) file_list->data;
 251                 if (!rename && md5 && g_str_has_suffix(file->name, ".md5")) {
 252                         path = g_strdup_printf("%s/%s", file->path, file->name);
 253                         debug_print("unlinking %s\n", path);
 254                         g_unlink(path);
 255                         g_free(path);
 256                 }
 257                 if (rename) {
 258                         path = g_strdup_printf("%s/%s", file->path, file->name);
 259                         debug_print("unlinking %s\n", path);
 260                         g_unlink(path);
 261                         g_free(path);
 262                 }
 263                 archive_free_file_info(file);
 264                 file_list->data = NULL;
 265                 file_list = g_slist_next(file_list);
 266         }
 267         if (file_list) {
 268                 g_slist_free(file_list);
 269                 file_list = NULL;
 270         }
 271 }
 272
 273 static struct file_info* archive_new_file_info() {
 274         struct file_info* new_file_info = malloc(sizeof(struct file_info));
 275
 276         new_file_info->path = NULL;
 277         new_file_info->name = NULL;
 278         return new_file_info;
 279 }
 280
 281 static void archive_add_to_list(struct file_info* file) {
 282         if (! file)
 283                 return;
 284         file_list = g_slist_prepend(file_list, (gpointer) file);
 285 }
 286
 287 static gchar* strip_leading_dot_slash(gchar* path) {
 288         gchar* stripped = path;
 289         gchar* result = NULL;
 290
 291         if (stripped && stripped[0] == '.') {
 292                 ++stripped;
 293         if (stripped && stripped[0] == '/')
 294                 ++stripped;
 295                 result = g_strdup(stripped);
 296         }
 297         else
 298                 result = g_strdup(path);
 299         return result;
 300 }
 301
 302 static gchar* get_full_path(struct file_info* file) {
 303         char* path = malloc(PATH_MAX);
 304
 305         if (file->path && *(file->path))
 306                 sprintf(path, "%s/%s", file->path, file->name);
 307         else
 308                 sprintf(path, "%s", file->name);
 309         return path;
 310 }
 311
 312 #ifdef _TEST
 313 static gchar* strip_leading_slash(gchar* path) {
 314         gchar* stripped = path;
 315         gchar* result = NULL;
 316
 317         if (stripped && stripped[0] == '/') {
 318                 ++stripped;
 319                 result = g_strdup(stripped);
 320         }
 321         else
 322                 result = g_strdup(path);
 323         return result;
 324 }
 325
 326 static int archive_get_permissions() {
 327         return permissions;
 328 }
 329
 330
 331 void archive_set_permissions(int perm) {
 332         permissions = perm;
 333 }
 334
 335 static int archive_copy_data(struct archive* in, struct archive* out) {
 336         const void* buf;
 337         size_t size;
 338         off_t offset;
 339         int res = ARCHIVE_OK;
 340
 341         while (res == ARCHIVE_OK) {
 342                 res = archive_read_data_block(in, &buf, &size, &offset);
 343                 if (res == ARCHIVE_OK) {
 344                         res = archive_write_data_block(out, buf, size, offset);
 345                 }
 346         }
 347         return (res == ARCHIVE_EOF) ? ARCHIVE_OK : res;
 348 }
 349 #endif
 350
 351 void archive_add_file(gchar* path) {
 352         struct file_info* file = archive_new_file_info();
 353         gchar* filename = NULL;
 354
 355         g_return_if_fail(path != NULL);
 356
 357 #ifndef _TEST
 358         debug_print("add %s to list\n", path);
 359 #endif
 360         filename = g_strrstr_len(path, strlen(path), "/");
 361         if (! filename)
 362                 g_warning("no filename in path '%s'", path);
 363         g_return_if_fail(filename != NULL);
 364
 365         filename++;
 366         file->name = g_strdup(filename);
 367         file->path = strip_leading_dot_slash(dirname(path));
 368         archive_add_to_list(file);
 369 }
 370
 371 GSList* archive_get_file_list() {
 372         return file_list;
 373 }
 374
 375 #ifdef _TEST
 376 const gchar* archive_extract(const char* archive_name, int flags) {
 377         struct archive* in;
 378         struct archive* out;
 379         struct archive_entry* entry;
 380         int res = ARCHIVE_OK;
 381         gchar* buf = NULL;
 382         const char* result == NULL;
 383
 384         g_return_val_if_fail(archive_name != NULL, ARCHIVE_FATAL);
 385
 386         fprintf(stdout, "%s: extracting\n", archive_name);
 387         in = archive_read_new();
 388         if ((res = archive_read_support_format_tar(in)) == ARCHIVE_OK) {
 389                 if ((res = archive_read_support_compression_gzip(in)) == ARCHIVE_OK) {
 390 #if ARCHIVE_VERSION_NUMBER < 3000000
 391                         if ((res = archive_read_open_file(
 392 #else
 393                         if ((res = archive_read_open_filename(
 394 #endif
 395                                 in, archive_name, READ_BLOCK_SIZE)) != ARCHIVE_OK) {
 396                                 g_warning("%s: %s", archive_name, archive_error_string(in));
 397                                 result = archive_error_string(in);
 398                         }
 399                         else {
 400                                 out = archive_write_disk_new();
 401                                 if ((res = archive_write_disk_set_options(
 402                                                                 out, flags)) == ARCHIVE_OK) {
 403                                         res = archive_read_next_header(in, &entry);
 404                                         while (res == ARCHIVE_OK) {
 405                                                 res = archive_write_header(out, entry);
 406                                                 if (res != ARCHIVE_OK) {
 407                                                         g_warning("%s", archive_error_string(out));
 408                                                         /* skip this file an continue */
 409                                                         res = ARCHIVE_OK;
 410                                                 }
 411                                                 else {
 412                                                         res = archive_copy_data(in, out);
 413                                                         if (res != ARCHIVE_OK) {
 414                                                                 g_warning("%s", archive_error_string(in));
 415                                                                 /* skip this file an continue */
 416                                                                 res = ARCHIVE_OK;
 417                                                         }
 418                                                         else
 419                                                                 res = archive_read_next_header(in, &entry);
 420                                                 }
 421                                         }
 422                                         if (res == ARCHIVE_EOF)
 423                                                 res = ARCHIVE_OK;
 424                                         if (res != ARCHIVE_OK) {
 425                                                 gchar *e = archive_error_string(in);
 426                                                 g_warning("%s: %s", archive_name, e? e: "unknown error");
 427                                                 result = e;
 428                                         }
 429                                 }
 430                                 else
 431                                         result = archive_error_string(out);
 432                                 archive_read_close(in);
 433                         }
 434 #if ARCHIVE_VERSION_NUMBER < 3000000
 435                         archive_read_finish(in);
 436 #else
 437                         archive_read_free(in);
 438 #endif
 439                 }
 440                 else
 441                         result = archive_error_string(in);
 442         }
 443         else
 444                 result = archive_error_string(in);
 445         return result;
 446 }
 447 #endif
 448
 449 const gchar* archive_create(const char* archive_name, GSList* files,
 450                         COMPRESS_METHOD method, ARCHIVE_FORMAT format) {
 451         struct archive* arch;
 452         struct archive_entry* entry;
 453         char* buf = NULL;
 454         ssize_t len;
 455         int fd;
 456         struct stat st;
 457         struct file_info* file;
 458         gchar* filename = NULL;
 459         gchar* msg = NULL;
 460
 461 #ifndef _TEST
 462         gint num = 0;
 463         gint total = g_slist_length (files);
 464 #endif
 465
 466         g_return_val_if_fail(files != NULL, "No files for archiving");
 467
 468         debug_print("File: %s\n", archive_name);
 469         arch = archive_write_new();
 470         switch (method) {
 471                 case ZIP:
 472 #if ARCHIVE_VERSION_NUMBER < 3000000
 473                         if (archive_write_set_compression_gzip(arch) != ARCHIVE_OK)
 474 #else
 475                         if (archive_write_add_filter_gzip(arch) != ARCHIVE_OK)
 476 #endif
 477                                 return archive_error_string(arch);
 478                         break;
 479                 case BZIP2:
 480 #if ARCHIVE_VERSION_NUMBER < 3000000
 481                         if (archive_write_set_compression_bzip2(arch) != ARCHIVE_OK)
 482 #else
 483                         if (archive_write_add_filter_bzip2(arch) != ARCHIVE_OK)
 484 #endif
 485                                 return archive_error_string(arch);
 486                         break;
 487                 case COMPRESS:
 488 #if ARCHIVE_VERSION_NUMBER < 3000000
 489                         if (archive_write_set_compression_compress(arch) != ARCHIVE_OK)
 490 #else
 491                         if (archive_write_add_filter_compress(arch) != ARCHIVE_OK)
 492 #endif
 493                                 return archive_error_string(arch);
 494                         break;
 495                 case NO_COMPRESS:
 496 #if ARCHIVE_VERSION_NUMBER < 3000000
 497                         if (archive_write_set_compression_none(arch) != ARCHIVE_OK)
 498 #else
 499                         if (archive_write_add_filter_none(arch) != ARCHIVE_OK)
 500 #endif
 501                                 return archive_error_string(arch);
 502                         break;
 503         }
 504         switch (format) {
 505                 case TAR:
 506                         if (archive_write_set_format_ustar(arch) != ARCHIVE_OK)
 507                                 return archive_error_string(arch);
 508                         break;
 509                 case SHAR:
 510                         if (archive_write_set_format_shar(arch) != ARCHIVE_OK)
 511                                 return archive_error_string(arch);
 512                         break;
 513                 case PAX:
 514                         if (archive_write_set_format_pax(arch) != ARCHIVE_OK)
 515                                 return archive_error_string(arch);
 516                         break;
 517                 case CPIO:
 518                         if (archive_write_set_format_cpio(arch) != ARCHIVE_OK)
 519                                 return archive_error_string(arch);
 520                         break;
 521                 case NO_FORMAT:
 522                         return "Missing archive format";
 523         }
 524 #if ARCHIVE_VERSION_NUMBER < 3000000
 525         if (archive_write_open_file(arch, archive_name) != ARCHIVE_OK)
 526 #else
 527         if (archive_write_open_filename(arch, archive_name) != ARCHIVE_OK)
 528 #endif
 529                 return archive_error_string(arch);
 530
 531         while (files && ! stop_action) {
 532 #ifndef _TEST
 533                 set_progress_print_all(num++, total, 30);
 534 #endif
 535                 file = (struct file_info *) files->data;
 536                 if (!file)
 537                         continue;
 538                 filename = get_full_path(file);
 539                 /* libarchive will crash if instructed to add archive to it self */
 540                 if (g_utf8_collate(archive_name, filename) == 0) {
 541                         g_warning("%s: not dumping to '%s'", archive_name, filename);
 542 #ifndef _TEST
 543                         debug_print("%s: not dumping to '%s'\n", archive_name, filename);
 544 #endif
 545                 }
 546                 else {
 547 #ifndef _TEST
 548                         debug_print("Adding: %s\n", filename);
 549                         msg = g_strdup_printf("%s", filename);
 550                         set_progress_file_label(msg);
 551                         g_free(msg);
 552 #endif
 553                         entry = archive_entry_new();
 554                         lstat(filename, &st);
 555                         if ((fd = open(filename, O_RDONLY)) == -1) {
 556                                 perror("open file");
 557                         }
 558                         else {
 559                                 archive_entry_copy_stat(entry, &st);
 560                                 archive_entry_set_pathname(entry, filename);
 561                                 if (S_ISLNK(st.st_mode)) {
 562                                         buf = NULL;
 563                                         buf = malloc(PATH_MAX + 1);
 564                                         if ((len = readlink(filename, buf, PATH_MAX)) < 0)
 565                                                 perror("error in readlink");
 566                                         else
 567                                                 buf[len] = '\0';
 568                                         archive_entry_set_symlink(entry, buf);
 569                                         g_free(buf);
 570                                         archive_entry_set_size(entry, 0);
 571                                         archive_write_header(arch, entry);
 572                                 }
 573                                 else {
 574                                         if (archive_write_header(arch, entry) != ARCHIVE_OK)
 575                                                 g_warning("%s", archive_error_string(arch));
 576                                         buf = NULL;
 577                                         buf = malloc(READ_BLOCK_SIZE);
 578                                         len = read(fd, buf, READ_BLOCK_SIZE);
 579                                         while (len > 0) {
 580                                                 if (archive_write_data(arch, buf, len) == -1)
 581                                                         g_warning("%s", archive_error_string(arch));
 582                                                 memset(buf, 0, READ_BLOCK_SIZE);
 583                                                 len = read(fd, buf, READ_BLOCK_SIZE);
 584                                         }
 585                                         g_free(buf);
 586                                 }
 587                                 close(fd);
 588                                 archive_entry_free(entry);
 589                         }
 590                 }
 591                 g_free(filename);
 592                 files = g_slist_next(files);
 593         }
 594 #ifndef _TEST
 595         if (stop_action)
 596                 unlink(archive_name);
 597         stop_action = FALSE;
 598 #endif
 599         archive_write_close(arch);
 600 #if ARCHIVE_VERSION_NUMBER < 3000000
 601         archive_write_finish(arch);
 602 #else
 603         archive_write_free(arch);
 604 #endif
 605         return NULL;
 606 }
 607
 608 #ifdef _TEST
 609 void archive_scan_folder(const char* dir) {
 610         GStatBuf st;
 611         DIR* root;
 612         struct dirent* ent;
 613         gchar cwd[PATH_MAX];
 614         gchar path[PATH_MAX];
 615
 616         getcwd(cwd, PATH_MAX);
 617
 618         if (g_stat(dir, &st) == -1)
 619                 return;
 620         if (! S_ISDIR(st.st_mode))
 621                 return;
 622         if (!(root = opendir(dir)))
 623                 return;
 624         chdir(dir);
 625
 626         while ((ent = readdir(root)) != NULL) {
 627                 if (strcmp(".", ent->d_name) == 0 || strcmp("..", ent->d_name) == 0)
 628                         continue;
 629                 g_stat(ent->d_name, &st);
 630                 sprintf(path, "%s/%s", dir, ent->d_name);
 631                 if (S_ISREG(st.st_mode) || S_ISLNK(st.st_mode)) {
 632                         archive_add_file(path);
 633                 }
 634                 else if (S_ISDIR(st.st_mode)) {
 635                         archive_scan_folder(path);
 636                 }
 637         }
 638         chdir(cwd);
 639         closedir(root);
 640 }
 641
 642 int main(int argc, char** argv) {
 643         char* archive = NULL;
 644         char buf[PATH_MAX];
 645         int pid;
 646         int opt;
 647         int perm = ARCHIVE_EXTRACT_PERM | ARCHIVE_EXTRACT_TIME |
 648                 ARCHIVE_EXTRACT_ACL | ARCHIVE_EXTRACT_FFLAGS | ARCHIVE_EXTRACT_SECURE_SYMLINKS;
 649         gchar cwd[PATH_MAX];
 650         gboolean remove = FALSE;
 651         const char *p = NULL;
 652         int res;
 653
 654         getcwd(cwd, PATH_MAX);
 655
 656         while (*++argv && **argv == '-') {
 657                 p = *argv + 1;
 658
 659                 while ((opt = *p++) != '\0') {
 660                         switch(opt) {
 661                                 case 'a':
 662                                         if (*p != '\0')
 663                                                 archive = (char *) p;
 664                                         else
 665                                                 archive = *++argv;
 666                                         p += strlen(p);
 667                                         break;
 668                                 case 'r':
 669                                         remove = TRUE;
 670                                         break;
 671                         }
 672                 }
 673         }
 674         if (! archive) {
 675                 fprintf(stderr, "Missing archive name!\n");
 676                 return EXIT_FAILURE;
 677         }
 678         if (!*argv) {
 679                 fprintf(stderr, "Expected arguments after options!\n");
 680                 return EXIT_FAILURE;
 681         }
 682
 683         while (*argv) {
 684                 archive_scan_folder(*argv++);
 685                 res = archive_create(archive, file_list);
 686                 if (res != ARCHIVE_OK) {
 687                         fprintf(stderr, "%s: Creating archive failed\n", archive);
 688                         return EXIT_FAILURE;
 689                 }
 690         }
 691         pid = (int) getpid();
 692         sprintf(buf, "/tmp/%d", pid);
 693         fprintf(stdout, "Creating: %s\n", buf);
 694         mkdir(buf, 0700);
 695         chdir(buf);
 696         if (strcmp(dirname(archive), ".") == 0)
 697                 sprintf(buf, "%s/%s", cwd, basename(archive));
 698         else
 699                 sprintf(buf, "%s", archive);
 700         archive_extract(buf, perm);
 701         chdir(cwd);
 702         if (remove) {
 703                 sprintf(buf, "rm -rf /tmp/%d", pid);
 704                 fprintf(stdout, "Executing: %s\n", buf);
 705                 system(buf);
 706         }
 707         archive_free_list(file_list);
 708         return EXIT_SUCCESS;
 709 }
 710 #endif