src/plugins/rssyl/rssyl_update_feed.c

   1 /*
   2  * Copyright (C) 2006 Andrej Kacian <andrej@kacian.sk>
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public
  15  * License along with this program; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include "config.h"
  22 #endif
  23
  24 /* Global includes */
  25 #include <glib.h>
  26 #include <glib/gi18n.h>
  27 #include <pthread.h>
  28
  29 /* Claws Mail includes */
  30 #include <common/claws.h>
  31 #include <mainwindow.h>
  32 #include <statusbar.h>
  33 #include <alertpanel.h>
  34 #include <log.h>
  35 #include <prefs_common.h>
  36 #include <inc.h>
  37 #include <main.h>
  38
  39 /* Local includes */
  40 #include "libfeed/feed.h"
  41 #include "rssyl.h"
  42 #include "rssyl_deleted.h"
  43 #include "rssyl_feed.h"
  44 #include "rssyl_parse_feed.h"
  45 #include "rssyl_prefs.h"
  46 #include "rssyl_update_comments.h"
  47
  48 /* rssyl_fetch_feed_thr() */
  49
  50 static void *rssyl_fetch_feed_thr(void *arg)
  51 {
  52         RFetchCtx *ctx = (RFetchCtx *)arg;
  53
  54         /* Fetch and parse the feed. */
  55         ctx->response_code = feed_update(ctx->feed, -1);
  56
  57         /* Signal main thread that we're done here. */
  58         ctx->ready = TRUE;
  59
  60         return NULL;
  61 }
  62
  63 /* rssyl_fetch_feed() */
  64 void rssyl_fetch_feed(RFetchCtx *ctx, gboolean verbose)
  65 {
  66 #ifdef USE_PTHREAD
  67         pthread_t pt;
  68 #endif
  69
  70         g_return_if_fail(ctx != NULL);
  71
  72 #ifdef USE_PTHREAD
  73         if( pthread_create(&pt, PTHREAD_CREATE_JOINABLE, rssyl_fetch_feed_thr,
  74                                 (void *)ctx) != 0 ) {
  75                 /* Bummer, couldn't create thread. Continue non-threaded. */
  76                 rssyl_fetch_feed_thr(ctx);
  77         } else {
  78                 /* Thread created, let's wait until it finishes. */
  79                 debug_print("RSSyl: waiting for thread to finish (timeout: %ds)\n",
  80                                 feed_get_timeout(ctx->feed));
  81                 while( !ctx->ready ) {
  82                         claws_do_idle();
  83                 }
  84
  85                 debug_print("RSSyl: thread finished\n");
  86                 pthread_join(pt, NULL);
  87         }
  88 #else
  89         debug_print("RSSyl: no pthreads available, running non-threaded fetch\n");
  90         rssyl_fetch_feed_thr(ctx);
  91 #endif
  92
  93         if( ctx->response_code == FEED_ERR_INIT ) {
  94                 debug_print("RSSyl: libfeed reports init error from libcurl\n");
  95                 ctx->error = g_strdup("Internal error");
  96         } else if( ctx->response_code == FEED_ERR_FETCH ) {
  97                 debug_print("RSSyl: libfeed reports some other error from libcurl\n");
  98                 ctx->error = g_strdup(ctx->feed->fetcherr);
  99         } else if( ctx->response_code == FEED_ERR_UNAUTH ) {
 100                 debug_print("RSSyl: URL authorization type is unknown\n");
 101                 ctx->error = g_strdup("Unknown value for URL authorization type");
 102         } else if( ctx->response_code >= 400 && ctx->response_code < 500 ) {
 103                 switch( ctx->response_code ) {
 104                         case 401:
 105                                 ctx->error = g_strdup(_("401 (Authorisation required)"));
 106                                 break;
 107                         case 403:
 108                                 ctx->error = g_strdup(_("403 (Unauthorised)"));
 109                                 break;
 110                         case 404:
 111                                 ctx->error = g_strdup(_("404 (Not found)"));
 112                                 break;
 113                         default:
 114                                 ctx->error = g_strdup_printf(_("Error %d"), ctx->response_code);
 115                                 break;
 116                 }
 117         }
 118
 119         /* Here we handle "imperfect" conditions. If verbose is TRUE, we also
 120          * display error dialogs for user. We always log the error. */
 121         if( ctx->error != NULL ) {
 122                 /* libcurl wasn't happy */
 123                 debug_print("RSSyl: Error: %s\n", ctx->error);
 124                 if( verbose ) {
 125                         gchar *msg = g_markup_printf_escaped(
 126                                         (const char *) C_("First parameter is URL, second is error text",
 127                                                 "Error fetching feed at\n<b>%s</b>:\n\n%s"),
 128                                         feed_get_url(ctx->feed), ctx->error);
 129                         alertpanel_error("%s", msg);
 130                         g_free(msg);
 131                 }
 132
 133                 log_error(LOG_PROTOCOL, RSSYL_LOG_ERROR_FETCH, ctx->feed->url, ctx->error);
 134
 135                 ctx->success = FALSE;
 136         } else {
 137                 if( ctx->feed == NULL ) {
 138                         if( verbose ) {
 139                                 gchar *msg = g_markup_printf_escaped(
 140                                                 (const char *) _("No valid feed found at\n<b>%s</b>"),
 141                                                 feed_get_url(ctx->feed));
 142                                 alertpanel_error("%s", msg);
 143                                 g_free(msg);
 144                         }
 145
 146                         log_error(LOG_PROTOCOL, RSSYL_LOG_ERROR_NOFEED,
 147                                         feed_get_url(ctx->feed));
 148
 149                         ctx->success = FALSE;
 150                 } else if (feed_get_title(ctx->feed) == NULL) {
 151                         /* We shouldn't do this, since a title is mandatory. */
 152                         feed_set_title(ctx->feed, _("Untitled feed"));
 153                         log_print(LOG_PROTOCOL, _("Possibly invalid feed without title at %s.\n"),
 154                                                 feed_get_url(ctx->feed));
 155                 }
 156         }
 157 }
 158
 159 RFetchCtx *rssyl_prep_fetchctx_from_item(RFolderItem *ritem)
 160 {
 161         RFetchCtx *ctx = NULL;
 162
 163         g_return_val_if_fail(ritem != NULL, NULL);
 164
 165         ctx = g_new0(RFetchCtx, 1);
 166         ctx->feed = feed_new(ritem->url);
 167         ctx->error = NULL;
 168         ctx->success = TRUE;
 169         ctx->ready = FALSE;
 170
 171         feed_set_timeout(ctx->feed, prefs_common_get_prefs()->io_timeout_secs);
 172         feed_set_cookies_path(ctx->feed, rssyl_prefs_get()->cookies_path);
 173         feed_set_ssl_verify_peer(ctx->feed, ritem->ssl_verify_peer);
 174         feed_set_auth(ctx->feed, ritem->auth);
 175 #ifdef G_OS_WIN32
 176         if (!g_ascii_strncasecmp(ritem->url, "https", 5)) {
 177                 feed_set_cacert_file(ctx->feed, claws_ssl_get_cert_file());
 178                 debug_print("RSSyl: using cert file '%s'\n", feed_get_cacert_file(ctx->feed));
 179         }
 180 #endif
 181
 182         return ctx;
 183 }
 184
 185 RFetchCtx *rssyl_prep_fetchctx_from_url(gchar *url)
 186 {
 187         RFetchCtx *ctx = NULL;
 188
 189         g_return_val_if_fail(url != NULL, NULL);
 190
 191         ctx = g_new0(RFetchCtx, 1);
 192         ctx->feed = feed_new(url);
 193         ctx->error = NULL;
 194         ctx->success = TRUE;
 195         ctx->ready = FALSE;
 196
 197         feed_set_timeout(ctx->feed, prefs_common_get_prefs()->io_timeout_secs);
 198         feed_set_cookies_path(ctx->feed, rssyl_prefs_get()->cookies_path);
 199         feed_set_ssl_verify_peer(ctx->feed, rssyl_prefs_get()->ssl_verify_peer);
 200 #ifdef G_OS_WIN32
 201         if (!g_ascii_strncasecmp(url, "https", 5)) {
 202                 feed_set_cacert_file(ctx->feed, claws_ssl_get_cert_file());
 203                 debug_print("RSSyl: using cert file '%s'\n", feed_get_cacert_file(ctx->feed));
 204         }
 205 #endif
 206
 207         return ctx;
 208 }
 209
 210 /* rssyl_update_feed() */
 211
 212 gboolean rssyl_update_feed(RFolderItem *ritem, gboolean verbose)
 213 {
 214         RFetchCtx *ctx = NULL;
 215         MainWindow *mainwin = mainwindow_get_mainwindow();
 216         gchar *msg = NULL;
 217         gboolean success = FALSE;
 218
 219         g_return_val_if_fail(ritem != NULL, FALSE);
 220         g_return_val_if_fail(ritem->url != NULL, FALSE);
 221
 222         debug_print("RSSyl: starting to update '%s' (%s)\n",
 223                         ritem->item.name, ritem->url);
 224
 225         log_print(LOG_PROTOCOL, RSSYL_LOG_UPDATING, ritem->url);
 226
 227         msg = g_strdup_printf(_("Updating feed '%s'..."), ritem->item.name);
 228         STATUSBAR_PUSH(mainwin, msg);
 229         g_free(msg);
 230
 231         GTK_EVENTS_FLUSH();
 232
 233         /* Prepare context for fetching the feed file */
 234         ctx = rssyl_prep_fetchctx_from_item(ritem);
 235         g_return_val_if_fail(ctx != NULL, FALSE);
 236
 237         /* Fetch the feed file */
 238         rssyl_fetch_feed(ctx, verbose);
 239
 240         debug_print("RSSyl: fetch done; success == %s\n",
 241                         ctx->success ? "TRUE" : "FALSE");
 242
 243         debug_print("RSSyl: STARTING TO PARSE FEED\n");
 244   if( ctx->success && !(ctx->success = rssyl_parse_feed(ritem, ctx->feed)) ) {
 245                 /* both libcurl and libfeed were happy, but we weren't */
 246                 debug_print("RSSyl: Error processing feed\n");
 247                 if( verbose ) {
 248                         gchar *msg = g_markup_printf_escaped(
 249                                         (const char *) _("Couldn't process feed at\n<b>%s</b>\n\n"
 250                                                 "Please contact developers, this should not happen."),
 251                                         feed_get_url(ctx->feed));
 252                         alertpanel_error("%s", msg);
 253                         g_free(msg);
 254                 }
 255
 256                 log_error(LOG_PROTOCOL, RSSYL_LOG_ERROR_PROC, ctx->feed->url);
 257         }
 258
 259         debug_print("RSSyl: FEED PARSED\n");
 260
 261         STATUSBAR_POP(mainwin);
 262
 263         if( claws_is_exiting() ) {
 264                 feed_free(ctx->feed);
 265                 g_free(ctx->error);
 266                 g_free(ctx);
 267                 return success;
 268         }
 269
 270         if( ritem->fetch_comments )
 271                 rssyl_update_comments(ritem);
 272
 273         /* Prune our deleted items list of items which are no longer in
 274          * upstream feed. */
 275         rssyl_deleted_expire(ritem, ctx->feed);
 276
 277         /* Clean up. */
 278         success = ctx->success;
 279         feed_free(ctx->feed);
 280         g_free(ctx->error);
 281         g_free(ctx);
 282
 283         return success;
 284 }
 285
 286 static gboolean rssyl_update_recursively_func(GNode *node, gpointer data)
 287 {
 288         FolderItem *item;
 289         RFolderItem *ritem;
 290
 291         g_return_val_if_fail(node->data != NULL, FALSE);
 292
 293         item = FOLDER_ITEM(node->data);
 294         ritem = (RFolderItem *)item;
 295
 296         if( ritem->url != NULL ) {
 297                 debug_print("RSSyl: Updating feed '%s'\n", item->name);
 298                 rssyl_update_feed(ritem, FALSE);
 299         } else
 300                 debug_print("RSSyl: Updating in folder '%s'\n", item->name);
 301
 302         return FALSE;
 303 }
 304
 305 void rssyl_update_recursively(FolderItem *item)
 306 {
 307         g_return_if_fail(item != NULL);
 308         g_return_if_fail(item->folder != NULL);
 309
 310         if( item->folder->klass != rssyl_folder_get_class() )
 311                 return;
 312
 313         debug_print("Recursively updating '%s'\n", item->name);
 314
 315         g_node_traverse(item->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
 316                         rssyl_update_recursively_func, NULL);
 317 }
 318
 319 void rssyl_update_all_func(FolderItem *item, gpointer data)
 320 {
 321         /* Only try to refresh our feed folders */
 322         if( !IS_RSSYL_FOLDER_ITEM(item) )
 323                 return;
 324
 325         if( folder_item_parent(item) == NULL )
 326                 rssyl_update_recursively(item);
 327 }
 328
 329 void rssyl_update_all_feeds(void)
 330 {
 331         if (prefs_common_get_prefs()->work_offline &&
 332                         !inc_offline_should_override(TRUE,
 333                                 _("Claws Mail needs network access in order to update your feeds.")) ) {
 334                 return;
 335         }
 336
 337         folder_func_to_all_folders((FolderItemFunc)rssyl_update_all_func, NULL);
 338 }