feed.h

Go to the documentation of this file.

/*
    This file is part of Akregator.

    Copyright (C) 2004 Stanislav Karchebny <Stanislav.Karchebny@kdemail.net>
                  2005 Frank Osterfeld <osterfeld@kde.org>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

    As a special exception, permission is given to link this program
    with any edition of Qt, and distribute the resulting executable,
    without including the source code for Qt in the source distribution.
*/

#ifndef AKREGATOR_FEED_H
#define AKREGATOR_FEED_H

#include "akregator_export.h"
#include "feediconmanager.h"
#include "treenode.h"

#include <syndication/syndication.h>

#include <QIcon>
#include <QList>

class QDomElement;
class QString;

namespace Akregator {

class Article;
class FetchQueue;
class TreeNodeVisitor;

namespace Backend {
    class Storage;
}

class AKREGATOR_EXPORT Feed : public TreeNode, public virtual FaviconListener
{
    friend class ::Akregator::Article;
    friend class ::Akregator::Folder;
    Q_OBJECT
    public:
        enum ArchiveMode {
            globalDefault, 
            keepAllArticles, 
            disableArchiving, 
            limitArticleNumber, 
            limitArticleAge 
        };

        // class methods
        static ArchiveMode stringToArchiveMode(const QString& str);

        static QString archiveModeToString(ArchiveMode mode);

        static Feed* fromOPML(QDomElement e, Akregator::Backend::Storage* storage);

        explicit Feed( Akregator::Backend::Storage* storage );
        ~Feed();

        bool accept(TreeNodeVisitor* visitor);

        QDomElement toOPML( QDomElement parent, QDomDocument document ) const;

        bool useCustomFetchInterval() const;

        void setCustomFetchIntervalEnabled(bool enabled);

        // FIXME is it -1 or 0 to disable interval fetching?
        int fetchInterval() const;

        void setFetchInterval(int interval);

        ArchiveMode archiveMode() const;

        void setArchiveMode(ArchiveMode archiveMode);

        int maxArticleAge() const;

        void setMaxArticleAge(int maxArticleAge);


        int maxArticleNumber() const;

        void setMaxArticleNumber(int maxArticleNumber);

        bool markImmediatelyAsRead() const;

        void setMarkImmediatelyAsRead(bool enabled);

        void setUseNotification(bool enabled);

        bool useNotification() const;

        void setLoadLinkedWebsite(bool enabled);

        bool loadLinkedWebsite() const;

        QPixmap image() const;

        void setImage(const QPixmap &p);

        void setFavicon( const QIcon& icon );

        QString xmlUrl() const;
        void setXmlUrl(const QString& s);

        QString htmlUrl() const;
        void setHtmlUrl(const QString& s);

        QString description() const;

        void setDescription(const QString& s);

        Article findArticle(const QString& guid) const;

        bool fetchErrorOccurred() const;

        Syndication::ErrorCode fetchErrorCode() const;

        int unread() const;

        int totalCount() const;

        bool isArticlesLoaded() const;

        bool isGroup() const { return false; }

        //impl
        bool isAggregation() const { return false; }

        const TreeNode* next() const;
        TreeNode* next();

        //impl
        QIcon icon() const;

        void deleteExpiredArticles( Akregator::ArticleDeleteJob* job );

        bool isFetching() const;

        QVector<const Feed*> feeds() const;
        QVector<Feed*> feeds();
        QVector<const Folder*> folders() const;
        QVector<Folder*> folders();

        /* reimp */ KJob* createMarkAsReadJob();

    public slots:
        void fetch(bool followDiscovery=false);

        void slotAbortFetch();

        void slotAddToFetchQueue(Akregator::FetchQueue* queue, bool intervalFetchOnly=false);

        void slotAddFeedIconListener();

    signals:
        void fetchStarted(Akregator::Feed*);
        void fetched(Akregator::Feed *);
        void fetchError(Akregator::Feed *);
        void fetchDiscovery(Akregator::Feed *);
        void fetchAborted(Akregator::Feed *);

    private:
        Akregator::Backend::Storage* storage();

    private:
        QList<Article> articles();

        void loadArticles();
        void enforceLimitArticleNumber();

        void recalcUnreadCount();

        void doArticleNotification();

        void setUnread(int unread);

        void setArticleDeleted(Article& a);

        void setArticleChanged(Article& a, int oldStatus=-1);

        void appendArticles(const Syndication::FeedPtr feed);

        void appendArticle(const Article& a);

        bool isExpired(const Article& a) const;

        bool usesExpiryByAge() const;

        void tryFetch();

        void markAsFetchedNow();

    private slots:

        void fetchCompleted(Syndication::Loader *loader, Syndication::FeedPtr doc, Syndication::ErrorCode errorCode);
        void slotImageFetched(const QPixmap& image);

    private:

        class Private;
        Private* d;
};

} // namespace Akregator

#endif // AKREGATOR_FEED_H