cloud::audiocom::OAuthService Class Reference

Service responsible for OAuth authentication against the audio.com service. More...

#include <OAuthService.h>

Inheritance diagram for cloud::audiocom::OAuthService:

Collaboration diagram for cloud::audiocom::OAuthService:

Public Member Functions
bool	HasAccessToken () const
	Indicates, that service has a valid access token, i. e. that the user is authorized. More...
bool	HasRefreshToken () const
void	ValidateAuth (std::function< void(std::string_view)> completedHandler)
	Attempt to authorize the user. More...
void	HandleLinkURI (std::string_view uri, std::function< void(std::string_view)> completedHandler)
	Handle the OAuth callback. More...
void	UnlinkAccount ()
	Removes access and refresh token, notifies about the logout. More...
std::string	GetAccessToken () const
	Return the current access token, if any. More...
Public Member Functions inherited from Observer::Publisher< AuthStateChangedMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Private Types
using	Clock = std::chrono::steady_clock

Private Member Functions
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)

Private Attributes
std::recursive_mutex	mMutex
Clock::time_point	mTokenExpirationTime
std::string	mAccessToken

Additional Inherited Members
Public Types inherited from Observer::Publisher< AuthStateChangedMessage >
using	message_type = AuthStateChangedMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const AuthStateChangedMessage &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< AuthStateChangedMessage >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< AuthStateChangedMessage >
CallbackReturn	Publish (const AuthStateChangedMessage &message)
	Send a message to connected callbacks. More...

Detailed Description

Service responsible for OAuth authentication against the audio.com service.

Definition at line 36 of file OAuthService.h.

Member Typedef Documentation

Clock

using cloud::audiocom::OAuthService::Clock = std::chrono::steady_clock

private

Definition at line 102 of file OAuthService.h.

Member Function Documentation

AuthoriseCode()

void cloud::audiocom::OAuthService::AuthoriseCode ( const ServiceConfig &  config, std::string_view  authorizationCode, std::function< void(std::string_view)>  completedHandler  )

private

Definition at line 247 of file OAuthService.cpp.

{
   using namespace rapidjson;
 
   Document document;
   document.SetObject();
 
   WriteCommonFields(document, "authorization_code", "all");
 
   document.AddMember(
      "code", StringRef(authorizationCode.data(), authorizationCode.size()),
      document.GetAllocator());
 
   const auto redirectURI = config.GetOAuthRedirectURL();
 
   document.AddMember(
      "redirect_uri", StringRef(redirectURI.data(), redirectURI.size()),
      document.GetAllocator());
 
   rapidjson::StringBuffer buffer;
   rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
   document.Accept(writer);
 
   DoAuthorise(
      config, { buffer.GetString(), buffer.GetSize() },
      std::move(completedHandler));
}

References DoAuthorise(), cloud::audiocom::ServiceConfig::GetOAuthRedirectURL(), and cloud::audiocom::anonymous_namespace{OAuthService.cpp}::WriteCommonFields().

Referenced by HandleLinkURI().

Here is the call graph for this function:

Here is the caller graph for this function:

AuthorisePassword()

void cloud::audiocom::OAuthService::AuthorisePassword ( const ServiceConfig &  config, std::string_view  userName, std::string_view  password, std::function< void(std::string_view)>  completedHandler  )

private

Definition at line 183 of file OAuthService.cpp.

{
   using namespace rapidjson;
 
   Document document;
   document.SetObject();
 
   WriteCommonFields(document, "password", "all");
 
   document.AddMember(
      "username", StringRef(userName.data(), userName.size()),
      document.GetAllocator());
 
   document.AddMember(
      "password", StringRef(password.data(), password.size()),
      document.GetAllocator());
 
   rapidjson::StringBuffer buffer;
   rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
   document.Accept(writer);
 
   DoAuthorise(
      config, { buffer.GetString(), buffer.GetSize() },
      std::move(completedHandler));
}

References DoAuthorise(), cloud::audiocom::anonymous_namespace{UserService.cpp}::userName, and cloud::audiocom::anonymous_namespace{OAuthService.cpp}::WriteCommonFields().

Referenced by HandleLinkURI().

