File indexing completed on 2025-01-05 03:53:32

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2016-05-27
  * Description : Implementation of v3 of the Imgur API
  *
  * SPDX-FileCopyrightText: 2016      by Fabian Vogt <fabian at ritter dash vogt dot de>
  * SPDX-FileCopyrightText: 2016-2020 by Caulier Gilles <caulier dot gilles at gmail dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef DIGIKAM_IMGUR_TALKER_H
 #define DIGIKAM_IMGUR_TALKER_H
 
 // C++ includes
 
 #include <atomic>
 #include <queue>
 
 // Qt includes
 
 #include <QString>
 #include <QFile>
 #include <QUrl>
 
 // Local includes
 
 #include "o2.h"
 
 namespace DigikamGenericImgUrPlugin
 {
 
 enum class ImgurTalkerActionType
 {
     ACCT_INFO,       ///< Action: account Result : account
     IMG_UPLOAD,      ///< Action: upload Result  : image
     ANON_IMG_UPLOAD, ///< Action: upload Result  : image
 };
 
 struct ImgurTalkerAction
 {
     ImgurTalkerActionType type;
 
     struct
     {
         QString imgpath;
         QString title;
         QString description;
     }
     upload;
 
     struct
     {
         QString username;
     }
     account;
 };
 
 struct ImgurTalkerResult
 {
     const ImgurTalkerAction* action;
 
     struct ImgurImage
     {
         QString    name;
         QString    title;
         QString    hash;
         QString    deletehash;
         QString    url;
         QString    description;
         qulonglong datetime;
         QString    type;
         bool       animated;
         uint       width;
         uint       height;
         uint       size;
         uint       views;
         qulonglong bandwidth;
     }
     image;
 
     struct ImgurAccount
     {
         QString username;
     }
     account;
 };
 
 // ----------------------------------------------------------------
 
 /**
  * Main class, handles the client side of the Imgur API v3.
  */
 class ImgurTalker : public QObject
 {
 Q_OBJECT
 
 public:
 
     explicit ImgurTalker(QObject* const parent = nullptr);
     ~ImgurTalker() override;
 
 public:
 
     /**
      * Use this method to read/write the access and refresh tokens.
      */
     O2& getAuth();
 
     unsigned int workQueueLength();
     void         queueWork(const ImgurTalkerAction& action);
     void         cancelAllWork();
 
     static QUrl  urlForDeletehash(const QString& deletehash);
 
 Q_SIGNALS:
 
     /**
      * Called if authentication state changes.
      */
     void signalAuthorized(bool success, const QString& username);
     void signalAuthError(const QString& msg);
 
     /**
      * Open url in a browser and let the user copy the pin.
      * Call setPin(pin) to authorize.
      */
     void signalRequestPin(const QUrl& url);
 
     /**
      * Emitted on progress changes.
      */
     void signalProgress(unsigned int percent, const ImgurTalkerAction& action);
     void signalSuccess(const ImgurTalkerResult& result);
     void signalError(const QString& msg, const ImgurTalkerAction& action);
 
     /**
      * Emitted when the status changes.
      */
     void signalBusy(bool b);
 
 public Q_SLOTS:
 
     /**
      * Connected to O2 linkedChanged().
      */
     void slotOauthAuthorized();
 
     /**
      * Connected to O2 openBrowser(QUrl).
      */
     void slotOauthRequestPin(const QUrl& url);
 
     /**
      * Connected to O2 linkingFailed().
      */
     void slotOauthFailed();
 
     /**
      * Connected to the current QNetworkReply.
      */
     void slotUploadProgress(qint64 sent, qint64 total);
     void slotReplyFinished();
 
 protected:
 
     void timerEvent(QTimerEvent* event) override;
 
 private:
 
     /**
      * Starts timer if queue not empty.
      */
     void startWorkTimer();
 
     /**
      * Stops timer if running.
      */
     void stopWorkTimer();
 
     /**
      * Adds the user authorization info to the request.
      */
     void addAuthToken(QNetworkRequest* request);
 
     /**
      * Adds the client authorization info to the request.
      */
     void addAnonToken(QNetworkRequest* request);
 
     /**
      * Start working on the first item of m_work_queue
      * by sending a request.
      */
     void doWork();
 
 private:
 
     class Private;
     Private* const d;
 };
 
 } // namespace DigikamGenericImgUrPlugin
 
 #endif // DIGIKAM_IMGUR_TALKER_H