Redesign RSS subsystem

src/base/rss/rss_session.h

@@ -0,0 +1,154 @@
+/*
+ * Bittorrent Client using Qt and libtorrent.
+ * Copyright (C) 2017  Vladimir Golovnev <glassez@yandex.ru>
+ * Copyright (C) 2010  Christophe Dumez <chris@qbittorrent.org>
+ * Copyright (C) 2010  Arnaud Demaiziere <arnaud@qbittorrent.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.
+ *
+ * In addition, as a special exception, the copyright holders give permission to
+ * link this program with the OpenSSL project's "OpenSSL" library (or with
+ * modified versions of it that use the same license as the "OpenSSL" library),
+ * and distribute the linked executables. You must obey the GNU General Public
+ * License in all respects for all of the code used other than "OpenSSL".  If you
+ * modify file(s), you may extend this exception to your version of the file(s),
+ * but you are not obligated to do so. If you do not wish to do so, delete this
+ * exception statement from your version.
+ */
+
+#pragma once
+
+/*
+ * RSS Session configuration file format (JSON):
+ *
+ * =============== BEGIN ===============
+ * {
+ *     "folder1": {
+ *         "subfolder1": {
+ *             "Feed name (Alias)": "http://some-feed-url1",
+ *             "http://some-feed-url2": ""
+ *         },
+ *         "subfolder2": {},
+ *         "http://some-feed-url3": "",
+ *         "Feed name (Alias)": {
+ *             "url": "http://some-feed-url4",
+ *         }
+ *     },
+ *     "folder2": {},
+ *     "folder3": {}
+ * }
+ * ================ END ================
+ *
+ * 1.   Document is JSON object (the same as Folder)
+ * 2.   Folder is JSON object (keys are Item names, values are Items)
+ * 3.1. Feed is JSON object (keys are property names, values are property values; 'url' is required)
+ * 3.2. (Reduced format) Feed is JSON string (string is URL unless it's empty, otherwise we take Feed URL from name)
+ */
+
+#include <QHash>
+#include <QObject>
+#include <QPointer>
+#include <QStringList>
+#include <QTimer>
+
+class QThread;
+class Application;
+class AsyncFileStorage;
+
+namespace RSS
+{
+    class Item;
+    class Feed;
+    class Folder;
+
+    class Session: public QObject
+    {
+        Q_OBJECT
+        Q_DISABLE_COPY(Session)
+
+        friend class ::Application;
+
+        Session();
+        ~Session() override;
+
+    public:
+        static Session *instance();
+
+        bool isProcessingEnabled() const;
+        void setProcessingEnabled(bool enabled);
+
+        QThread *workingThread() const;
+        AsyncFileStorage *confFileStorage() const;
+        AsyncFileStorage *dataFileStorage() const;
+
+        int maxArticlesPerFeed() const;
+        void setMaxArticlesPerFeed(int n);
+
+        uint refreshInterval() const;
+        void setRefreshInterval(uint refreshInterval);
+
+        bool addFolder(const QString &path, QString *error = nullptr);
+        bool addFeed(const QString &url, const QString &path, QString *error = nullptr);
+        bool moveItem(const QString &itemPath, const QString &destPath
+                         , QString *error = nullptr);
+        bool moveItem(Item *item, const QString &destPath, QString *error = nullptr);
+        bool removeItem(const QString &itemPath, QString *error = nullptr);
+
+        QList<Item *> items() const;
+        Item *itemByPath(const QString &path) const;
+        QList<Feed *> feeds() const;
+        Feed *feedByURL(const QString &url) const;
+
+        Folder *rootFolder() const;
+
+    public slots:
+        void refresh();
+
+    signals:
+        void processingStateChanged(bool enabled);
+        void maxArticlesPerFeedChanged(int n);
+        void itemAdded(Item *item);
+        void itemPathChanged(Item *item);
+        void itemAboutToBeRemoved(Item *item);
+        void feedIconLoaded(Feed *feed);
+        void feedStateChanged(Feed *feed);
+
+    private slots:
+        void handleItemAboutToBeDestroyed(Item *item);
+        void handleFeedTitleChanged(Feed *feed);
+
+    private:
+        void load();
+        void loadFolder(const QJsonObject &jsonObj, Folder *folder);
+        void loadLegacy();
+        void store();
+        Folder *prepareItemDest(const QString &path, QString *error);
+        Folder *addSubfolder(const QString &name, Folder *parentFolder);
+        Feed *addFeedToFolder(const QString &url, const QString &name, Folder *parentFolder);
+        void addItem(Item *item, Folder *destFolder);
+
+        static QPointer<Session> m_instance;
+
+        bool m_processingEnabled;
+        QThread *m_workingThread;
+        AsyncFileStorage *m_confFileStorage;
+        AsyncFileStorage *m_dataFileStorage;
+        QTimer m_refreshTimer;
+        uint m_refreshInterval;
+        int m_maxArticlesPerFeed;
+        QHash<QString, Item *> m_itemsByPath;
+        QHash<QString, Feed *> m_feedsByURL;
+    };
+}