Here is the call graph for this function:

Here is the caller graph for this function:

AuthoriseRefreshToken() [1/2]

void cloud::audiocom::OAuthService::AuthoriseRefreshToken ( const ServiceConfig &  config, std::function< void(std::string_view)>  completedHandler  )

private

Definition at line 236 of file OAuthService.cpp.

{
   std::lock_guard<std::recursive_mutex> lock(mMutex);
 
   AuthoriseRefreshToken(
      config, audacity::ToUTF8(refreshToken.Read()),
      std::move(completedHandler));
}

References AuthoriseRefreshToken(), mMutex, Setting< T >::Read(), cloud::audiocom::anonymous_namespace{OAuthService.cpp}::refreshToken, and audacity::ToUTF8().

Here is the call graph for this function:

AuthoriseRefreshToken() [2/2]

void cloud::audiocom::OAuthService::AuthoriseRefreshToken ( const ServiceConfig &  config, std::string_view  refreshToken, std::function< void(std::string_view)>  completedHandler  )

private

Definition at line 212 of file OAuthService.cpp.

{
   using namespace rapidjson;
 
   Document document;
   document.SetObject();
 
   WriteCommonFields(document, "refresh_token", "");
 
   document.AddMember(
      "refresh_token", StringRef(token.data(), token.size()),
      document.GetAllocator());
 
   rapidjson::StringBuffer buffer;
   rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
   document.Accept(writer);
 
   DoAuthorise(
      config, { buffer.GetString(), buffer.GetSize() },
      std::move(completedHandler));
}

References DoAuthorise(), and cloud::audiocom::anonymous_namespace{OAuthService.cpp}::WriteCommonFields().

Referenced by AuthoriseRefreshToken(), HandleLinkURI(), and ValidateAuth().

Here is the call graph for this function:

Here is the caller graph for this function:

DoAuthorise()

void cloud::audiocom::OAuthService::DoAuthorise ( const ServiceConfig &  config, std::string_view  payload, std::function< void(std::string_view)>  completedHandler  )

private

Definition at line 298 of file OAuthService.cpp.

{
   using namespace audacity::network_manager;
 
   Request request(config.GetAPIUrl("/auth/token"));
 
   request.setHeader(
      common_headers::ContentType, common_content_types::ApplicationJson);
   
   request.setHeader(
      common_headers::Accept, common_content_types::ApplicationJson);
 
   auto response = NetworkManager::GetInstance().doPost(
      request, payload.data(), payload.size());
 
   response->setRequestFinishedCallback(
      [response, this, handler = std::move(completedHandler)](auto)
      {
         const auto httpCode = response->getHTTPCode();
         const auto body = response->readAll<std::string>();
 
         if (httpCode != 200)
         {
            if (handler)
               handler({});
 
            // Token has expired?
            if (httpCode == 422)
               BasicUI::CallAfter([this] { UnlinkAccount(); });
            else            
               SafePublish({ {}, body, false });
            
            return;
         }
 
         rapidjson::Document document;
         document.Parse(body.data(), body.size());
 
         if (!document.IsObject())
         {
            if (handler)
               handler({});
            
            SafePublish({ {}, body, false });
            return;
         }
 
         const auto tokenType = document["token_type"].GetString();
         const auto accessToken = document["access_token"].GetString();
         const auto expiresIn = document["expires_in"].GetInt64();
         const auto newRefreshToken = document["refresh_token"].GetString();
 
         {
            std::lock_guard<std::recursive_mutex> lock(mMutex);
 
            mAccessToken = std::string(tokenType) + " " + accessToken;
            mTokenExpirationTime =
               Clock::now() + std::chrono::seconds(expiresIn);
         }
 
         BasicUI::CallAfter(
            [token = std::string(newRefreshToken)]()
            {
               // At this point access token is already written,
               // only refresh token is updated.
               refreshToken.Write(token);
               gPrefs->Flush();
            });
 
         if (handler)
            handler(mAccessToken);
 
         // The callback only needs the access token, so invoke it immediately.
         // Networking is thread safe
         SafePublish({ mAccessToken, {}, true });
      });
}

