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

#include <OAuthService.h>

Inheritance diagram for audacity::cloud::audiocom::OAuthService:

Collaboration diagram for audacity::cloud::audiocom::OAuthService:

Public Types
using	AuthSuccessCallback = std::function< void(std::string_view)>

using	AuthFailureCallback = std::function< void(unsigned, std::string_view)>

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...

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 (AuthSuccessCallback completedHandler, AudiocomTrace, bool silent)
	Attempt to authorize the user. More...

bool	HandleLinkURI (std::string_view uri, AudiocomTrace, AuthSuccessCallback completedHandler)
	Handle the OAuth callback. More...

void	UnlinkAccount (AudiocomTrace)
	Removes access and refresh token, notifies about the logout. More...

std::string	GetAccessToken () const
	Return the current access token, if any. More...

std::string	MakeAudioComAuthorizeURL (std::string_view userId, std::string_view redirectUrl)
	Creates a link to authorize audio.com using current auth token. More...

void	Authorize (std::string_view email, std::string_view password, AuthSuccessCallback successCallback, AuthFailureCallback failureCallback, AudiocomTrace trace)

void	Register (std::string_view email, std::string_view password, AuthSuccessCallback successCallback, AuthFailureCallback failureCallback, AudiocomTrace trace)
	Register a new user with `email` and `password`. 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...

Static Public Member Functions
static std::string	MakeOAuthRequestURL (std::string_view authClientId)
	Creates a link to authorization request dialog. 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, AudiocomTrace, std::function< void(std::string_view)> completedHandler)

void	AuthoriseRefreshToken (const ServiceConfig &config, std::string_view refreshToken, AudiocomTrace, std::function< void(std::string_view)> completedHandler, bool silent)

void	AuthoriseRefreshToken (const ServiceConfig &config, AudiocomTrace, std::function< void(std::string_view)> completedHandler, bool silent)

void	AuthoriseCode (const ServiceConfig &config, std::string_view authorizationCode, bool useAudioComRedirectURI, AudiocomTrace, std::function< void(std::string_view)> completedHandler)

void	DoAuthorise (const ServiceConfig &config, std::string_view payload, AudiocomTrace, std::function< void(std::string_view)> completedHandler, bool silent)

void	ParseTokenResponse (std::string_view response, AuthSuccessCallback successCallback, AuthFailureCallback failureCallback, AudiocomTrace trace, bool silent)

void	SafePublish (const AuthStateChangedMessage &message)

Private Attributes
std::recursive_mutex	mMutex

Clock::time_point	mTokenExpirationTime

std::string	mAccessToken

Additional Inherited Members
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 41 of file OAuthService.h.

Member Typedef Documentation

◆ AuthFailureCallback

using audacity::cloud::audiocom::OAuthService::AuthFailureCallback = std::function<void(unsigned, std::string_view)>

Definition at line 46 of file OAuthService.h.

◆ AuthSuccessCallback

using audacity::cloud::audiocom::OAuthService::AuthSuccessCallback = std::function<void(std::string_view)>

Definition at line 45 of file OAuthService.h.

◆ Clock

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

private

Definition at line 142 of file OAuthService.h.

Member Function Documentation

◆ AuthoriseCode()

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

private

Definition at line 294 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 = useAudioComRedirectURI ? config.GetOAuthRedirectURL() : std::string("audacity://link");
 
   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() }, trace,
      std::move(completedHandler), false);
}

References DoAuthorise(), audacity::cloud::audiocom::ServiceConfig::GetOAuthRedirectURL(), and audacity::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 audacity::cloud::audiocom::OAuthService::AuthorisePassword	(	const ServiceConfig &	config,
		std::string_view	userName,
		std::string_view	password,
		AudiocomTrace	trace,
		std::function< void(std::string_view)>	completedHandler
	)

private

Definition at line 230 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() }, trace,
      std::move(completedHandler), false);
}

References DoAuthorise(), audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::userName, and audacity::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 audacity::cloud::audiocom::OAuthService::AuthoriseRefreshToken	(	const ServiceConfig &	config,
		AudiocomTrace	trace,
		std::function< void(std::string_view)>	completedHandler,
		bool	silent
	)

private

Definition at line 283 of file OAuthService.cpp.

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

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

