2 * Copyright (C) 2006 Andrej Kacian <andrej@kacian.sk>
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.
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.
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.
24 #include <curl/curl.h>
31 * Initializes new Feed struct, setting its url and a default timeout. */
32 Feed *feed_new(gchar *url)
36 g_return_val_if_fail(url != NULL, NULL);
38 feed = malloc( sizeof(Feed) );
39 g_return_val_if_fail(feed != NULL, NULL);
41 feed->is_valid = TRUE;
42 feed->timeout = FEED_DEFAULT_TIMEOUT;
43 feed->url = g_strdup(url);
46 feed->description = NULL;
47 feed->language = NULL;
49 feed->generator = NULL;
53 feed->fetcherr = NULL;
54 feed->cookies_path = NULL;
56 feed->ssl_verify_peer = TRUE;
57 feed->cacert_file = NULL;
62 static void _free_items(gpointer item, gpointer nada)
67 static void _free_auth(Feed *feed)
72 if (feed->auth != NULL) {
73 if (feed->auth->username != NULL)
74 g_free(feed->auth->username);
75 if (feed->auth->password != NULL)
76 g_free(feed->auth->password);
82 void feed_free(Feed *feed)
85 return; /* Return silently, without printing a glib error. */
90 g_free(feed->description);
91 g_free(feed->language);
93 g_free(feed->generator);
95 g_free(feed->fetcherr);
96 g_free(feed->cookies_path);
97 g_free(feed->cacert_file);
99 if( feed->items != NULL ) {
100 g_slist_foreach(feed->items, _free_items, NULL);
101 g_slist_free(feed->items);
108 void feed_free_items(Feed *feed)
113 if( feed->items != NULL ) {
114 g_slist_foreach(feed->items, _free_items, NULL);
115 g_slist_free(feed->items);
121 void feed_set_timeout(Feed *feed, guint timeout)
123 g_return_if_fail(feed != NULL);
124 feed->timeout = timeout;
127 guint feed_get_timeout(Feed *feed)
129 g_return_val_if_fail(feed != NULL, 0);
130 return feed->timeout;
134 void feed_set_url(Feed *feed, gchar *url)
136 g_return_if_fail(feed != NULL);
137 g_return_if_fail(url != NULL);
139 if( feed->url != NULL ) {
144 feed->url = g_strdup(url);
147 gchar *feed_get_url(Feed *feed)
149 g_return_val_if_fail(feed != NULL, NULL);
154 void feed_set_auth(Feed *feed, FeedAuth *auth)
156 g_return_if_fail(feed != NULL);
157 g_return_if_fail(auth != NULL);
160 feed->auth = g_new0(FeedAuth, 1);
161 feed->auth->type = auth->type;
162 feed->auth->username = g_strdup(auth->username);
163 feed->auth->password = g_strdup(auth->password);
166 FeedAuth *feed_get_auth(Feed *feed)
168 g_return_val_if_fail(feed != NULL, NULL);
173 gchar *feed_get_title(Feed *feed)
175 g_return_val_if_fail(feed != NULL, NULL);
179 void feed_set_title(Feed *feed, gchar *new_title)
181 g_return_if_fail(feed != NULL);
182 g_return_if_fail(new_title != NULL);
184 if (feed->title != NULL) {
189 feed->title = g_strdup(new_title);
193 gchar *feed_get_description(Feed *feed)
195 g_return_val_if_fail(feed != NULL, NULL);
196 return feed->description;
200 gchar *feed_get_language(Feed *feed)
202 g_return_val_if_fail(feed != NULL, NULL);
203 return feed->language;
207 gchar *feed_get_author(Feed *feed)
209 g_return_val_if_fail(feed != NULL, NULL);
214 gchar *feed_get_generator(Feed *feed)
216 g_return_val_if_fail(feed != NULL, NULL);
217 return feed->generator;
220 /* Fetch error (if not NULL, supplied by libcurl) */
221 gchar *feed_get_fetcherror(Feed *feed)
223 g_return_val_if_fail(feed != NULL, NULL);
224 return feed->fetcherr;
227 /* Returns number of items currently in the feed. */
228 gint feed_n_items(Feed *feed)
230 g_return_val_if_fail(feed != NULL, -1);
232 if( feed->items == NULL ) /* No items here. */
235 return g_slist_length(feed->items);
238 /* Returns nth item from feed. */
239 FeedItem *feed_nth_item(Feed *feed, guint n)
241 g_return_val_if_fail(feed != NULL, NULL);
243 return g_slist_nth_data(feed->items, n);
247 * Takes initialized feed with url set, fetches the feed from this url,
248 * updates rest of Feed struct members and returns HTTP response code
249 * we got from url's server. */
250 guint feed_update(Feed *feed, time_t last_update)
254 FeedParserCtx *feed_ctx = NULL;
255 glong response_code = 0;
257 g_return_val_if_fail(feed != NULL, FEED_ERR_NOFEED);
258 g_return_val_if_fail(feed->url != NULL, FEED_ERR_NOURL);
260 /* Init curl before anything else. */
261 eh = curl_easy_init();
263 g_return_val_if_fail(eh != NULL, FEED_ERR_INIT);
265 /* Curl initialized, create parser context now. */
266 feed_ctx = malloc( sizeof(FeedParserCtx) );
268 feed_ctx->parser = XML_ParserCreate(NULL);
270 feed_ctx->str = NULL;
271 feed_ctx->xhtml_str = NULL;
272 feed_ctx->feed = feed;
273 feed_ctx->location = 0;
274 feed_ctx->curitem = NULL;
275 feed_ctx->id_is_permalink = TRUE;
277 feed_ctx->name = NULL;
278 feed_ctx->mail = NULL;
280 /* Set initial expat handlers, which will take care of choosing
281 * correct parser later. */
282 feed_parser_set_expat_handlers(feed_ctx);
284 curl_easy_setopt(eh, CURLOPT_URL, feed->url);
285 curl_easy_setopt(eh, CURLOPT_NOPROGRESS, 1);
287 curl_easy_setopt(eh, CURLOPT_MUTE, 1);
289 curl_easy_setopt(eh, CURLOPT_WRITEFUNCTION, feed_writefunc);
290 curl_easy_setopt(eh, CURLOPT_WRITEDATA, feed_ctx);
291 curl_easy_setopt(eh, CURLOPT_FOLLOWLOCATION, 1);
292 curl_easy_setopt(eh, CURLOPT_MAXREDIRS, 3);
293 curl_easy_setopt(eh, CURLOPT_TIMEOUT, feed->timeout);
294 curl_easy_setopt(eh, CURLOPT_NOSIGNAL, 1);
295 curl_easy_setopt(eh, CURLOPT_ENCODING, "");
296 curl_easy_setopt(eh, CURLOPT_USERAGENT, "libfeed 0.1");
297 curl_easy_setopt(eh, CURLOPT_NETRC, CURL_NETRC_OPTIONAL);
299 /* Use HTTP's If-Modified-Since feature, if application provided
300 * the timestamp of last update. */
301 if( last_update != -1 ) {
302 curl_easy_setopt(eh, CURLOPT_TIMECONDITION,
303 CURL_TIMECOND_IFMODSINCE);
304 curl_easy_setopt(eh, CURLOPT_TIMEVALUE, (long)last_update);
307 #if LIBCURL_VERSION_NUM >= 0x070a00
308 if (feed->ssl_verify_peer == FALSE) {
309 curl_easy_setopt(eh, CURLOPT_SSL_VERIFYPEER, 0);
310 curl_easy_setopt(eh, CURLOPT_SSL_VERIFYHOST, 0);
314 if (feed->cacert_file != NULL)
315 curl_easy_setopt(eh, CURLOPT_CAINFO, feed->cacert_file);
317 if(feed->cookies_path != NULL)
318 curl_easy_setopt(eh, CURLOPT_COOKIEFILE, feed->cookies_path);
320 if (feed->auth != NULL) {
321 switch (feed->auth->type) {
324 case FEED_AUTH_BASIC:
325 curl_easy_setopt(eh, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
326 curl_easy_setopt(eh, CURLOPT_USERNAME,
327 feed->auth->username);
328 curl_easy_setopt(eh, CURLOPT_PASSWORD,
329 feed->auth->password);
332 response_code = FEED_ERR_UNAUTH; /* unknown auth */
337 res = curl_easy_perform(eh);
338 XML_Parse(feed_ctx->parser, "", 0, TRUE);
340 if( res != CURLE_OK ) {
341 feed->fetcherr = g_strdup(curl_easy_strerror(res));
342 response_code = FEED_ERR_FETCH;
344 curl_easy_getinfo(eh, CURLINFO_RESPONSE_CODE, &response_code);
348 curl_easy_cleanup(eh);
350 /* Cleanup, we should be done. */
351 XML_ParserFree(feed_ctx->parser);
352 g_free(feed_ctx->name);
353 g_free(feed_ctx->mail);
354 if (feed_ctx->str != NULL)
355 g_string_free(feed_ctx->str, TRUE);
356 if (feed_ctx->xhtml_str != NULL)
357 g_string_free(feed_ctx->xhtml_str, TRUE);
360 return response_code;
363 void feed_foreach_item(Feed *feed, GFunc func, gpointer data)
365 g_return_if_fail(feed != NULL);
366 g_return_if_fail(feed->items != NULL);
368 g_slist_foreach(feed->items, func, data);
371 gboolean feed_prepend_item(Feed *feed, FeedItem *item)
373 g_return_val_if_fail(feed != NULL, FALSE);
374 g_return_val_if_fail(item != NULL, FALSE);
376 feed->items = g_slist_prepend(feed->items, item);
380 gboolean feed_append_item(Feed *feed, FeedItem *item)
382 g_return_val_if_fail(feed != NULL, FALSE);
383 g_return_val_if_fail(item != NULL, FALSE);
385 feed->items = g_slist_append(feed->items, item);
389 gboolean feed_insert_item(Feed *feed, FeedItem *item, gint pos)
391 g_return_val_if_fail(feed != NULL, FALSE);
392 g_return_val_if_fail(item != NULL, FALSE);
393 g_return_val_if_fail(pos < 0, FALSE);
395 feed->items = g_slist_insert(feed->items, item, pos);
399 gchar *feed_get_cookies_path(Feed *feed)
401 g_return_val_if_fail(feed != NULL, NULL);
402 return feed->cookies_path;
405 void feed_set_cookies_path(Feed *feed, gchar *path)
407 g_return_if_fail(feed != NULL);
409 if( feed->cookies_path != NULL ) {
410 g_free(feed->cookies_path);
411 feed->cookies_path = NULL;
414 feed->cookies_path = (path != NULL ? g_strdup(path) : NULL);
417 gboolean feed_get_ssl_verify_peer(Feed *feed)
419 g_return_val_if_fail(feed != NULL, FALSE);
420 return feed->ssl_verify_peer;
423 void feed_set_ssl_verify_peer(Feed *feed, gboolean ssl_verify_peer)
425 g_return_if_fail(feed != NULL);
426 feed->ssl_verify_peer = ssl_verify_peer;
429 gchar *feed_get_cacert_file(Feed *feed)
431 g_return_val_if_fail(feed != NULL, NULL);
432 return feed->cacert_file;
435 void feed_set_cacert_file(Feed *feed, const gchar *path)
437 g_return_if_fail(feed != NULL);
439 if( feed->cacert_file != NULL ) {
440 g_free(feed->cacert_file);
441 feed->cacert_file = NULL;
444 feed->cacert_file = (path != NULL ? g_strdup(path) : NULL);