Add a forgotten RSSyl: prefix to log_print message from previous commit.
[claws.git] / 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,
154                                         _("RSSyl: Possibly invalid feed without title at %s.\n"),
155                                         feed_get_url(ctx->feed));
156                 }
157         }
158 }
159
160 RFetchCtx *rssyl_prep_fetchctx_from_item(RFolderItem *ritem)
161 {
162         RFetchCtx *ctx = NULL;
163
164         g_return_val_if_fail(ritem != NULL, NULL);
165
166         ctx = g_new0(RFetchCtx, 1);
167         ctx->feed = feed_new(ritem->url);
168         ctx->error = NULL;
169         ctx->success = TRUE;
170         ctx->ready = FALSE;
171
172         feed_set_timeout(ctx->feed, prefs_common_get_prefs()->io_timeout_secs);
173         feed_set_cookies_path(ctx->feed, rssyl_prefs_get()->cookies_path);
174         feed_set_ssl_verify_peer(ctx->feed, ritem->ssl_verify_peer);
175         feed_set_auth(ctx->feed, ritem->auth);
176 #ifdef G_OS_WIN32
177         if (!g_ascii_strncasecmp(ritem->url, "https", 5)) {
178                 feed_set_cacert_file(ctx->feed, claws_ssl_get_cert_file());
179                 debug_print("RSSyl: using cert file '%s'\n", feed_get_cacert_file(ctx->feed));
180         }
181 #endif
182
183         return ctx;
184 }
185
186 RFetchCtx *rssyl_prep_fetchctx_from_url(gchar *url)
187 {
188         RFetchCtx *ctx = NULL;
189
190         g_return_val_if_fail(url != NULL, NULL);
191
192         ctx = g_new0(RFetchCtx, 1);
193         ctx->feed = feed_new(url);
194         ctx->error = NULL;
195         ctx->success = TRUE;
196         ctx->ready = FALSE;
197
198         feed_set_timeout(ctx->feed, prefs_common_get_prefs()->io_timeout_secs);
199         feed_set_cookies_path(ctx->feed, rssyl_prefs_get()->cookies_path);
200         feed_set_ssl_verify_peer(ctx->feed, rssyl_prefs_get()->ssl_verify_peer);
201 #ifdef G_OS_WIN32
202         if (!g_ascii_strncasecmp(url, "https", 5)) {
203                 feed_set_cacert_file(ctx->feed, claws_ssl_get_cert_file());
204                 debug_print("RSSyl: using cert file '%s'\n", feed_get_cacert_file(ctx->feed));
205         }
206 #endif
207
208         return ctx;
209 }
210
211 /* rssyl_update_feed() */
212
213 gboolean rssyl_update_feed(RFolderItem *ritem, gboolean verbose)
214 {
215         RFetchCtx *ctx = NULL;
216         MainWindow *mainwin = mainwindow_get_mainwindow();
217         gchar *msg = NULL;
218         gboolean success = FALSE;
219
220         g_return_val_if_fail(ritem != NULL, FALSE);
221         g_return_val_if_fail(ritem->url != NULL, FALSE);
222
223         debug_print("RSSyl: starting to update '%s' (%s)\n",
224                         ritem->item.name, ritem->url);
225
226         log_print(LOG_PROTOCOL, RSSYL_LOG_UPDATING, ritem->url);
227
228         msg = g_strdup_printf(_("Updating feed '%s'..."), ritem->item.name);
229         STATUSBAR_PUSH(mainwin, msg);
230         g_free(msg);
231
232         GTK_EVENTS_FLUSH();
233
234         /* Prepare context for fetching the feed file */
235         ctx = rssyl_prep_fetchctx_from_item(ritem);
236         g_return_val_if_fail(ctx != NULL, FALSE);
237
238         /* Fetch the feed file */
239         rssyl_fetch_feed(ctx, verbose);
240
241         debug_print("RSSyl: fetch done; success == %s\n",
242                         ctx->success ? "TRUE" : "FALSE");
243
244         debug_print("RSSyl: STARTING TO PARSE FEED\n");
245   if( ctx->success && !(ctx->success = rssyl_parse_feed(ritem, ctx->feed)) ) {
246                 /* both libcurl and libfeed were happy, but we weren't */
247                 debug_print("RSSyl: Error processing feed\n");
248                 if( verbose ) {
249                         gchar *msg = g_markup_printf_escaped(
250                                         (const char *) _("Couldn't process feed at\n<b>%s</b>\n\n"
251                                                 "Please contact developers, this should not happen."),
252                                         feed_get_url(ctx->feed));
253                         alertpanel_error("%s", msg);
254                         g_free(msg);
255                 }
256
257                 log_error(LOG_PROTOCOL, RSSYL_LOG_ERROR_PROC, ctx->feed->url);
258         }
259         
260         debug_print("RSSyl: FEED PARSED\n");
261
262         STATUSBAR_POP(mainwin);
263
264         if( claws_is_exiting() ) {
265                 feed_free(ctx->feed);
266                 g_free(ctx->error);
267                 g_free(ctx);
268                 return success;
269         }
270
271         if( ritem->fetch_comments )
272                 rssyl_update_comments(ritem);
273
274         /* Prune our deleted items list of items which are no longer in
275          * upstream feed. */
276         rssyl_deleted_expire(ritem, ctx->feed);
277
278         /* Clean up. */
279         success = ctx->success;
280         feed_free(ctx->feed);
281         g_free(ctx->error);
282         g_free(ctx);
283
284         return success;
285 }
286
287 static gboolean rssyl_update_recursively_func(GNode *node, gpointer data)
288 {
289         FolderItem *item;
290         RFolderItem *ritem;
291
292         g_return_val_if_fail(node->data != NULL, FALSE);
293
294         item = FOLDER_ITEM(node->data);
295         ritem = (RFolderItem *)item;
296
297         if( ritem->url != NULL ) {
298                 debug_print("RSSyl: Updating feed '%s'\n", item->name);
299                 rssyl_update_feed(ritem, FALSE);
300         } else
301                 debug_print("RSSyl: Updating in folder '%s'\n", item->name);
302
303         return FALSE;
304 }
305
306 void rssyl_update_recursively(FolderItem *item)
307 {
308         g_return_if_fail(item != NULL);
309         g_return_if_fail(item->folder != NULL);
310
311         if( item->folder->klass != rssyl_folder_get_class() )
312                 return;
313
314         debug_print("Recursively updating '%s'\n", item->name);
315
316         g_node_traverse(item->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
317                         rssyl_update_recursively_func, NULL);
318 }
319
320 void rssyl_update_all_func(FolderItem *item, gpointer data)
321 {
322         /* Only try to refresh our feed folders */
323         if( !IS_RSSYL_FOLDER_ITEM(item) )
324                 return;
325
326         if( folder_item_parent(item) == NULL )
327                 rssyl_update_recursively(item);
328 }
329
330 void rssyl_update_all_feeds(void)
331 {
332         if (prefs_common_get_prefs()->work_offline &&
333                         !inc_offline_should_override(TRUE,
334                                 _("Claws Mail needs network access in order to update your feeds.")) ) {
335                 return;
336         }
337
338         folder_func_to_all_folders((FolderItemFunc)rssyl_update_all_func, NULL);
339 }