Here is the call graph for this function:

◆ AuthoriseRefreshToken() [2/2]

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

private

Definition at line 259 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() }, trace,
      std::move(completedHandler), silent);
}

References DoAuthorise(), and audacity::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:

◆ Authorize()

void audacity::cloud::audiocom::OAuthService::Authorize	(	std::string_view	email,
		std::string_view	password,
		AuthSuccessCallback	successCallback,
		AuthFailureCallback	failureCallback,
		AudiocomTrace	trace
	)

Definition at line 376 of file OAuthService.cpp.

{
   using namespace audacity::network_manager;
   using rapidjson::StringRef;
 
   rapidjson::Document document;
   document.SetObject();
 
   WriteCommonFields(document, "password", "all");
 
   document.AddMember(
      "username", StringRef(email.data(), email.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);
 
   Request request(GetServiceConfig().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,  buffer.GetString(), buffer.GetSize());
   response->setRequestFinishedCallback(
      [response, this, trace,
         onSuccess = std::move(onSuccess),
         onFailure = std::move(onFailure)](auto) mutable
      {
         const auto httpCode = response->getHTTPCode();
         const auto body = response->readAll<std::string>();
         if(httpCode == 200)
            ParseTokenResponse(body, std::move(onSuccess), std::move(onFailure), trace, false);
         else
         {
            if(onFailure)
               onFailure(httpCode, body);
 
            SafePublish({ {}, body, trace, false, false });
         }
      });
}

References audacity::network_manager::common_headers::Accept, audacity::network_manager::common_content_types::ApplicationJson, audacity::network_manager::common_headers::ContentType, audacity::network_manager::NetworkManager::doPost(), audacity::network_manager::NetworkManager::GetInstance(), audacity::cloud::audiocom::GetServiceConfig(), ParseTokenResponse(), SafePublish(), audacity::network_manager::Request::setHeader(), and audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::WriteCommonFields().

Here is the call graph for this function:

◆ DoAuthorise()

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

private

Definition at line 476 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), silent,
       trace](auto) mutable {
         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, trace] { UnlinkAccount(trace); });
            else
               SafePublish({ {}, body, trace, false, silent });
 
            return;
         }
         ParseTokenResponse(body, std::move(handler), {}, trace, silent);
      });
}

References audacity::network_manager::common_headers::Accept, audacity::network_manager::common_content_types::ApplicationJson, BasicUI::CallAfter(), audacity::network_manager::common_headers::ContentType, audacity::network_manager::NetworkManager::doPost(), audacity::cloud::audiocom::ServiceConfig::GetAPIUrl(), audacity::network_manager::NetworkManager::GetInstance(), audacity::cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::handler, ParseTokenResponse(), SafePublish(), audacity::network_manager::Request::setHeader(), and UnlinkAccount().

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 audacity::cloud::audiocom::OAuthService::GetAccessToken ( ) const

Return the current access token, if any.

Definition at line 335 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(), MakeAudioComAuthorizeURL(), audacity::cloud::audiocom::sync::LocalProjectSnapshot::UpdateProjectSnapshot(), and ValidateAuth().

Here is the caller graph for this function:

◆ HandleLinkURI()

bool audacity::cloud::audiocom::OAuthService::HandleLinkURI	(	std::string_view	uri,
		AudiocomTrace	trace,
		AuthSuccessCallback	completedHandler
	)

Handle the OAuth callback.

Definition at line 126 of file OAuthService.cpp.