References audacity::network_manager::common_headers::Accept, audacity::network_manager::common_content_types::ApplicationJson, BasicUI::CallAfter(), audacity::network_manager::common_headers::ContentType, audacity::BasicSettings::Flush(), cloud::audiocom::ServiceConfig::GetAPIUrl(), anonymous_namespace{FrameStatistics.cpp}::GetInstance(), gPrefs, cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::handler, mAccessToken, mMutex, mTokenExpirationTime, cloud::audiocom::anonymous_namespace{OAuthService.cpp}::refreshToken, SafePublish(), audacity::network_manager::Request::setHeader(), UnlinkAccount(), and Setting< T >::Write().

Referenced by AuthoriseCode(), AuthorisePassword(), and AuthoriseRefreshToken().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAccessToken()

std::string cloud::audiocom::OAuthService::GetAccessToken

(

)

const

Return the current access token, if any.

Definition at line 288 of file OAuthService.cpp.

{
   std::lock_guard<std::recursive_mutex> lock(mMutex);
   
   if (Clock::now() < mTokenExpirationTime)
      return mAccessToken;
 
   return {};
}

References mAccessToken, mMutex, and mTokenExpirationTime.

Referenced by HasAccessToken(), and ValidateAuth().

Here is the caller graph for this function:

HandleLinkURI()

void cloud::audiocom::OAuthService::HandleLinkURI	(	std::string_view	uri,
		std::function< void(std::string_view)>	completedHandler
	)

Handle the OAuth callback.

Definition at line 98 of file OAuthService.cpp.

{
   if (!IsPrefixed(uri, uriPrefix))
   {
      if (completedHandler)
         completedHandler({});
      return;
   }
 
   // It was observed, that sometimes link is passed as audacity://link/
   // This is valid from URI point of view, but we need to handle it separately
   const auto argsStart = uri.find("?");
 
   if (argsStart == std::string_view::npos)
   {
      if (completedHandler)
         completedHandler({});
      return;
   }
 
   // Length is handled in IsPrefixed
   auto args = uri.substr(argsStart + 1);
 
   std::string_view token;
   std::string_view username;
   std::string_view password;
   std::string_view authorizationCode;
 
   while (!args.empty())
   {
      const auto nextArg = args.find('&');
 
      const auto arg = args.substr(0, nextArg);
      args = nextArg == std::string_view::npos ? "" : args.substr(nextArg + 1);
 
      if (IsPrefixed(arg, usernamePrefix))
         username = arg.substr(usernamePrefix.length());
      else if (IsPrefixed(arg, passwordPrefix))
         password = arg.substr(passwordPrefix.length());
      else if (IsPrefixed(arg, tokenPrefix))
         token = arg.substr(tokenPrefix.length());
      else if (IsPrefixed(arg, authorizationCodePrefix))
         authorizationCode = arg.substr(authorizationCodePrefix.length());
   }
 
   // We have a prioritized list of authorization methods
   if (!authorizationCode.empty())
   {
      AuthoriseCode(
         GetServiceConfig(), authorizationCode, std::move(completedHandler));
   }
   else if (!token.empty())
   {
      AuthoriseRefreshToken(
         GetServiceConfig(), token, std::move(completedHandler));
   }
   else if (!username.empty() && !password.empty())
   {
      AuthorisePassword(
         GetServiceConfig(),
         audacity::UrlDecode(std::string(username)),
         audacity::UrlDecode(std::string(password)),
         std::move(completedHandler));
   }
   else
   {
      if (completedHandler)
         completedHandler({});
   }
}

References AuthoriseCode(), AuthorisePassword(), AuthoriseRefreshToken(), cloud::audiocom::anonymous_namespace{OAuthService.cpp}::authorizationCodePrefix, cloud::audiocom::GetServiceConfig(), cloud::audiocom::anonymous_namespace{OAuthService.cpp}::IsPrefixed(), Tuple::detail::npos(), cloud::audiocom::anonymous_namespace{OAuthService.cpp}::passwordPrefix, cloud::audiocom::anonymous_namespace{OAuthService.cpp}::tokenPrefix, cloud::audiocom::anonymous_namespace{OAuthService.cpp}::uriPrefix, audacity::UrlDecode(), and cloud::audiocom::anonymous_namespace{OAuthService.cpp}::usernamePrefix.

