src/partial_download.c

   1 /*
   2  * Claws Mail -- a GTK based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2018 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 Claws Mail 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 Claws Mail 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 #include "claws-features.h"
  48 #endif
  49
  50 #include <glib.h>
  51 #include <glib/gi18n.h>
  52 #include <stdio.h>
  53 #include <string.h>
  54 #include <stdarg.h>
  55 #include <ctype.h>
  56 #include <unistd.h>
  57 #include <time.h>
  58 #include <errno.h>
  59
  60 #include "partial_download.h"
  61 #include "utils.h"
  62 #include "pop.h"
  63 #include "folder.h"
  64 #include "procheader.h"
  65 #include "msgcache.h"
  66 #include "file-utils.h"
  67
  68 int partial_msg_in_uidl_list(MsgInfo *msginfo)
  69 {
  70         gchar *path;
  71         FILE *fp;
  72         gchar buf[POPBUFSIZE];
  73         gchar uidl[POPBUFSIZE];
  74         time_t recv_time;
  75         time_t now;
  76         gchar *sanitized_uid = NULL;
  77
  78         if (!msginfo->extradata)
  79                 return FALSE;
  80
  81         sanitized_uid = g_strdup(msginfo->extradata->account_login);
  82
  83         subst_for_filename(sanitized_uid);
  84
  85         if (!msginfo->extradata->account_server
  86         ||  !msginfo->extradata->account_login
  87         ||  !msginfo->extradata->partial_recv)
  88                 return FALSE;
  89
  90         path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
  91                            "uidl", G_DIR_SEPARATOR_S, msginfo->extradata->account_server,
  92                            "-", msginfo->extradata->account_login, NULL);
  93         if ((fp = claws_fopen(path, "rb")) == NULL) {
  94                 if (ENOENT != errno) FILE_OP_ERROR(path, "claws_fopen");
  95                 g_free(path);
  96                 path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
  97                                    "uidl-", msginfo->extradata->account_server,
  98                                    "-", sanitized_uid, NULL);
  99                 if ((fp = claws_fopen(path, "rb")) == NULL) {
 100                         if (ENOENT != errno) FILE_OP_ERROR(path, "claws_fopen");
 101                         g_free(sanitized_uid);
 102                         g_free(path);
 103                         return FALSE;
 104                 }
 105         }
 106         g_free(sanitized_uid);
 107         g_free(path);
 108
 109         now = time(NULL);
 110
 111         while (claws_fgets(buf, sizeof(buf), fp) != NULL) {
 112                 gchar tmp[POPBUFSIZE];
 113                 strretchomp(buf);
 114                 recv_time = RECV_TIME_NONE;
 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                         claws_fclose(fp);
 126                         return TRUE;
 127                 }
 128         }
 129
 130         claws_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");
 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 = claws_fopen(path, "rb")) == NULL) {
 175                 if (ENOENT != errno) FILE_OP_ERROR(path, "claws_fopen");
 176                 g_free(path);
 177                 path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
 178                                    "uidl-", tinfo->extradata->account_server,
 179                                    "-", tinfo->extradata->account_login, NULL);
 180                 if ((fp = claws_fopen(path, "rb")) == NULL) {
 181                         if (ENOENT != errno) FILE_OP_ERROR(path, "claws_fopen");
 182                         g_free(path);
 183                         goto bail;
 184                 }
 185         }
 186
 187         pathnew = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
 188                            "uidl", G_DIR_SEPARATOR_S, tinfo->extradata->account_server,
 189                            "-", sanitized_uid, ".new", NULL);
 190
 191         g_free(sanitized_uid);
 192
 193         if ((fpnew = claws_fopen(pathnew, "wb")) == NULL) {
 194                 FILE_OP_ERROR(pathnew, "claws_fopen");
 195                 claws_fclose(fp);
 196                 g_free(path);
 197                 g_free(pathnew);
 198                 goto bail;
 199         }
 200
 201         now = time(NULL);
 202
 203         while (claws_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                                 claws_fclose(fpnew);
 221                                 claws_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                                 claws_fclose(fpnew);
 244                                 claws_fclose(fp);
 245                                 g_free(path);
 246                                 g_free(pathnew);
 247                                 goto bail;
 248                         }
 249                         g_free(stat);
 250                 }
 251         }
 252         if (claws_safe_fclose(fpnew) == EOF) {
 253                 FILE_OP_ERROR(pathnew, "claws_fclose");
 254                 claws_fclose(fp);
 255                 g_free(path);
 256                 g_free(pathnew);
 257                 goto bail;
 258         }
 259         claws_fclose(fp);
 260
 261         move_file(pathnew, path, TRUE);
 262
 263         g_free(path);
 264         g_free(pathnew);
 265
 266         if ((fp = claws_fopen(filename,"rb")) == NULL) {
 267                 FILE_OP_ERROR(filename, "claws_fopen");
 268                 goto bail;
 269         }
 270         pathnew = g_strdup_printf("%s.new", filename);
 271         if ((fpnew = claws_fopen(pathnew, "wb")) == NULL) {
 272                 FILE_OP_ERROR(pathnew, "claws_fopen");
 273                 claws_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                 claws_fclose(fpnew);
 282                 claws_fclose(fp);
 283                 g_free(pathnew);
 284                 goto bail;
 285         }
 286         while (claws_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                                 claws_fclose(fpnew);
 294                                 claws_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                         claws_fclose(fpnew);
 307                         claws_fclose(fp);
 308                         g_free(pathnew);
 309                         goto bail;
 310                 }
 311         }
 312         if (claws_safe_fclose(fpnew) == EOF) {
 313                 FILE_OP_ERROR(pathnew, "claws_fclose");
 314                 claws_fclose(fp);
 315                 g_free(pathnew);
 316                 goto bail;
 317         }
 318
 319         claws_fclose(fp);
 320         if (rename_force(pathnew, filename) != 0) {
 321                 g_free(pathnew);
 322                 goto bail;
 323         }
 324
 325         g_free(pathnew);
 326         msginfo->planned_download = download;
 327         msgcache_update_msg(msginfo->folder->cache, msginfo);
 328
 329         err = 0;
 330 bail:
 331         g_free(filename);
 332         procmsg_msginfo_free(&tinfo);
 333
 334         return err;
 335 }
 336
 337 int partial_mark_for_delete(MsgInfo *msginfo)
 338 {
 339         return partial_uidl_mark_mail(msginfo, POP3_PARTIAL_DLOAD_DELE);
 340 }
 341
 342 int partial_mark_for_download(MsgInfo *msginfo)
 343 {
 344         return partial_uidl_mark_mail(msginfo, POP3_PARTIAL_DLOAD_DLOAD);
 345 }
 346
 347 int partial_unmark(MsgInfo *msginfo)
 348 {
 349         return partial_uidl_mark_mail(msginfo, POP3_PARTIAL_DLOAD_UNKN);
 350 }
 351
 352 void partial_delete_old(const gchar *file)
 353 {
 354         gchar *id = g_strdup(file);
 355         gchar *snum = strrchr(file, ':');
 356         int num = 0;
 357         FolderItem *item = NULL;
 358
 359         debug_print("too big message updated, should remove %s\n", file?file:"(null)");
 360
 361         if (snum) {
 362                 snum++;
 363         } else {
 364                 g_free(id);
 365                 return; /* not a real problem */
 366         }
 367
 368         num = atoi(snum);
 369
 370         if (strrchr(id, ':'))
 371                 *(strrchr(id, ':'))='\0';
 372
 373         item = folder_find_item_from_identifier(id);
 374         if (item) {
 375                 debug_print("removing %d in %s\n", num, id);
 376                 folder_item_remove_msg(item, num);
 377         }
 378         g_free(id);
 379 }
 380
 381 gchar *partial_get_filename(const gchar *server, const gchar *login,
 382                                    const gchar *muidl)
 383 {
 384         gchar *path;
 385         gchar *result = NULL;
 386         FILE *fp;
 387         gchar buf[POPBUFSIZE];
 388         gchar uidl[POPBUFSIZE];
 389         time_t recv_time;
 390         time_t now;
 391         gchar *sanitized_uid = g_strdup(login);
 392
 393         subst_for_filename(sanitized_uid);
 394
 395         path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
 396                            "uidl", G_DIR_SEPARATOR_S,
 397                            server, "-", sanitized_uid, NULL);
 398         if ((fp = claws_fopen(path, "rb")) == NULL) {
 399                 if (ENOENT != errno) FILE_OP_ERROR(path, "claws_fopen");
 400                 g_free(path);
 401                 path = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
 402                                    "uidl-", server,
 403                                    "-", sanitized_uid, NULL);
 404                 if ((fp = claws_fopen(path, "rb")) == NULL) {
 405                         if (ENOENT != errno) FILE_OP_ERROR(path, "claws_fopen");
 406                         g_free(sanitized_uid);
 407                         g_free(path);
 408                         return result;
 409                 }
 410         }
 411         g_free(sanitized_uid);
 412         g_free(path);
 413
 414         now = time(NULL);
 415
 416         while (claws_fgets(buf, sizeof(buf), fp) != NULL) {
 417                 gchar tmp[POPBUFSIZE];
 418                 strretchomp(buf);
 419                 recv_time = RECV_TIME_NONE;
 420
 421                 if (sscanf(buf, "%s\t%ld\t%s", uidl, (long int *) &recv_time,
 422                            tmp) < 2) {
 423                         if (sscanf(buf, "%s", uidl) != 1)
 424                                 continue;
 425                         else {
 426                                 recv_time = now;
 427                         }
 428                 }
 429                 if (!strcmp(muidl, uidl)) {
 430                         result = g_strdup(tmp);
 431                         break;
 432                 }
 433         }
 434
 435         claws_fclose(fp);
 436
 437         return result;
 438 }