{
   if (!IsPrefixedInsensitive(uri, uriPrefix))
   {
      if (completedHandler)
         completedHandler({});
      return false;
   }
 
   // It was observed, that sometimes link is passed as audacity://link/
   // This is valid trace 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 false;
   }
 
   // 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;
   auto useAudioComRedirectURI = false;
 
   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))
      {
         //authorization code was generated for audio.com, not audacity...
         useAudioComRedirectURI = true;
         authorizationCode = arg.substr(authorizationCodePrefix.length());
      }
      else if (IsPrefixed(arg, codePrefix))
         authorizationCode = arg.substr(codePrefix.length());
   }
 
   // Some browsers (safari) add an extra trailing chars we don't need
   size_t hashPos = authorizationCode.find('#');
    
   if (hashPos != std::string::npos) {
      authorizationCode = authorizationCode.substr(0, hashPos);
   }
 
   // We have a prioritized list of authorization methods
   if (!authorizationCode.empty())
   {
      AuthoriseCode(
         GetServiceConfig(), authorizationCode, useAudioComRedirectURI, trace,
         std::move(completedHandler));
   }
   else if (!token.empty())
   {
      AuthoriseRefreshToken(
         GetServiceConfig(), token, trace, std::move(completedHandler), false);
   }
   else if (!username.empty() && !password.empty())
   {
      AuthorisePassword(
         GetServiceConfig(), audacity::UrlDecode(std::string(username)),
         audacity::UrlDecode(std::string(password)), trace,
         std::move(completedHandler));
   }
   else
   {
      if (completedHandler)
         completedHandler({});
 
      return false;
   }
 
   return true;
}

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

Referenced by audacity::cloud::audiocom::LinkWithTokenDialog::OnContinue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasAccessToken()

bool audacity::cloud::audiocom::OAuthService::HasAccessToken ( ) const

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

Definition at line 324 of file OAuthService.cpp.

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

References GetAccessToken().

Referenced by audacity::cloud::audiocom::anonymous_namespace{CloudSyncService.cpp}::PerformProjectGetRequest(), and ValidateAuth().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasRefreshToken()

bool audacity::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 329 of file OAuthService.cpp.

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

References mMutex, Setting< T >::Read(), and audacity::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:

◆ MakeAudioComAuthorizeURL()

std::string audacity::cloud::audiocom::OAuthService::MakeAudioComAuthorizeURL	(	std::string_view	userId,
		std::string_view	redirectUrl
	)

Creates a link to authorize audio.com using current auth token.

Definition at line 358 of file OAuthService.cpp.

{
   auto token = GetAccessToken();
 
   // Remove token type from the token string
   size_t pos = token.find(' ');
   if (pos != std::string::npos) {
      token = token.substr(pos + 1);
   }
 
   return concat(
      GetServiceConfig().GetAuthWithRedirectURL(), "?",
      tokenPrefix, token, "&",
      userPrefix, userId, "&",
      urlPrefix, redirectUrl
   );
}

References audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::concat(), GetAccessToken(), audacity::cloud::audiocom::GetServiceConfig(), Tuple::detail::npos(), audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::tokenPrefix, audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::urlPrefix, audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::userId, and audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::userPrefix.

Here is the call graph for this function:

◆ MakeOAuthRequestURL()

std::string audacity::cloud::audiocom::OAuthService::MakeOAuthRequestURL ( std::string_view authClientId )

static

Creates a link to authorization request dialog.

Definition at line 345 of file OAuthService.cpp.

{
   using namespace audacity::network_manager;
 
   return concat(
      GetServiceConfig().GetAPIUrl("/auth/authorize?"),
      authClientPrefix, authClientId, "&",
      responseTypePrefix, "code", "&",
      clientIdPrefix, GetServiceConfig().GetOAuthClientID(),
      "&redirect_uri=audacity://link"
   );
}

References audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::authClientPrefix, audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::clientIdPrefix, audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::concat(), audacity::cloud::audiocom::GetServiceConfig(), and audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::responseTypePrefix.

Referenced by LoginDialog::ContinueAuthorize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseTokenResponse()

void audacity::cloud::audiocom::OAuthService::ParseTokenResponse	(	std::string_view	response,
		AuthSuccessCallback	successCallback,
		AuthFailureCallback	failureCallback,
		AudiocomTrace	trace,
		bool	silent
	)

private

Definition at line 516 of file OAuthService.cpp.