Referenced by cloud::audiocom::LinkAccountDialog::OnContinue().

Here is the call graph for this function:

Here is the caller graph for this function:

HasAccessToken()

bool cloud::audiocom::OAuthService::HasAccessToken

(

)

const

Indicates, that service has a valid access token, i. e. that the user is authorized.

Definition at line 277 of file OAuthService.cpp.

{
   return !GetAccessToken().empty();
}

References GetAccessToken().

Referenced by ValidateAuth().

Here is the call graph for this function:

Here is the caller graph for this function:

HasRefreshToken()

bool cloud::audiocom::OAuthService::HasRefreshToken

(

)

const

Indicates, that the service has a possibly valid refresh token, which can be used to authorize the user

Definition at line 282 of file OAuthService.cpp.

{
   std::lock_guard<std::recursive_mutex> lock(mMutex);
   return !refreshToken.Read().empty();
}

References mMutex, Setting< T >::Read(), and cloud::audiocom::anonymous_namespace{OAuthService.cpp}::refreshToken.

Referenced by ValidateAuth().

Here is the call graph for this function:

Here is the caller graph for this function:

SafePublish()

void cloud::audiocom::OAuthService::SafePublish ( const AuthStateChangedMessage &  message )

private

Definition at line 378 of file OAuthService.cpp.

{
   BasicUI::CallAfter([this, message]() { Publish(message); });
}

References BasicUI::CallAfter(), and Observer::Publisher< AuthStateChangedMessage >::Publish().

Referenced by DoAuthorise().

Here is the call graph for this function:

Here is the caller graph for this function:

UnlinkAccount()

void cloud::audiocom::OAuthService::UnlinkAccount

(

)

Removes access and refresh token, notifies about the logout.

Definition at line 170 of file OAuthService.cpp.

{
   std::lock_guard<std::recursive_mutex> lock(mMutex);
 
   mAccessToken.clear();
   refreshToken.Write({});
   gPrefs->Flush();
 
   // Unlink account is expected to be called only
   // on UI thread
   Publish({ {}, {}, false });
}

References audacity::BasicSettings::Flush(), gPrefs, mAccessToken, mMutex, Observer::Publisher< AuthStateChangedMessage >::Publish(), cloud::audiocom::anonymous_namespace{OAuthService.cpp}::refreshToken, and Setting< T >::Write().

Referenced by DoAuthorise().

Here is the call graph for this function:

Here is the caller graph for this function:

ValidateAuth()

void cloud::audiocom::OAuthService::ValidateAuth

(

std::function< void(std::string_view)>

completedHandler

)

Attempt to authorize the user.

Definition at line 85 of file OAuthService.cpp.

{
   if (HasAccessToken() || !HasRefreshToken())
   {
      if (completedHandler)
         completedHandler(GetAccessToken());
      return;
   }
 
   AuthoriseRefreshToken(GetServiceConfig(), std::move(completedHandler));
}

References AuthoriseRefreshToken(), GetAccessToken(), cloud::audiocom::GetServiceConfig(), HasAccessToken(), and HasRefreshToken().

Referenced by cloud::audiocom::UploadService::Upload().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mAccessToken

std::string cloud::audiocom::OAuthService::mAccessToken

private

Definition at line 107 of file OAuthService.h.

Referenced by DoAuthorise(), GetAccessToken(), and UnlinkAccount().

mMutex

std::recursive_mutex cloud::audiocom::OAuthService::mMutex

mutableprivate

Definition at line 104 of file OAuthService.h.

Referenced by AuthoriseRefreshToken(), DoAuthorise(), GetAccessToken(), HasRefreshToken(), and UnlinkAccount().

mTokenExpirationTime

Clock::time_point cloud::audiocom::OAuthService::mTokenExpirationTime

private

Definition at line 106 of file OAuthService.h.

Referenced by DoAuthorise(), and GetAccessToken().

---

The documentation for this class was generated from the following files:

• OAuthService.h
• OAuthService.cpp