src/plugins/rssyl/libfeed/feed.h

   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 #ifndef __FEED_H
  21 #define __FEED_H
  22
  23 #include <glib.h>
  24 #include <expat.h>
  25
  26 #define FEED_DEFAULT_TIMEOUT    20      /* In seconds */
  27
  28 /* ---------------- Structures */
  29
  30 typedef struct _Feed Feed;
  31 typedef struct _FeedItem FeedItem;
  32 typedef struct _FeedParserCtx FeedParserCtx;
  33
  34 struct _Feed {
  35         gchar *url;
  36         gchar *title;
  37         gchar *description;
  38         gchar *language;
  39         gchar *author;
  40         gchar *generator;
  41         time_t date;
  42
  43         guint timeout;
  44         gchar *fetcherr;
  45         gchar *cookies_path;
  46         gboolean ssl_verify_peer;
  47
  48         GSList *items;
  49 };
  50
  51 struct _FeedParserCtx {
  52         XML_Parser parser;
  53         guint depth;
  54         guint location;
  55         GString *str;
  56         gchar *name;
  57         gchar *mail;
  58         gboolean id_is_permalink;
  59
  60         Feed *feed;
  61         FeedItem *curitem;
  62 };
  63
  64 typedef enum {
  65         FEED_ERR_NOFEED,
  66         FEED_ERR_NOURL,
  67         FEED_ERR_INIT,
  68         FEED_ERR_FETCH
  69 } FeedErrCodes;
  70
  71 /* ---------------- Prototypes */
  72
  73 Feed *feed_new(gchar *url);
  74 void feed_free(Feed *feed);
  75
  76 void feed_free_items(Feed *feed);
  77
  78 void feed_set_timeout(Feed *feed, guint timeout);
  79 guint feed_get_timeout(Feed *feed);
  80
  81 void feed_set_url(Feed *feed, gchar *url);
  82 gchar *feed_get_url(Feed *feed);
  83
  84 gchar *feed_get_title(Feed *feed);
  85 void feed_set_title(Feed *feed, gchar *new_title);
  86
  87 gchar *feed_get_description(Feed *feed);
  88 gchar *feed_get_language(Feed *feed);
  89 gchar *feed_get_author(Feed *feed);
  90 gchar *feed_get_generator(Feed *feed);
  91 gchar *feed_get_fetcherror(Feed *feed);
  92
  93 gchar *feed_get_cookies_path(Feed *feed);
  94 void feed_set_cookies_path(Feed *feed, gchar *path);
  95
  96 gboolean feed_get_ssl_verify_peer(Feed *feed);
  97 void feed_set_ssl_verify_peer(Feed *feed, gboolean ssl_verify_peer);
  98
  99 gint feed_n_items(Feed *feed);
 100 FeedItem *feed_nth_item(Feed *feed, guint n);
 101
 102 void feed_foreach_item(Feed *feed, GFunc func, gpointer data);
 103
 104 gboolean feed_prepend_item(Feed *feed, FeedItem *item);
 105 gboolean feed_append_item(Feed *feed, FeedItem *item);
 106 gboolean feed_insert_item(Feed *feed, FeedItem *item, gint pos);
 107
 108 guint feed_update(Feed *feed, time_t last_update);
 109
 110 #define FILL(n)         do { g_free(n); n = g_strdup(text); } while(0);
 111
 112 #include "feeditem.h"
 113
 114 #endif /* __FEED_H */