rssguard/src/librssguard/services/tt-rss/ttrssnetworkfactory.h

// For license of this file, see <project-root-folder>/LICENSE.md.

#ifndef TTRSSNETWORKFACTORY_H
#define TTRSSNETWORKFACTORY_H

#include "core/message.h"

#include "services/tt-rss/ttrssnotetopublish.h"

#include <QJsonObject>
#include <QNetworkReply>
#include <QPair>
#include <QString>

class RootItem;
class TtRssFeed;
class Label;

class TtRssResponse {
  public:
    explicit TtRssResponse(const QString& raw_content = QString());
    virtual ~TtRssResponse();

    bool isLoaded() const;

    int seq() const;
    int status() const;
    QString error() const;
    bool hasError() const;
    bool isNotLoggedIn() const;
    bool isUnknownMethod() const;
    QString toString() const;

  protected:
    QJsonObject m_rawContent;
};

class TtRssLoginResponse : public TtRssResponse {
  public:
    explicit TtRssLoginResponse(const QString& raw_content = QString());
    virtual ~TtRssLoginResponse();

    int apiLevel() const;
    QString sessionId() const;
};

class TtRssGetLabelsResponse : public TtRssResponse {
  public:
    explicit TtRssGetLabelsResponse(const QString& raw_content = QString());

    QList<RootItem*> labels() const;
};

class TtRssNetworkFactory;

class TtRssGetFeedsCategoriesResponse : public TtRssResponse {
  public:
    explicit TtRssGetFeedsCategoriesResponse(const QString& raw_content = QString());
    virtual ~TtRssGetFeedsCategoriesResponse();

    // Returns tree of feeds/categories.
    // Top-level root of the tree is not needed here.
    // Returned items do not have primary IDs assigned.
    RootItem* feedsCategories(TtRssNetworkFactory* network,
                              bool obtain_icons,
                              const QNetworkProxy& proxy,
                              const QString& base_address = QString()) const;
};

class ServiceRoot;

class TtRssGetHeadlinesResponse : public TtRssResponse {
  public:
    explicit TtRssGetHeadlinesResponse(const QString& raw_content = QString());
    virtual ~TtRssGetHeadlinesResponse();

    QList<Message> messages(ServiceRoot* root) const;
};

class TtRssGetArticleResponse : public TtRssResponse {
  public:
    explicit TtRssGetArticleResponse(const QString& raw_content = QString());
    virtual ~TtRssGetArticleResponse();

    QList<Message> messages(ServiceRoot* root) const;
};

class TtRssGetCompactHeadlinesResponse : public TtRssResponse {
  public:
    explicit TtRssGetCompactHeadlinesResponse(const QString& raw_content = QString());
    virtual ~TtRssGetCompactHeadlinesResponse();

    QStringList ids() const;
};

class TtRssUpdateArticleResponse : public TtRssResponse {
  public:
    explicit TtRssUpdateArticleResponse(const QString& raw_content = QString());
    virtual ~TtRssUpdateArticleResponse();

    QString updateStatus() const;
    int articlesUpdated() const;
};

class TtRssSubscribeToFeedResponse : public TtRssResponse {
  public:
    explicit TtRssSubscribeToFeedResponse(const QString& raw_content = QString());
    virtual ~TtRssSubscribeToFeedResponse();

    int code() const;
};

class TtRssUnsubscribeFeedResponse : public TtRssResponse {
  public:
    explicit TtRssUnsubscribeFeedResponse(const QString& raw_content = QString());
    virtual ~TtRssUnsubscribeFeedResponse();

    QString code() const;
};

namespace UpdateArticle {
  enum class Mode { SetToFalse = 0, SetToTrue = 1, Togggle = 2 };

  enum class OperatingField { Starred = 0, Published = 1, Unread = 2 };

} // namespace UpdateArticle

class TtRssNetworkFactory {
  public:
    explicit TtRssNetworkFactory();

    QString url() const;
    void setUrl(const QString& url);

    QString username() const;
    void setUsername(const QString& username);

    QString password() const;
    void setPassword(const QString& password);

    bool authIsUsed() const;
    void setAuthIsUsed(bool auth_is_used);

    QString authUsername() const;
    void setAuthUsername(const QString& auth_username);

    QString authPassword() const;
    void setAuthPassword(const QString& auth_password);

    bool forceServerSideUpdate() const;
    void setForceServerSideUpdate(bool force_server_side_update);

    bool downloadOnlyUnreadMessages() const;
    void setDownloadOnlyUnreadMessages(bool download_only_unread_messages);

    // Metadata.
    QDateTime lastLoginTime() const;
    QNetworkReply::NetworkError lastError() const;

    // Operations.

    // Logs user in.
    TtRssLoginResponse login(const QNetworkProxy& proxy);

    // Logs user out.
    TtRssResponse logout(const QNetworkProxy& proxy);

    // Gets list of labels from the server.
    TtRssGetLabelsResponse getLabels(const QNetworkProxy& proxy);

    // Shares new item to "published" feed.
    TtRssResponse shareToPublished(const TtRssNoteToPublish& note, const QNetworkProxy& proxy);

    // Gets feeds from the server.
    TtRssGetFeedsCategoriesResponse getFeedsCategories(const QNetworkProxy& proxy);

    // Gets message IDs from the server.
    TtRssGetCompactHeadlinesResponse getCompactHeadlines(int feed_id,
                                                         int limit,
                                                         int skip,
                                                         const QString& view_mode,
                                                         const QNetworkProxy& proxy);

    TtRssGetHeadlinesResponse getArticle(const QStringList& article_ids, const QNetworkProxy& proxy);

    // Gets headlines (messages) from the server.
    TtRssGetHeadlinesResponse getHeadlines(int feed_id,
                                           int limit,
                                           int skip,
                                           bool show_content,
                                           bool include_attachments,
                                           bool sanitize,
                                           bool unread_only,
                                           const QNetworkProxy& proxy);

    TtRssResponse setArticleLabel(const QStringList& article_ids,
                                  const QString& label_custom_id,
                                  bool assign,
                                  const QNetworkProxy& proxy);

    TtRssUpdateArticleResponse updateArticles(const QStringList& ids,
                                              UpdateArticle::OperatingField field,
                                              UpdateArticle::Mode mode,
                                              const QNetworkProxy& proxy);

    TtRssSubscribeToFeedResponse subscribeToFeed(const QString& url,
                                                 int category_id,
                                                 const QNetworkProxy& proxy,
                                                 bool protectd = false,
                                                 const QString& username = QString(),
                                                 const QString& password = QString());

    TtRssUnsubscribeFeedResponse unsubscribeFeed(int feed_id, const QNetworkProxy& proxy);

    int batchSize() const;
    void setBatchSize(int batch_size);

    bool intelligentSynchronization() const;
    void setIntelligentSynchronization(bool intelligent_synchronization);

  private:
    QString m_bareUrl;
    QString m_fullUrl;
    QString m_username;
    QString m_password;
    int m_batchSize;
    bool m_forceServerSideUpdate;
    bool m_downloadOnlyUnreadMessages;
    bool m_intelligentSynchronization;
    bool m_authIsUsed;
    QString m_authUsername;
    QString m_authPassword;
    QString m_sessionId;
    QDateTime m_lastLoginTime;

    QNetworkReply::NetworkError m_lastError;
};

#endif // TTRSSNETWORKFACTORY_H