{
   rapidjson::Document document;
   document.Parse(body.data(), body.size());
 
   if (!document.IsObject())
   {
      if (failureCallback)
         failureCallback(200, body);
 
      SafePublish({ {}, body, trace, false, silent });
      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 (successCallback)
      successCallback(mAccessToken);
 
   // The callback only needs the access token, so invoke it immediately.
   // Networking is thread safe
   SafePublish({ mAccessToken, {}, trace, true, silent });
}

References BasicUI::CallAfter(), audacity::BasicSettings::Flush(), gPrefs, mAccessToken, mMutex, mTokenExpirationTime, audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::refreshToken, SafePublish(), and Setting< T >::Write().

Referenced by Authorize(), DoAuthorise(), and Register().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Register()

void audacity::cloud::audiocom::OAuthService::Register	(	std::string_view	email,
		std::string_view	password,
		AuthSuccessCallback	successCallback,
		AuthFailureCallback	failureCallback,
		AudiocomTrace	trace
	)

Register a new user with email and password.

Definition at line 426 of file OAuthService.cpp.

{
   using namespace audacity::network_manager;
   using rapidjson::StringRef;
 
   rapidjson::Document document;
   document.SetObject();
 
   WriteClientFields(document);
 
   document.AddMember(
      "email", StringRef(email.data(), email.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);
 
   Request request(GetServiceConfig().GetAPIUrl("/auth/register"));
   request.setHeader(common_headers::ContentType, common_content_types::ApplicationJson);
   request.setHeader(common_headers::Accept, common_content_types::ApplicationJson);
 
   auto response = NetworkManager::GetInstance().doPost(request,  buffer.GetString(), buffer.GetSize());
   response->setRequestFinishedCallback(
      [response, this, trace,
          successCallback = std::move(successCallback),
          failureCallback = std::move(failureCallback)] (auto) mutable
      {
         const auto httpCode = response->getHTTPCode();
         const auto body = response->readAll<std::string>();
         if(httpCode == 200)
            ParseTokenResponse(body, std::move(successCallback), std::move(failureCallback), trace, false);
         else
         {
            if(failureCallback)
               failureCallback(httpCode, body);
 
            SafePublish({ {}, body, trace, false, false });
         }
      });
}

References audacity::network_manager::common_headers::Accept, audacity::network_manager::common_content_types::ApplicationJson, audacity::network_manager::common_headers::ContentType, audacity::network_manager::NetworkManager::doPost(), audacity::network_manager::NetworkManager::GetInstance(), audacity::cloud::audiocom::GetServiceConfig(), ParseTokenResponse(), SafePublish(), audacity::network_manager::Request::setHeader(), and audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::WriteClientFields().

Here is the call graph for this function:

◆ SafePublish()

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

private

Definition at line 564 of file OAuthService.cpp.

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

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

Referenced by Authorize(), DoAuthorise(), ParseTokenResponse(), and Register().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UnlinkAccount()

void audacity::cloud::audiocom::OAuthService::UnlinkAccount ( AudiocomTrace trace )

Removes access and refresh token, notifies about the logout.

Definition at line 217 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({ {}, {}, trace, false });
}

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

Referenced by DoAuthorise(), audacity::cloud::audiocom::sync::ProjectCloudUIExtension::OnCloudStatusChanged(), and audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::OAuthServiceSettingsResetHandler::OnSettingResetEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ValidateAuth()

void audacity::cloud::audiocom::OAuthService::ValidateAuth	(	AuthSuccessCallback	completedHandler,
		AudiocomTrace	trace,
		bool	silent
	)

Attempt to authorize the user.

Definition at line 111 of file OAuthService.cpp.

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

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

Referenced by audacity::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 audacity::cloud::audiocom::OAuthService::mAccessToken

private

Definition at line 147 of file OAuthService.h.

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

◆ mMutex

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

mutableprivate

Definition at line 144 of file OAuthService.h.

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

◆ mTokenExpirationTime

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

private

Definition at line 146 of file OAuthService.h.

Referenced by GetAccessToken(), and ParseTokenResponse().

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

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AuthFailureCallback

◆ AuthSuccessCallback

◆ Clock

Member Function Documentation

◆ AuthoriseCode()

◆ AuthorisePassword()

◆ AuthoriseRefreshToken() [1/2]

◆ AuthoriseRefreshToken() [2/2]

◆ Authorize()

◆ DoAuthorise()

◆ GetAccessToken()

◆ HandleLinkURI()

◆ HasAccessToken()

◆ HasRefreshToken()

◆ MakeAudioComAuthorizeURL()

◆ MakeOAuthRequestURL()

◆ ParseTokenResponse()

◆ Register()

◆ SafePublish()

◆ UnlinkAccount()

◆ ValidateAuth()

Member Data Documentation

◆ mAccessToken

◆ mMutex

◆ mTokenExpirationTime