imgurtalker.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2016-05-27
 * Description : Implementation of v3 of the Imgur API
 *
 * Copyright (C) 2016      by Fabian Vogt <fabian at ritter dash vogt dot de>
 * Copyright (C) 2016-2020 by Caulier Gilles <caulier dot gilles at gmail dot com>
 *
 * 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, 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.
 *
 * ============================================================ */
 
#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,       
    IMG_UPLOAD,      
    ANON_IMG_UPLOAD, 
};
 
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;
};
 
// ----------------------------------------------------------------
 
class ImgurTalker : public QObject
{
Q_OBJECT
 
public:
 
    explicit ImgurTalker(QObject* const parent = nullptr);
    ~ImgurTalker() override;
 
public:
 
    O2& getAuth();
 
    unsigned int workQueueLength();
    void         queueWork(const ImgurTalkerAction& action);
    void         cancelAllWork();
 
    static QUrl  urlForDeletehash(const QString& deletehash);
 
Q_SIGNALS:
 
    void signalAuthorized(bool success, const QString& username);
    void signalAuthError(const QString& msg);
 
    void signalRequestPin(const QUrl& url);
 
    void signalProgress(unsigned int percent, const ImgurTalkerAction& action);
    void signalSuccess(const ImgurTalkerResult& result);
    void signalError(const QString& msg, const ImgurTalkerAction& action);
 
    void signalBusy(bool b);
 
public Q_SLOTS:
 
    void slotOauthAuthorized();
 
    void slotOauthRequestPin(const QUrl& url);
 
    void slotOauthFailed();
 
    void slotUploadProgress(qint64 sent, qint64 total);
    void slotReplyFinished();
 
protected:
 
    void timerEvent(QTimerEvent* event) override;
 
private:
 
    void startWorkTimer();
 
    void stopWorkTimer();
 
    void addAuthToken(QNetworkRequest* request);
 
    void addAnonToken(QNetworkRequest* request);
 
    void doWork();
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace DigikamGenericImgUrPlugin
 
#endif // DIGIKAM_IMGUR_TALKER_H