src/partial_download.c

   1 /*
   2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2011 Colin Leroy <colin@colino.net>
   4  * and the Claws Mail team
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  */
  20
  21 /* Partial download:
  22  * A mail which has been completely downloaded will have no special headers,
  23  * and its entry in the uidl file will end by 0 (POP3_TOTALLY_RECEIVED);
  24  *
  25  * A mail which has been partially downloaded will have some special headers,
  26  * and its entry in the uidl file will first be 1 (POP3_PARTIALLY_RECEIVED);
  27  * the special headers will be including "SC-Marked-For-Download" which can
  28  * have three values:
  29  * 0 (POP3_PARTIAL_DLOAD_UNKN) meaning that the user has not yet chosen to
  30  *  download the mail or let it be deleted - this header is absent until the
  31  *  user first chooses an action
  32  * 1 (POP3_PARTIAL_DLOAD_DLOAD) meaning that the user wants to finish
  33  *  downloading the mail
  34  * 2 (POP3_PARTIAL_DLOAD_DELE) meaning that the user does not want to finish
  35  *  downloading the mail
  36  * When updating this header to POP3_PARTIAL_DLOAD_DLOAD, the uidl line of
  37  * this mail will end with the mail's physical path, which Sylpheed will remove
  38  * after having downloaded the complete mail. msg->partial_recv will equal
  39  * 2 (POP3_MUST_COMPLETE_RECV).
  40  * When updating this header to POP3_PARTIAL_DLOAD_DELE, the uidl line of
  41  * this mail will be 0 (POP3_TOTALLY_RECEIVED), which will let Sylpheed delete
  42  * this mail from the server as soon as the leave_time preference specifies.
  43  */
  44
  45 #ifdef HAVE_CONFIG_H
  46 #  include "config.h"
  47 #endif
  48
  49 #include <glib.h>
  50 #include <glib/gi18n.h>
  51 #include <stdio.h>
  52 #include <string.h>
  53 #include <stdarg.h>
  54 #include <ctype.h>
  55 #include <unistd.h>
  56 #include <time.h>
  57 #include <errno.h>
  58
  59 #include "partial_download.h"
  60 #include "utils.h"
  61 #include "pop.h"
  62 #include "folder.h"
  63 #include "procheader.h"
  64 #include "msgcache.h"
  65
  66 int partial_msg_in_uidl_list(MsgInfo *msginfo)
  67 {
  68         gchar *path;
  69         FILE *fp;
  70         gchar buf[POPBUFSIZE];
  71         gchar uidl[POPBUFSIZE];
  72         time_t recv_time;
  73         time_t now;
  74         gint partial_recv;
  75         gchar *sanitized_uid = NULL;
  76
  77         if (!msginfo->extradata)
  78                 return FALSE;
  79
  80         sanitized_uid = g_strdup(msginfo->extradata->account_login);
  81
  82         subst_for_filename(sanitized_uid);
  83
  84         if (!msginfo->extradata->account_server
  85         ||  !msginfo->extradata->account_login
  86         ||  !msginfo->extradata->partial_recv)
  87                 return FALSE;
  88
  89         path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
  90                            "uidl", G_DIR_SEPARATOR_S, msginfo->extradata->account_server,
  91                            "-", msginfo->extradata->account_login, NULL);
  92         if ((fp = g_fopen(path, "rb")) == NULL) {
  93                 if (ENOENT != errno) FILE_OP_ERROR(path, "fopen");
  94                 g_free(path);
  95                 path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
  96                                    "uidl-", msginfo->extradata->account_server,
  97                                    "-", sanitized_uid, NULL);
  98                 if ((fp = g_fopen(path, "rb")) == NULL) {
  99                         if (ENOENT != errno) FILE_OP_ERROR(path, "fopen");
 100                         g_free(sanitized_uid);
 101                         g_free(path);
 102                         return FALSE;
 103                 }
 104         }
 105         g_free(sanitized_uid);
 106         g_free(path);
 107
 108         now = time(NULL);
 109
 110         while (fgets(buf, sizeof(buf), fp) != NULL) {
 111                 gchar tmp[POPBUFSIZE];
 112                 strretchomp(buf);
 113                 recv_time = RECV_TIME_NONE;
 114                 partial_recv = POP3_TOTALLY_RECEIVED;
 115
 116                 if (sscanf(buf, "%s\t%ld\t%s", uidl, (long int *) &recv_time,
 117                            tmp) < 2) {
 118                         if (sscanf(buf, "%s", uidl) != 1)
 119                                 continue;
 120                         else {
 121                                 recv_time = now;
 122                         }
 123                 }
 124                 if (!strcmp(uidl, msginfo->extradata->partial_recv)) {
 125                         fclose(fp);
 126                         return TRUE;
 127                 }
 128         }
 129
 130         fclose(fp);
 131         return FALSE;
 132 }
 133
 134 static int partial_uidl_mark_mail(MsgInfo *msginfo, int download)
 135 {
 136         gchar *path;
 137         gchar *pathnew;
 138         FILE *fp;
 139         FILE *fpnew;
 140         gchar buf[POPBUFSIZE];
 141         gchar uidl[POPBUFSIZE];
 142         time_t recv_time;
 143         time_t now;
 144         gchar partial_recv[POPBUFSIZE];
 145         int err = -1;
 146         gchar *filename;
 147         MsgInfo *tinfo;
 148         gchar *sanitized_uid = NULL;
 149
 150         filename = procmsg_get_message_file_path(msginfo);
 151         if (!filename) {
 152                 g_warning("can't get message file path.\n");
 153                 return err;
 154         }
 155         tinfo = procheader_parse_file(filename, msginfo->flags, TRUE, TRUE);
 156
 157         if (!tinfo->extradata) {
 158                 g_free(filename);
 159                 return err;
 160         }
 161
 162         sanitized_uid = g_strdup(tinfo->extradata->account_login);
 163         subst_for_filename(sanitized_uid);
 164
 165         if (!tinfo->extradata->account_server
 166         ||  !tinfo->extradata->account_login
 167         ||  !tinfo->extradata->partial_recv) {
 168                 goto bail;
 169         }
 170         path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
 171                            "uidl", G_DIR_SEPARATOR_S, tinfo->extradata->account_server,
 172                            "-", sanitized_uid, NULL);
 173
 174         if ((fp = g_fopen(path, "rb")) == NULL) {
 175                 perror("fopen1");
 176                 if (ENOENT != errno) FILE_OP_ERROR(path, "fopen");
 177                 g_free(path);
 178                 path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
 179                                    "uidl-", tinfo->extradata->account_server,
 180                                    "-", tinfo->extradata->account_login, NULL);
 181                 if ((fp = g_fopen(path, "rb")) == NULL) {
 182                         if (ENOENT != errno) FILE_OP_ERROR(path, "fopen");
 183                         g_free(path);
 184                         goto bail;
 185                 }
 186         }
 187
 188         pathnew = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
 189                            "uidl", G_DIR_SEPARATOR_S, tinfo->extradata->account_server,
 190                            "-", sanitized_uid, ".new", NULL);
 191
 192         g_free(sanitized_uid);
 193
 194         if ((fpnew = g_fopen(pathnew, "wb")) == NULL) {
 195                 perror("fopen2");
 196                 fclose(fp);
 197                 g_free(pathnew);
 198                 goto bail;
 199         }
 200
 201         now = time(NULL);
 202
 203         while (fgets(buf, sizeof(buf), fp) != NULL) {
 204                 strretchomp(buf);
 205                 recv_time = RECV_TIME_NONE;
 206                 sprintf(partial_recv,"0");
 207
 208                 if (sscanf(buf, "%s\t%ld\t%s",
 209                            uidl, (long int *) &recv_time, partial_recv) < 2) {
 210                         if (sscanf(buf, "%s", uidl) != 1)
 211                                 continue;
 212                         else {
 213                                 recv_time = now;
 214                         }
 215                 }
 216                 if (strcmp(tinfo->extradata->partial_recv, uidl)) {
 217                         if (fprintf(fpnew, "%s\t%ld\t%s\n",
 218                                 uidl, (long int) recv_time, partial_recv) < 0) {
 219                                 FILE_OP_ERROR(pathnew, "fprintf");
 220                                 fclose(fpnew);
 221                                 fclose(fp);
 222                                 g_free(path);
 223                                 g_free(pathnew);
 224                                 goto bail;
 225                         }
 226                 } else {
 227                         gchar *stat = NULL;
 228                         if (download == POP3_PARTIAL_DLOAD_DLOAD) {
 229                                 gchar *folder_id = folder_item_get_identifier(
 230                                                         msginfo->folder);
 231                                 stat = g_strdup_printf("%s:%d",
 232                                         folder_id, msginfo->msgnum);
 233                                 g_free(folder_id);
 234                         }
 235                         else if (download == POP3_PARTIAL_DLOAD_UNKN)
 236                                 stat = g_strdup("1");
 237                         else if (download == POP3_PARTIAL_DLOAD_DELE)
 238                                 stat = g_strdup("0");
 239
 240                         if (fprintf(fpnew, "%s\t%ld\t%s\n",
 241                                 uidl, (long int) recv_time, stat) < 0) {
 242                                 FILE_OP_ERROR(pathnew, "fprintf");
 243                                 fclose(fpnew);
 244                                 fclose(fp);
 245                                 g_free(path);
 246                                 g_free(pathnew);
 247                                 goto bail;
 248                         }
 249                         g_free(stat);
 250                 }
 251         }
 252         if (fclose(fpnew) == EOF) {
 253                 FILE_OP_ERROR(pathnew, "fclose");
 254                 fclose(fp);
 255                 g_free(path);
 256                 g_free(pathnew);
 257                 goto bail;
 258         }
 259         fclose(fp);
 260
 261         move_file(pathnew, path, TRUE);
 262
 263         g_free(path);
 264         g_free(pathnew);
 265
 266         if ((fp = g_fopen(filename,"rb")) == NULL) {
 267                 perror("fopen3");
 268                 goto bail;
 269         }
 270         pathnew = g_strdup_printf("%s.new", filename);
 271         if ((fpnew = g_fopen(pathnew, "wb")) == NULL) {
 272                 perror("fopen4");
 273                 fclose(fp);
 274                 g_free(pathnew);
 275                 goto bail;
 276         }
 277
 278         if (fprintf(fpnew, "SC-Marked-For-Download: %d\n",
 279                         download) < 0) {
 280                 FILE_OP_ERROR(pathnew, "fprintf");
 281                 fclose(fpnew);
 282                 fclose(fp);
 283                 g_free(pathnew);
 284                 goto bail;
 285         }
 286         while (fgets(buf, sizeof(buf)-1, fp) != NULL) {
 287                 if(strlen(buf) > strlen("SC-Marked-For-Download: x\n")
 288                 && !strncmp(buf, "SC-Marked-For-Download:",
 289                             strlen("SC-Marked-For-Download:"))) {
 290                         if (fprintf(fpnew, "%s",
 291                          buf+strlen("SC-Marked-For-Download: x\n")) < 0) {
 292                                 FILE_OP_ERROR(pathnew, "fprintf");
 293                                 fclose(fpnew);
 294                                 fclose(fp);
 295                                 g_free(pathnew);
 296                                 goto bail;
 297                         }
 298                         continue;
 299                 } else if (strlen(buf) == strlen("SC-Marked-For-Download: x\n")
 300                 && !strncmp(buf, "SC-Marked-For-Download:",
 301                             strlen("SC-Marked-For-Download:"))) {
 302                         continue;
 303                 }
 304                 if (fprintf(fpnew, "%s", buf) < 0) {
 305                         FILE_OP_ERROR(pathnew, "fprintf");
 306                         fclose(fpnew);
 307                         fclose(fp);
 308                         g_free(pathnew);
 309                         goto bail;
 310                 }
 311         }
 312         if (fclose(fpnew) == EOF) {
 313                 FILE_OP_ERROR(pathnew, "fclose");
 314                 fclose(fp);
 315                 g_free(pathnew);
 316                 goto bail;
 317         }
 318
 319         fclose(fp);
 320         claws_unlink(filename);
 321         g_rename(pathnew, filename);
 322         g_free(pathnew);
 323         msginfo->planned_download = download;
 324         msgcache_update_msg(msginfo->folder->cache, msginfo);
 325
 326         err = 0;
 327 bail:
 328         g_free(filename);
 329         procmsg_msginfo_free(tinfo);
 330
 331         return err;
 332 }
 333
 334 int partial_mark_for_delete(MsgInfo *msginfo)
 335 {
 336         return partial_uidl_mark_mail(msginfo, POP3_PARTIAL_DLOAD_DELE);
 337 }
 338
 339 int partial_mark_for_download(MsgInfo *msginfo)
 340 {
 341         return partial_uidl_mark_mail(msginfo, POP3_PARTIAL_DLOAD_DLOAD);
 342 }
 343
 344 int partial_unmark(MsgInfo *msginfo)
 345 {
 346         return partial_uidl_mark_mail(msginfo, POP3_PARTIAL_DLOAD_UNKN);
 347 }
 348
 349 void partial_delete_old(const gchar *file)
 350 {
 351         gchar *id = g_strdup(file);
 352         gchar *snum = strrchr(file, ':');
 353         int num = 0;
 354         FolderItem *item = NULL;
 355
 356         debug_print("too big message updated, should remove %s\n", file?file:"(null)");
 357
 358         if (snum) {
 359                 snum++;
 360         } else {
 361                 g_free(id);
 362                 return; /* not a real problem */
 363         }
 364
 365         num = atoi(snum);
 366
 367         if (strrchr(id, ':'))
 368                 *(strrchr(id, ':'))='\0';
 369
 370         item = folder_find_item_from_identifier(id);
 371         if (item) {
 372                 debug_print("removing %d in %s\n", num, id);
 373                 folder_item_remove_msg(item, num);
 374         }
 375         g_free(id);
 376 }
 377
 378 gchar *partial_get_filename(const gchar *server, const gchar *login,
 379                                    const gchar *muidl)
 380 {
 381         gchar *path;
 382         gchar *result = NULL;
 383         FILE *fp;
 384         gchar buf[POPBUFSIZE];
 385         gchar uidl[POPBUFSIZE];
 386         time_t recv_time;
 387         time_t now;
 388         gint partial_recv;
 389         gchar *sanitized_uid = g_strdup(login);
 390
 391         subst_for_filename(sanitized_uid);
 392
 393         path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
 394                            "uidl", G_DIR_SEPARATOR_S,
 395                            server, "-", sanitized_uid, NULL);
 396         if ((fp = g_fopen(path, "rb")) == NULL) {
 397                 if (ENOENT != errno) FILE_OP_ERROR(path, "fopen");
 398                 g_free(path);
 399                 path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
 400                                    "uidl-", server,
 401                                    "-", sanitized_uid, NULL);
 402                 if ((fp = g_fopen(path, "rb")) == NULL) {
 403                         if (ENOENT != errno) FILE_OP_ERROR(path, "fopen");
 404                         g_free(sanitized_uid);
 405                         g_free(path);
 406                         return result;
 407                 }
 408         }
 409         g_free(sanitized_uid);
 410         g_free(path);
 411
 412         now = time(NULL);
 413
 414         while (fgets(buf, sizeof(buf), fp) != NULL) {
 415                 gchar tmp[POPBUFSIZE];
 416                 strretchomp(buf);
 417                 recv_time = RECV_TIME_NONE;
 418                 partial_recv = POP3_TOTALLY_RECEIVED;
 419
 420                 if (sscanf(buf, "%s\t%ld\t%s", uidl, (long int *) &recv_time,
 421                            tmp) < 2) {
 422                         if (sscanf(buf, "%s", uidl) != 1)
 423                                 continue;
 424                         else {
 425                                 recv_time = now;
 426                         }
 427                 }
 428                 if (!strcmp(muidl, uidl)) {
 429                         result = g_strdup(tmp);
 430                         break;
 431                 }
 432         }
 433
 434         fclose(fp);
 435
 436         return result;
 437 }
 438