src/plugins/rssyl/rssyl_deleted.c

   1 /*
   2  * Claws-Mail-- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2004 Hiroyuki Yamamoto
   4  * This file (C) 2005 Andrej Kacian <andrej@kacian.sk>
   5  *
   6  * - handling of info about user-deleted feed items
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 /* Global includes */
  28 #include <glib.h>
  29 #include <string.h>
  30
  31 /* Claws Mail includes */
  32 #include <codeconv.h>
  33 #include <common/utils.h>
  34
  35 /* Local includes */
  36 #include "rssyl.h"
  37 #include "parse822.h"
  38 #include "strutils.h"
  39
  40 static RDeletedItem *_new_deleted_item()
  41 {
  42         RDeletedItem *ditem = g_new0(RDeletedItem, 1);
  43
  44         ditem->id = NULL;
  45         ditem->title = NULL;
  46         ditem->date_published = -1;
  47         ditem->date_modified = -1;
  48
  49         return ditem;
  50 }
  51
  52 static void _free_deleted_item(gpointer d, gpointer user_data)
  53 {
  54         RDeletedItem *ditem = (RDeletedItem *)d;
  55
  56         if (ditem == NULL)
  57                 return;
  58
  59         g_free(ditem->id);
  60         g_free(ditem->title);
  61         g_free(ditem);
  62 }
  63
  64 void rssyl_deleted_free(GSList *deleted_items)
  65 {
  66         if (deleted_items != NULL) {
  67                 debug_print("RSSyl: releasing list of deleted items\n");
  68                 g_slist_foreach(deleted_items, _free_deleted_item, NULL);
  69                 g_slist_free(deleted_items);
  70                 deleted_items = NULL;
  71         }
  72 }
  73
  74 static gchar * _deleted_file_path(RFolderItem *ritem)
  75 {
  76         gchar *itempath, *deleted_file;
  77
  78         itempath = folder_item_get_path(&ritem->item);
  79         deleted_file = g_strconcat(itempath, G_DIR_SEPARATOR_S, RSSYL_DELETED_FILE, NULL);
  80         g_free(itempath);
  81
  82         return deleted_file;
  83 }
  84
  85 /***************************************************************/
  86 GSList *rssyl_deleted_update(RFolderItem *ritem)
  87 {
  88         gchar *deleted_file, *contents, **lines, **line;
  89         GError *error = NULL;
  90         guint i = 0;
  91         RDeletedItem *ditem = NULL;
  92         GSList *deleted_items = NULL;
  93
  94         g_return_val_if_fail(ritem != NULL, NULL);
  95
  96         deleted_file = _deleted_file_path(ritem);
  97
  98         debug_print("RSSyl: getting list of deleted items from '%s'\n", deleted_file);
  99
 100         if (!g_file_test(deleted_file, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR)) {
 101                 debug_print("RSSyl: '%s' doesn't exist, ignoring\n", deleted_file);
 102                 g_free(deleted_file);
 103                 return NULL;
 104         }
 105
 106         g_file_get_contents(deleted_file, &contents, NULL, &error);
 107
 108         if (error) {
 109                 g_warning("GError: '%s'\n", error->message);
 110                 g_error_free(error);
 111         }
 112
 113         if (contents != NULL) {
 114                 lines = strsplit_no_copy(contents, '\n');
 115         } else {
 116                 g_warning("Couldn't read '%s', ignoring\n", deleted_file);
 117                 g_free(deleted_file);
 118                 return NULL;
 119         }
 120
 121         g_free(deleted_file);
 122
 123         while (lines[i]) {
 124                 line = g_strsplit(lines[i], ": ", 2);
 125                 if (line[0] && line[1] && strlen(line[0]) && strlen(line[1])) {
 126                         if (!strcmp(line[0], "ID")) {
 127                                 ditem = _new_deleted_item();
 128                                 ditem->id = g_strdup(line[1]);
 129                         } else if (ditem != NULL && !strcmp(line[0], "TITLE")) {
 130                                 ditem->title = g_strdup(line[1]);
 131                         } else if (ditem != NULL && !strcmp(line[0], "DPUB")) {
 132                                 ditem->date_published = atoi(line[1]);
 133                         } else if (ditem != NULL && !strcmp(line[0], "DMOD")) {
 134                                 ditem->date_modified = atoi(line[1]);
 135                                 deleted_items = g_slist_prepend(deleted_items, ditem);
 136                                 ditem = NULL;
 137                         }
 138                 }
 139
 140                 g_strfreev(line);
 141                 i++;
 142         }
 143
 144         g_free(lines);
 145         g_free(contents);
 146
 147         debug_print("RSSyl: got %d deleted items\n", g_slist_length(deleted_items));
 148         return deleted_items;
 149 }
 150
 151 static void _store_one_deleted_item(gpointer data, gpointer user_data)
 152 {
 153         RDeletedItem *ditem = (RDeletedItem *)data;
 154         FILE *f = (FILE *)user_data;
 155         gboolean err = FALSE;
 156
 157         if (ditem == NULL || ditem->id == NULL)
 158                 return;
 159
 160         err |= (fprintf(f,
 161                         "ID: %s\n"
 162                         "TITLE: %s\n"
 163                         "DPUB: %ld\n"
 164                         "DMOD: %ld\n",
 165                         ditem->id, ditem->title,
 166                         ditem->date_published, ditem->date_modified) < 0);
 167
 168         if (err)
 169                 debug_print("RSSyl: Error during writing deletion file.\n");
 170 }
 171
 172 static void rssyl_deleted_store_internal(GSList *deleted_items, const gchar *deleted_file)
 173 {
 174         FILE *f;
 175
 176         if (g_file_test(deleted_file, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR)) {
 177                 if (g_remove(deleted_file) != 0) {
 178                         debug_print("RSSyl: Oops, couldn't delete '%s', bailing out\n",
 179                                         deleted_file);
 180                         return;
 181                 }
 182         }
 183
 184         if (g_slist_length(deleted_items) == 0)
 185                 return;
 186
 187         if ((f = g_fopen(deleted_file, "w")) == NULL) {
 188                 debug_print("RSSyl: Couldn't open '%s', bailing out.\n", deleted_file);
 189                 return;
 190         }
 191
 192         g_slist_foreach(deleted_items, (GFunc)_store_one_deleted_item,
 193                         (gpointer)f);
 194
 195         fclose(f);
 196         debug_print("RSSyl: written and closed deletion file\n");
 197 }
 198
 199 void rssyl_deleted_store(RFolderItem *ritem)
 200 {
 201         gchar *path;
 202
 203         g_return_if_fail(ritem != NULL);
 204
 205         path = _deleted_file_path(ritem);
 206         rssyl_deleted_store_internal(ritem->deleted_items, path);
 207         g_free(path);
 208 }
 209
 210
 211 /* Creates a FeedItem from a message file and uses the data to add a item
 212  * to the list of deleted stuff. */
 213 void rssyl_deleted_add(RFolderItem *ritem, gchar *path)
 214 {
 215         FeedItem *fitem = NULL;
 216         RDeletedItem *ditem = NULL;
 217         GSList *deleted_items = rssyl_deleted_update(ritem);
 218         gchar *deleted_file = NULL;
 219
 220         if (!(fitem = rssyl_parse_folder_item_file(path)))
 221                 return;
 222
 223         ditem = _new_deleted_item();
 224         ditem->id = g_strdup(feed_item_get_id(fitem));
 225         ditem->title = conv_unmime_header(feed_item_get_title(fitem),
 226                         CS_UTF_8, FALSE);
 227         ditem->date_published = feed_item_get_date_published(fitem);
 228         ditem->date_modified = feed_item_get_date_modified(fitem);
 229
 230         deleted_items = g_slist_prepend(deleted_items, ditem);
 231
 232         deleted_file = _deleted_file_path(ritem);
 233         rssyl_deleted_store_internal(deleted_items, deleted_file);
 234         g_free(deleted_file);
 235
 236         rssyl_deleted_free(deleted_items);
 237         feed_item_free(fitem);
 238 }
 239
 240 static gint _rssyl_deleted_check_func(gconstpointer a, gconstpointer b)
 241 {
 242         RDeletedItem *ditem = (RDeletedItem *)a;
 243         FeedItem *fitem = (FeedItem *)b;
 244
 245         g_return_val_if_fail(ditem != NULL, -10);
 246         g_return_val_if_fail(fitem != NULL, -20);
 247
 248         /* Following must match:
 249          * ID, ... */
 250         if (!ditem->id || !feed_item_get_id(fitem) ||
 251                         strcmp(ditem->id, feed_item_get_id(fitem)))
 252                 return -1;
 253
 254         /* title, ... */
 255         if (!ditem->title || !feed_item_get_title(fitem) ||
 256                         strcmp(ditem->title, feed_item_get_title(fitem)))
 257                 return -2;
 258
 259         /* time of publishing, ... */
 260         if (ditem->date_published != -1 &&
 261                         ditem->date_published != feed_item_get_date_published(fitem))
 262                 return -3;
 263
 264         /* and the time of last modification must be greater
 265          * (this means that the item was updated since deletion, and possibly
 266          * contains new data, so we add it again) */
 267         if (ditem->date_modified != -1 &&
 268                         ditem->date_modified < feed_item_get_date_modified(fitem))
 269                 return -4;
 270
 271         return 0;
 272 }
 273
 274 /* Returns TRUE if fitem is found among the deleted stuff. */
 275 gboolean rssyl_deleted_check(GSList *deleted_items, FeedItem *fitem)
 276 {
 277         if (g_slist_find_custom(deleted_items, (gconstpointer)fitem,
 278                                 _rssyl_deleted_check_func) != NULL)
 279                 return TRUE;
 280
 281         return FALSE;
 282 }
 283
 284 /******** Expiring ********/
 285 struct _RDelExpireCtx {
 286         RDeletedItem *ditem;
 287         gboolean delete;
 288 };
 289
 290 typedef struct _RDelExpireCtx RDelExpireCtx;
 291
 292 static void _rssyl_deleted_expire_func_f(gpointer data, gpointer user_data)
 293 {
 294         FeedItem *fitem = (FeedItem *)data;
 295         RDelExpireCtx *ctx = (RDelExpireCtx *)user_data;
 296
 297         /* Following must match:
 298          * ID, ... */
 299         if (!ctx->ditem->id || !feed_item_get_id(fitem) ||
 300                         strcmp(ctx->ditem->id, feed_item_get_id(fitem)))
 301                 return;
 302
 303         /* title, ... */
 304         if (!ctx->ditem->title || !feed_item_get_title(fitem) ||
 305                         strcmp(ctx->ditem->title, feed_item_get_title(fitem)))
 306                 return;
 307
 308         /* time of publishing, ... */
 309         if (ctx->ditem->date_published != feed_item_get_date_published(fitem))
 310                 return;
 311
 312         /* and the time of last modification must be greater
 313          * (this means that the item was updated since deletion, and possibly
 314          * contains new data, so we add it again) */
 315         if (ctx->ditem->date_modified != feed_item_get_date_modified(fitem))
 316                 return;
 317
 318         ctx->delete = FALSE;
 319 }
 320
 321 /* Checks each item in deleted items list against feed and removes it if
 322  * it is not found there anymore. */
 323 void rssyl_deleted_expire(RFolderItem *ritem, Feed *feed)
 324 {
 325         GSList *d = NULL, *d2;
 326         RDelExpireCtx *ctx = NULL;
 327         RDeletedItem *ditem;
 328
 329         g_return_if_fail(ritem != NULL);
 330         g_return_if_fail(feed != NULL);
 331
 332         ritem->deleted_items = rssyl_deleted_update(ritem);
 333
 334         /* Iterate over all items in the list */
 335         d = ritem->deleted_items;
 336         while (d) {
 337                 ditem = (RDeletedItem *)d->data;
 338                 ctx = g_new0(RDelExpireCtx, 1);
 339                 ctx->ditem = ditem;
 340                 ctx->delete = TRUE;
 341
 342                 /* Adjust ctx->delete accordingly */
 343                 feed_foreach_item(feed, _rssyl_deleted_expire_func_f, (gpointer)ctx);
 344
 345                 /* Remove the item if necessary */
 346                 if (ctx->delete) {
 347                         debug_print("RSSyl: (DELETED) removing '%s' from list\n", ditem->title);
 348                         d2 = d->next;
 349                         ritem->deleted_items = g_slist_remove_link(ritem->deleted_items, d);
 350                         d = d2;
 351                         continue;
 352                 } else {
 353                         d = d->next;
 354                 }
 355
 356                 g_free(ctx);
 357         }
 358
 359         /* Write the new list to disk */
 360         rssyl_deleted_store(ritem);
 361
 362         /* And clean up after myself */
 363         rssyl_deleted_free(ritem->deleted_items);
 364 }