src/plugins/rssyl/rssyl_add_item.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  * - DESCRIPTION HERE
   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 <errno.h>
  29 #include <glib.h>
  30 #include <glib/gi18n.h>
  31 #include <string.h>
  32
  33 /* Claws Mail includes */
  34 #include <codeconv.h>
  35 #include <procmsg.h>
  36 #include <common/utils.h>
  37
  38 /* Local includes */
  39 #include "libfeed/date.h"
  40 #include "libfeed/feeditem.h"
  41 #include "parse822.h"
  42 #include "rssyl.h"
  43 #include "rssyl_deleted.h"
  44 #include "rssyl_feed.h"
  45 #include "rssyl_parse_feed.h"
  46 #include "strutils.h"
  47
  48 /* rssyl_cb_feed_compare()
  49  *
  50  * GCompareFunc function called by glib2's g_slist_find_custom().
  51  */
  52
  53 static gint rssyl_cb_feed_compare(const FeedItem *a, const FeedItem *b)
  54 {
  55         gboolean date_eq = FALSE, url_eq = FALSE, title_eq = FALSE;
  56         gboolean no_url = FALSE, no_date = FALSE, no_title = FALSE;
  57         gchar *atit = NULL, *btit = NULL;
  58
  59         g_return_val_if_fail(a != NULL && b != NULL, 1);
  60
  61         /* ID should be unique. If it matches, we've found what we came for. */
  62         if( (a->id != NULL) && (b->id != NULL) ) {
  63                         if( !strcmp(a->id, b->id) ) {
  64                                 return 0;
  65                         }
  66
  67                         /* If both IDs are present, but they do not match, these are not the
  68                          * droids we're looking for. */
  69                         return 1;
  70         }
  71
  72         /* Ok, we have no ID to aid us. Let's have a look at item timestamps
  73          * and item title & url. */
  74         if( (a->url != NULL) && (b->url != NULL) ) {
  75                 if( !strcmp(a->url, b->url) )
  76                         url_eq = TRUE;
  77         } else
  78                 no_url = TRUE;
  79
  80         if( (a->title != NULL) && (b->title != NULL) ) {
  81                 atit = conv_unmime_header(a->title, CS_UTF_8, FALSE);
  82                 btit = conv_unmime_header(b->title, CS_UTF_8, FALSE);
  83                 if( !strcmp(atit, btit) )
  84                         title_eq = TRUE;
  85                 g_free(atit);
  86                 g_free(btit);
  87         } else
  88                 no_title = TRUE;
  89
  90         /* If there's no 'published' timestamp for the item, we can only judge
  91          * by item url - 'modified' timestamp can have changed if the item was
  92          * updated recently. */
  93         if( b->date_published <= 0 ) {
  94                 if( b->date_modified > 0 ) {
  95                         /* If the item has 'modified' timestamp, we can only rely on url
  96                          * and title at this point. */
  97                         if( (url_eq || no_url) && title_eq
  98                                 && (a->date_modified >= b->date_modified) )
  99                                 return 0;
 100                         else
 101                                 return 1;
 102                 } else {
 103                         /* No timestamp of any kind, we'll just assume if both title and url
 104                          * match, we found the right item. Items in such feeds rarely change,
 105                          * and if they do, there's no way we can really */
 106                         if( (url_eq || no_url) && title_eq )
 107                                 return 0;
 108                         else
 109                                 return 1;
 110                 }
 111         }
 112
 113         /* Check if 'published' or at least 'modified' timestamps match */
 114         if( ((a->date_published > 0) && (b->date_published > 0) &&
 115                         (a->date_published == b->date_published))
 116                         || ((a->date_modified > 0) && (b->date_modified > 0) &&
 117                         (a->date_modified == b->date_modified))) {
 118                 date_eq = TRUE;
 119         } else
 120                 no_date = TRUE;
 121
 122         /* If 'published' time and item url match, it is reasonable to assume
 123          * we found our item. */
 124         if( (no_url || url_eq) && date_eq )
 125                 return 0;
 126
 127         /* There is no timestamp and the url matches (or there is none),
 128          * we need to compare titles, ... */
 129         if( (no_url || url_eq) && no_date ) {
 130                 if( title_eq )
 131                         return 0;
 132                 else
 133                         return 1;
 134         }
 135
 136         /* ... and as a last resort, if there is no title, item texts. */
 137         if( no_title && a->text && b->text ) {
 138                 if( !strcmp(a->text, b->text) )
 139                         return 0;
 140                 else
 141                         return 1;
 142         }
 143
 144         /* We don't know this item. */
 145         return 1;
 146 }
 147
 148 enum {
 149         ITEM_UNCHANGED,
 150         ITEM_CHANGED_TEXTONLY,
 151         ITEM_CHANGED
 152 };
 153
 154 static gint rssyl_feed_item_changed(FeedItem *new_item, FeedItem *old_item )
 155 {
 156         debug_print("RSSyl: comparing '%s' and '%s'\n",
 157                         new_item->title, old_item->title);
 158
 159         /* if both have title ... */
 160         if( old_item->title && new_item->title ) {
 161                 gchar *old = conv_unmime_header(old_item->title, CS_UTF_8, FALSE);
 162                 gchar *new = conv_unmime_header(new_item->title, CS_UTF_8, FALSE);
 163                 if( strcmp(old, new) != 0 ) { /* ... compare "unmimed" titles */
 164                         debug_print("RSSyl:\t\titem titles differ:\nOLD: '%s'\nNEW: '%s'\n",
 165                                         old, new);
 166                         g_free(old);
 167                         g_free(new);
 168                         return ITEM_CHANGED;
 169                 }
 170                 g_free(old);
 171                 g_free(new);
 172         } else {
 173                 /* if atleast one has a title, they differ */
 174                 if( old_item->title || new_item->title ) {
 175                         debug_print("RSSyl:\t\t+/- title\n");
 176                         return ITEM_CHANGED;
 177                 }
 178         }
 179
 180         if( old_item->author && new_item->author ) {
 181                 gchar *old = conv_unmime_header(old_item->author, CS_UTF_8, TRUE);
 182                 gchar *new = conv_unmime_header(new_item->author, CS_UTF_8, TRUE);
 183                 if( strcmp(old, new) ) {  /* ... compare "unmimed" authors */
 184                         g_free(old);
 185                         g_free(new);
 186                         debug_print("RSSyl:\t\titem authors differ\n");
 187                         return ITEM_CHANGED;
 188                 }
 189                 g_free(old);
 190                 g_free(new);
 191         } else {
 192                 /* if atleast one has author, they differ */
 193                 if( old_item->author || new_item->author ) {
 194                         debug_print("RSSyl:\t\t+/- author\n");
 195                         return ITEM_CHANGED;
 196                 }
 197         }
 198
 199         /* if both have text ... */
 200         if( old_item->text && new_item->text ) {
 201                 if( strcmp(old_item->text, new_item->text) ) { /* ... compare them */
 202                         debug_print("RSSyl:\t\titem texts differ\n");
 203                         debug_print("\nOLD: '%s'\n", old_item->text);
 204                         debug_print("\nNEW: '%s'\n", new_item->text);
 205
 206                         return ITEM_CHANGED_TEXTONLY;
 207                 }
 208         } else {
 209                 /* if at least one has some text, they differ */
 210                 if( old_item->text || new_item->text ) {
 211                         debug_print("RSSyl:\t\t+/- text\n");
 212                         return ITEM_CHANGED_TEXTONLY;
 213                 }
 214         }
 215
 216         /* they don't seem to differ */
 217         return ITEM_UNCHANGED;
 218 }
 219
 220 enum {
 221         EXISTS_NEW,
 222         EXISTS_UNCHANGED,
 223         EXISTS_CHANGED,
 224         EXISTS_CHANGED_TEXTONLY
 225 };
 226
 227 /* rssyl_feed_item_exists()
 228  *
 229  * Returns 1 if a feed item already exists locally, 2 if there's a changed
 230  * item with link that already belongs to existing item, 3 if only item's
 231  * text has changed, 0 if item is new.
 232  */
 233
 234 static guint rssyl_feed_item_exists(RFolderItem *ritem, FeedItem *fitem,
 235                 FeedItem **oldfitem)
 236 {
 237         GSList *item = NULL;
 238         FeedItem *efitem = NULL;
 239         gint changed;
 240
 241         g_return_val_if_fail(ritem != NULL, FALSE);
 242         g_return_val_if_fail(fitem != NULL, FALSE);
 243
 244         if( ritem->items == NULL || g_slist_length(ritem->items) == 0 )
 245                 return EXISTS_NEW;
 246
 247         if( (item = g_slist_find_custom(ritem->items,
 248                                         (gconstpointer)fitem, (GCompareFunc)rssyl_cb_feed_compare)) ) {
 249                 efitem = (FeedItem *)item->data;
 250                 if( (changed = rssyl_feed_item_changed(fitem, efitem)) > ITEM_UNCHANGED ) {
 251                         *oldfitem = efitem;
 252                         if (changed == ITEM_CHANGED_TEXTONLY)
 253                                 return EXISTS_CHANGED_TEXTONLY;
 254                         else
 255                                 return EXISTS_CHANGED;
 256                 }
 257
 258                 return EXISTS_UNCHANGED;
 259         }
 260
 261         return EXISTS_NEW;
 262 }
 263
 264 /* =============================================================== */
 265
 266 void rssyl_add_item(RFolderItem *ritem, FeedItem *feed_item)
 267 {
 268         FeedItem *old_item = NULL;
 269         MsgFlags *flags;
 270         MsgPermFlags oldperm_flags = 0;
 271         MsgInfo *msginfo;
 272         FILE *f;
 273         gint fd, d, dif;
 274         time_t tmpd;
 275         gchar *meta_charset = NULL;
 276         gchar *baseurl = NULL;
 277         gchar *template = NULL;
 278         gchar *tmp = NULL, *tmpurl = NULL, *tmpid = NULL;
 279         gchar *dirname = NULL;
 280         gchar *text = NULL;
 281         gchar *heading = NULL;
 282         gchar hdr[1024];
 283         FeedItemEnclosure *enc = NULL;
 284         RFeedCtx *ctx;
 285
 286         g_return_if_fail(ritem != NULL);
 287
 288         /* If item title is empty, try to fill it from source title (Atom only). */
 289         tmp = feed_item_get_sourcetitle(feed_item);
 290         if( feed_item_get_title(feed_item) == NULL ||
 291                         strlen(feed_item->title) == 0 ) {
 292                 if( tmp != NULL && strlen(tmp) > 0 )
 293                         feed_item_set_title(feed_item, tmp);
 294                 else
 295                         feed_item_set_title(feed_item, C_("Empty RSS feed title placeholder", "(empty)"));
 296         }
 297
 298 /*
 299         if (feed_item_get_id(feed_item) == NULL) {
 300                 debug_print("RSSyl: item ID empty, using its URL as ID.\n");
 301                 feed_item_set_id(feed_item, feed_item_get_url(feed_item));
 302         }
 303 */
 304
 305         /* If neither item date is set, use date from source (Atom only). */
 306         if( feed_item_get_date_modified(feed_item) == -1 &&
 307                         feed_item_get_date_published(feed_item) == -1 )
 308                 feed_item_set_date_published(feed_item,
 309                                 feed_item_get_sourcedate(feed_item));
 310
 311         /* Fix up subject, url and ID (rssyl_format_string()) so that
 312          * comparing doesn't break. */
 313         debug_print("RSSyl: fixing up subject '%s'\n", feed_item_get_title(feed_item));
 314         feed_item_set_title(feed_item, rssyl_format_string(feed_item_get_title(feed_item), TRUE, TRUE));
 315         debug_print("RSSyl: fixing up URL\n");
 316         feed_item_set_url(feed_item, rssyl_format_string(feed_item_get_url(feed_item),
 317                                 TRUE, TRUE));
 318         if( feed_item_get_id(feed_item) != NULL ) {
 319                 debug_print("RSSyl: fixing up ID\n");
 320                 feed_item_set_id(feed_item, rssyl_format_string(feed_item_get_id(feed_item),
 321                                         TRUE, TRUE));
 322         }
 323
 324         /* If there's a summary, but no text, use summary as text. */
 325         if( feed_item_get_text(feed_item) == NULL &&
 326                         (tmp = feed_item_get_summary(feed_item)) != NULL ) {
 327                 feed_item_set_text(feed_item, tmp);
 328                 g_free(feed_item->summary);     /* We do not need summary in rssyl now. */
 329                 feed_item->summary = NULL;
 330         }
 331
 332         /* Do not add if the item already exists, update if it does exist, but
 333          * has changed. */
 334         dif = rssyl_feed_item_exists(ritem, feed_item, &old_item);
 335         debug_print("RSSyl: rssyl_feed_item_exists returned %d\n", dif);
 336
 337         if( dif == EXISTS_UNCHANGED ) {
 338                 debug_print("RSSyl: This item already exists, skipping...\n");
 339                 return;
 340         }
 341
 342         /* Item is already in the list, but has changed */
 343         if( dif >= EXISTS_CHANGED && old_item != NULL ) {
 344                 debug_print("RSSyl: Item changed, removing old one and adding new.\n");
 345
 346                 /* Store permflags of the old item. */
 347                 ctx = (RFeedCtx *)old_item->data;
 348                 msginfo = folder_item_get_msginfo((FolderItem *)ritem,
 349                                 atoi(g_path_get_basename(ctx->path)));
 350                 oldperm_flags = msginfo->flags.perm_flags;
 351
 352                 ritem->items = g_slist_remove(ritem->items, old_item);
 353                 if (g_unlink(ctx->path) != 0) {
 354                         debug_print("RSSyl: Error, could not delete file '%s': %s\n",
 355                                         ctx->path, g_strerror(errno));
 356                 }
 357
 358                 g_free(ctx->path);
 359                 feed_item_free(old_item);
 360                 old_item = NULL;
 361         }
 362
 363         /* Check against list of deleted items. */
 364         if (rssyl_deleted_check(ritem->deleted_items, feed_item)) {
 365                 debug_print("RSSyl: Item '%s' found among deleted items, NOT adding it.\n",
 366                                 feed_item_get_title(feed_item));
 367                 return;
 368         }
 369
 370         /* Add a new item, formatting its title along the way */
 371         debug_print("RSSyl: Adding item '%s'\n", feed_item_get_title(feed_item));
 372         ritem->items = g_slist_prepend(ritem->items, feed_item_copy(feed_item));
 373
 374         dirname = folder_item_get_path(&ritem->item);
 375         template = g_strconcat(dirname, G_DIR_SEPARATOR_S,
 376                         RSSYL_TMP_TEMPLATE, NULL);
 377         if ((fd = mkstemp(template)) < 0) {
 378                 g_warning("Couldn't mkstemp('%s'), not adding message!\n", template);
 379                 g_free(template);
 380                 return;
 381         }
 382
 383         f = fdopen(fd, "w");
 384         if (f == NULL) {
 385                 g_warning("Couldn't open file '%s', not adding message!\n", template);
 386                 g_free(template);
 387                 return;
 388         }
 389
 390         /* From */
 391         if( (tmp = feed_item_get_author(feed_item)) != NULL ) {
 392                 if( g_utf8_validate(tmp, -1, NULL)) {
 393                         conv_encode_header_full(hdr, 1023, tmp, strlen("From: "),
 394                                         TRUE, CS_UTF_8);
 395                         fprintf(f, "From: %s\n", hdr);
 396                 } else
 397                         fprintf(f, "From: %s\n", tmp);
 398         }
 399
 400         /* Date */
 401         if( (tmpd = feed_item_get_date_modified(feed_item)) != -1 ) {
 402                 tmp = createRFC822Date(&tmpd);
 403                 debug_print("RSSyl: using date_modified: '%s'\n", tmp);
 404         } else if( (tmpd = feed_item_get_date_published(feed_item)) != -1 ) {
 405                 tmp = createRFC822Date(&tmpd);
 406                 debug_print("RSSyl: using date_published: '%s'\n", tmp);
 407         } else {
 408                 tmpd = time(NULL);
 409                 tmp = createRFC822Date(&tmpd);
 410         }
 411
 412         if( tmp != NULL ) {
 413                 fprintf(f, "Date: %s\n", tmp);
 414                 g_free(tmp);
 415         }
 416
 417         if( (tmp = feed_item_get_title(feed_item)) != NULL ) {
 418
 419                 /* (Atom only) Strip HTML markup from title for the Subject line. */
 420                 if( feed_item_get_title_format(feed_item) == FEED_ITEM_TITLE_HTML
 421                                 || feed_item_get_title_format(feed_item) == FEED_ITEM_TITLE_XHTML) {
 422                         debug_print("RSSyl: item title is HTML/XHTML, stripping tags for Subject line\n");
 423                         tmp = g_strdup(tmp);
 424                         strip_html(tmp);
 425                 }
 426
 427                 if( g_utf8_validate(tmp, -1, NULL) ) {
 428                         conv_encode_header_full(hdr, 1023, tmp, strlen("Subject: "),
 429                                         FALSE, CS_UTF_8);
 430                         debug_print("RSSyl: Subject: %s\n", hdr);
 431                         fprintf(f, "Subject: %s\n", hdr);
 432                 } else
 433                         fprintf(f, "Subject: %s\n", tmp);
 434
 435                 if( feed_item_get_title_format(feed_item) == FEED_ITEM_TITLE_HTML
 436                                 || feed_item_get_title_format(feed_item) == FEED_ITEM_TITLE_XHTML) {
 437                         g_free(tmp);
 438                         fprintf(f, "X-RSSyl-OrigTitle: %s\n", feed_item_get_title(feed_item));
 439                 }
 440         } else {
 441                 debug_print("RSSyl: No feed title, it seems\n");
 442                 fprintf(f, "Subject: (empty)\n");
 443         }
 444
 445         /* X-RSSyl-URL */
 446         if( (tmpurl = feed_item_get_url(feed_item)) == NULL ) {
 447                 if( feed_item_get_id(feed_item) != NULL &&
 448                                 feed_item_id_is_permalink(feed_item) ) {
 449                         tmpurl = feed_item_get_id(feed_item);
 450                 }
 451         }
 452
 453         if( tmpurl != NULL )
 454                 fprintf(f, "X-RSSyl-URL: %s\n", tmpurl);
 455
 456         if( ritem->last_update > 0) {
 457                 fprintf(f, "X-RSSyl-Last-Seen: %ld\n", ritem->last_update);
 458         }
 459
 460         /* Message-ID */
 461         if( (tmpid = feed_item_get_id(feed_item)) == NULL )
 462                 tmpid = feed_item_get_url(feed_item);
 463         if( tmpid != NULL )
 464                 fprintf(f, "Message-ID: <%s>\n", tmpid);
 465
 466         /* X-RSSyl-Comments */
 467         if( (text = feed_item_get_comments_url(feed_item)) != NULL )
 468                 fprintf(f, "X-RSSyl-Comments: %s\n", text);
 469
 470         /* References */
 471         if( (text = feed_item_get_parent_id(feed_item)) != NULL )
 472                 fprintf(f, "References: <%s>\n", text);
 473
 474         /* Content-Type */
 475         text = feed_item_get_text(feed_item);
 476         if( text && g_utf8_validate(text, -1, NULL) ) {
 477                 fprintf(f, "Content-Type: text/html; charset=UTF-8\n\n");
 478                 meta_charset = g_strdup("<meta http-equiv=\"Content-Type\" "
 479                                 "content=\"text/html; charset=UTF-8\">");
 480         } else {
 481                 fprintf(f, "Content-Type: text/html\n\n");
 482         }
 483
 484         /* construct base href */
 485         if( feed_item_get_url(feed_item) != NULL )
 486                 baseurl = g_strdup_printf("<base href=\"%s\">\n",
 487                         feed_item_get_url(feed_item) );
 488
 489         if( ritem->write_heading )
 490                 heading = g_strdup_printf("<h2>%s</h2>\n<br><br>\n",
 491                                 feed_item_get_title(feed_item));
 492
 493         /* Message body */
 494         fprintf(f, "<html><head>"
 495                         "%s\n"
 496                         "%s"
 497                         "</head>\n<body>\n"
 498                         "%s\n"
 499                         "URL: <a href=\"%s\">%s</a>\n\n<br><br>\n"
 500                         RSSYL_TEXT_START"\n"
 501                         "%s%s"
 502                         RSSYL_TEXT_END"\n\n",
 503                         (meta_charset ? meta_charset : ""),
 504                         (baseurl ? baseurl : ""),
 505                         (heading ? heading : ""),
 506                         (tmpurl ? tmpurl : ""),
 507                         (tmpurl ? tmpurl : "n/a"),
 508                         (text ? text : ""), (text ? "\n" : "") );
 509
 510         g_free(meta_charset);
 511         g_free(baseurl);
 512         g_free(heading);
 513
 514         if( (enc = feed_item_get_enclosure(feed_item)) != NULL )
 515                 fprintf(f, "<p><a href=\"%s\">Attached media file</a> [%s] (%ld bytes)</p>\n",
 516                                 feed_item_enclosure_get_url(enc),
 517                                 feed_item_enclosure_get_type(enc),
 518                                 feed_item_enclosure_get_size(enc) );
 519
 520         fprintf(f, "</body></html>\n");
 521         fclose(f);
 522
 523         g_return_if_fail(template != NULL);
 524
 525         flags = g_new(MsgFlags, 1);
 526         flags->perm_flags = MSG_NEW | MSG_UNREAD;
 527         flags->tmp_flags = 0;
 528
 529         d = folder_item_add_msg(&ritem->item, template, flags, TRUE);
 530         g_free(template);
 531
 532         ctx = g_new0(RFeedCtx, 1);
 533         ctx->path = (gpointer)g_strdup_printf("%s%c%d", dirname,
 534                         G_DIR_SEPARATOR, d);
 535         ctx->last_seen = ritem->last_update;
 536         ((FeedItem *)ritem->items->data)->data = (gpointer)ctx;
 537
 538         /* Unset unread+new if the changed item wasn't set unread and user
 539          * doesn't want to see it unread because of the change. */
 540         if (!(oldperm_flags & MSG_UNREAD) && (ritem->silent_update == 2
 541                         || (ritem->silent_update == 1 && dif == EXISTS_CHANGED_TEXTONLY)))
 542                 procmsg_msginfo_unset_flags(
 543                                 folder_item_get_msginfo((FolderItem *)ritem, d), MSG_NEW | MSG_UNREAD, 0);
 544
 545         debug_print("RSSyl: folder_item_add_msg(): %d\n", d);
 546 }