OAuthService.h

Go to the documentation of this file.

/*  SPDX-License-Identifier: GPL-2.0-or-later */
/*!********************************************************************
 
  Audacity: A Digital Audio Editor
 
  OAuthService.h
 
  Dmitry Vedenko
 
**********************************************************************/
#pragma once
 
#include <chrono>
#include <functional>
#include <string_view>
#include <mutex>
 
#include "Observer.h"
 
namespace cloud::audiocom
{
class ServiceConfig;
 
struct CLOUD_AUDIOCOM_API AuthStateChangedMessage final
{
   std::string_view accessToken;
   std::string_view errorMessage;
   bool authorised;
};
 
class CLOUD_AUDIOCOM_API OAuthService final :
    public Observer::Publisher<AuthStateChangedMessage>
{
public:
   bool HasAccessToken() const;
   bool HasRefreshToken() const;
 
   /*
      If `HasAccessToken() || !HasRefreshToken()` invokes \p completedHandler synchronously,
      if valid.
 
      Otherwise, the service will attempt to authorize the user and invoke
      \p completedHandler (if valid). Callback is invoked from the network thread.
 
      Callback argument will contain an access token, if any, or an empty view.
   */
   void ValidateAuth(std::function<void(std::string_view)> completedHandler);
 
   /*
      This method supports the following URLs:
      - audacity://link?authorization_code=code
      - audacity://link?token=refresh_token
      - audacity://link?username=user&password=password
 
      This method will attempt to perform OAuth2 authorization and invoke \p completedHandler (if valid).
      Callback is potentially called from the network thread.
   */
   void HandleLinkURI(
      std::string_view uri,
      std::function<void(std::string_view)> completedHandler);
 
   void UnlinkAccount();
 
   std::string GetAccessToken() const;
 
private:
   void AuthorisePassword(
      const ServiceConfig& config, std::string_view userName,
      std::string_view password,
      std::function<void(std::string_view)> completedHandler);
 
   void AuthoriseRefreshToken(
      const ServiceConfig& config, std::string_view refreshToken,
      std::function<void(std::string_view)> completedHandler);
 
   void AuthoriseRefreshToken(
      const ServiceConfig& config,
      std::function<void(std::string_view)> completedHandler);
 
   void AuthoriseCode(
      const ServiceConfig& config, std::string_view authorizationCode,
      std::function<void(std::string_view)> completedHandler);
 
   void DoAuthorise(
      const ServiceConfig& config, std::string_view payload,
      std::function<void(std::string_view)> completedHandler);
 
   void SafePublish(const AuthStateChangedMessage& message);
 
   using Clock = std::chrono::steady_clock;
 
   mutable std::recursive_mutex mMutex;
 
   Clock::time_point mTokenExpirationTime;
   std::string mAccessToken;
};
 
 
CLOUD_AUDIOCOM_API OAuthService& GetOAuthService();
 
} // namespace cloud::audiocom