File indexing completed on 2024-12-22 04:57:52

 /*
     SPDX-License-Identifier: BSD-2-Clause
 */
 
 #pragma once
 
 #include <QByteArray>
 #include <QObject>
 #include <QString>
 #include <QUrl>
 #include <QVariantMap>
 
 #include "o2/o0abstractstore.h"
 #include "o2/o0requestparameter.h"
 
 /// Base class of OAuth authenticators
 class O0BaseAuth : public QObject
 {
     Q_OBJECT
 
 public:
     explicit O0BaseAuth(QObject *parent = nullptr);
 
 public:
     /// Are we authenticated?
     Q_PROPERTY(bool linked READ linked WRITE setLinked NOTIFY linkedChanged)
     bool linked();
 
     /// Authentication token.
     Q_PROPERTY(QString token READ token NOTIFY tokenChanged)
     QString token() const;
 
     /// Authentication token secret.
     Q_PROPERTY(QString tokenSecret READ tokenSecret NOTIFY tokenSecretChanged)
     QString tokenSecret();
 
     /// Provider-specific extra tokens, available after a successful authentication
     Q_PROPERTY(QVariantMap extraTokens READ extraTokens NOTIFY extraTokensChanged)
     QVariantMap extraTokens();
 
     /// Client application ID.
     /// O1 instances with the same (client ID, client secret) share the same "linked", "token" and "tokenSecret" properties.
     Q_PROPERTY(QString clientId READ clientId WRITE setClientId NOTIFY clientIdChanged)
     QString clientId() const;
     void setClientId(const QString &value);
 
     /// Client application secret.
     /// O1 instances with the same (client ID, client secret) share the same "linked", "token" and "tokenSecret" properties.
     Q_PROPERTY(QString clientSecret READ clientSecret WRITE setClientSecret NOTIFY clientSecretChanged)
     QString clientSecret() const;
     void setClientSecret(const QString &value);
 
     /// TCP port number to use in local redirections.
     /// The OAuth "redirect_uri" will be set to "http://localhost:<localPort>/".
     /// If localPort is set to 0 (default), O2 will replace it with a free one.
     Q_PROPERTY(int localPort READ localPort WRITE setLocalPort NOTIFY localPortChanged)
     int localPort() const;
     void setLocalPort(int value);
 
     /// Sets the storage object to use for storing the OAuth tokens on a persistent medium
     void setStore(O0AbstractStore *store);
 
     /// Construct query string from list of headers
     static QByteArray createQueryParameters(const QList<O0RequestParameter> &parameters);
 
 public Q_SLOTS:
     /// Authenticate.
     Q_INVOKABLE virtual void link() = 0;
 
     /// De-authenticate.
     Q_INVOKABLE virtual void unlink() = 0;
 
 Q_SIGNALS:
     /// Emitted when client needs to open a web browser window, with the given URL.
     void openBrowser(const QUrl &url);
 
     /// Emitted when client can close the browser window.
     void closeBrowser();
 
     /// Emitted when authentication/deauthentication succeeded.
     void linkingSucceeded();
 
     /// Emitted when authentication/deauthentication failed.
     void linkingFailed();
 
     // Property change signals
 
     void linkedChanged();
     void clientIdChanged();
     void clientSecretChanged();
     void localPortChanged();
     void tokenChanged();
     void tokenSecretChanged();
     void extraTokensChanged();
 
 protected:
     /// Set authentication token.
     void setToken(const QString &v);
 
     /// Set authentication token secret.
     void setTokenSecret(const QString &v);
 
     /// Set the linked state
     void setLinked(bool v);
 
     /// Set extra tokens found in OAuth response
     void setExtraTokens(const QVariantMap &extraTokens);
 
 protected:
     QString clientId_;
     QString clientSecret_;
     QString redirectUri_;
     QString requestToken_;
     QString requestTokenSecret_;
     QUrl requestTokenUrl_;
     QUrl authorizeUrl_;
     QUrl accessTokenUrl_;
     quint16 localPort_;
     O0AbstractStore *store_ = nullptr;
     QVariantMap extraTokens_;
 };