summaryrefslogtreecommitdiffstats
path: root/akregator/src/storage.h
blob: 59dd410a4d9d2b445bf71d599a6a87217d7d82bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*
    This file is part of Akregator.

    Copyright (C) 2005 Stanislav Karchebny <Stanislav.Karchebny@kdemail.net>

    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_BACKEND_STORAGE_H
#define AKREGATOR_BACKEND_STORAGE_H

#include <qobject.h>

#include "akregator_export.h"

class QString;
class QStringList;

namespace Akregator {
namespace Backend {

class FeedStorage;

/** \brief Storage is the main interface to the article archive. It creates and manages FeedStorage objects handling the article list for a feed.
    
    An archive implementation must implement Storage, FeedStorage and StorageFactory. See mk4storage for an example.
*/
class AKREGATOR_EXPORT Storage : public QObject
{
    public:

        static Storage* getInstance();
        static void setInstance(Storage* instance);

        virtual ~Storage() {}

        /** initializes the storage object with given parameters */
        
        virtual void initialize(const QStringList& params) = 0;
        
        /**
         * Open storage and prepare it for work.
         * @return true on success.
         */
        virtual bool open(bool autoCommit = false) = 0;

        /**
         * Commit changes made in feeds and articles, making them persistent.
         * @return true on success.
         */
        virtual bool commit() = 0;

        /**
         * Rollback changes made in feeds and articles, reverting to last committed values.
         * @returns true on success.
         */
        virtual bool rollback() = 0;

        /**
         * Closes storage, freeing all allocated resources. Called from destructor, so you don't need to call it directly.
         * @return true on success.
         */
        virtual bool close() = 0;

        /**
         * @return Article archive for feed at given url.
         */
        virtual FeedStorage* archiveFor(const QString &url) = 0;
        virtual bool autoCommit() const  = 0;
        virtual int unreadFor(const QString &url) = 0;
        virtual void setUnreadFor(const QString &url, int unread) = 0;
        virtual int totalCountFor(const QString &url) = 0;
        virtual void setTotalCountFor(const QString &url, int total) = 0;
        virtual int lastFetchFor(const QString& url) = 0;
        virtual void setLastFetchFor(const QString& url, int lastFetch) = 0;

        /** stores the feed list in the storage backend. This is a fallback for the case that the 
            feeds.opml file gets corrupted 
            @param opmlStr the feed list in OPML format
         */
        virtual void storeFeedList(const QString& opmlStr) = 0;
        virtual QString restoreFeedList() const = 0;

        virtual void storeTagSet(const QString& xmlStr) = 0;
        virtual QString restoreTagSet() const = 0;

        /** returns a list of all feeds (URLs) stored in this archive */
        
        virtual QStringList feeds() const = 0;

        /** adds all feed storages from a source to this storage
            existing articles are replaced
        */
        virtual void add(Storage* source) = 0;
        
        /** deletes all feed storages in this archive */
        virtual void clear() = 0;
        
     private:
        
        static Storage *m_instance;
};

}
}

#endif