audacity::cloud::audiocom Namespace Reference

Namespaces
namespace	anonymous_namespace{AuthorizationHandler.cpp}
namespace	anonymous_namespace{CloudSyncService.cpp}
namespace	anonymous_namespace{NetworkUtils.cpp}
namespace	anonymous_namespace{OAuthService.cpp}
namespace	anonymous_namespace{ServiceConfig.cpp}
namespace	anonymous_namespace{ShareAudioDialog.cpp}
namespace	anonymous_namespace{UploadService.cpp}
namespace	anonymous_namespace{UserPanel.cpp}
namespace	anonymous_namespace{UserService.cpp}
namespace	sync

Classes
class	AuthorizationHandler
struct	AuthResult
struct	AuthStateChangedMessage
	Message that is sent when authorization state changes. More...
class	CloudSyncService
class	LinkFailedDialog
class	LinkSucceededDialog
class	LinkWithTokenDialog
class	OAuthService
	Service responsible for OAuth authentication against the audio.com service. More...
struct	ResponseResult
class	ServiceConfig
	Configuration for the audio.com. More...
class	ShareAudioDialog
struct	TransferStats
struct	UploadFailedPayload
	This structure represents an upload error as returned by the server. More...
class	UploadOperation
	Class used to track the upload operation. More...
struct	UploadOperationCompleted
class	UploadOperationHandle
	A unique_ptr like class that holds a pointer to UploadOperation. More...
class	UploadService
	Service, responsible for uploading audio files to audio.com. More...
struct	UploadSuccessfulPayload
	This structure represents the payload associated with successful upload. More...
struct	UserDataChanged
class	UserImage
class	UserPanel
struct	UserPanelStateChangedMessage
class	UserService
	Service for providing information about the user profile. More...

Enumerations
enum class	SyncResultCode {   Success , Cancelled , Expired , Conflict ,   ConnectionFailed , PaymentRequired , TooLarge , Unauthorized ,   Forbidden , NotFound , UnexpectedResponse , InternalClientError ,   InternalServerError , SyncImpossible , UnknownError }

Functions
ResponseResult	GetResponseResult (IResponse &response, bool readBody)
void	SetCommonHeaders (Request &request)
bool	IsUploadRecoverable (SyncResultCode code)
OAuthService &	GetOAuthService ()
	Returns the instance of the OAuthService. More...
const ServiceConfig &	GetServiceConfig ()
	Returns the instance of the ServiceConfig. More...
wxString	GetUploadTempPath ()
UserService &	GetUserService ()
AuthorizationHandler &	GetAuthorizationHandler ()
AuthResult	PerformBlockingAuth (AudacityProject *project, AudiocomTrace trace, const TranslatableString &alternativeActionLabel)

Variables
StringSetting	CloudProjectsSavePath
IntSetting	DaysToKeepFiles

Detailed Description

---

Audacity: A Digital Audio Editor

CloudLibrarySettings.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

CloudLibrarySettings.h

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

CloudSyncService.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

NetworkUtils.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

OAuthService.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

ServiceConfig.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

DataUploader.h

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

UploadService.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

UserService.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

UserService.h

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

AuthorizationHandler.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

LinkFailedDialog.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

LinkSucceededDialog.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

LinkSucceededDialog.h

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

LinkAccountDialog.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

ShareAudioDialog.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

UserImage.cpp

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

UserImage.h

Dmitry Vedenko

---

Audacity: A Digital Audio Editor

UserPanel.cpp

Dmitry Vedenko

Enumeration Type Documentation

SyncResultCode

enum class audacity::cloud::audiocom::SyncResultCode

strong

Enumerator
Success
Cancelled
Expired
Conflict
ConnectionFailed
PaymentRequired
TooLarge
Unauthorized
Forbidden
NotFound
UnexpectedResponse
InternalClientError
InternalServerError
SyncImpossible
UnknownError

Definition at line 42 of file NetworkUtils.h.

{
   Success,
   Cancelled,
   Expired,
   Conflict,
   ConnectionFailed,
   PaymentRequired,
   TooLarge,
   Unauthorized,
   Forbidden,
   NotFound,
   UnexpectedResponse,
   InternalClientError,
   InternalServerError,
   SyncImpossible,
   UnknownError,
}; // enum class ResponseResultCode

Function Documentation

GetAuthorizationHandler()

AuthorizationHandler & audacity::cloud::audiocom::GetAuthorizationHandler

(

)

Definition at line 73 of file AuthorizationHandler.cpp.

{
   return handler;
}

References audacity::cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::handler.

Referenced by audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::CloudProjectPropertiesDialog(), PerformBlockingAuth(), audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::~CloudProjectPropertiesDialog(), audacity::cloud::audiocom::LinkWithTokenDialog::~LinkWithTokenDialog(), and audacity::cloud::audiocom::ShareAudioDialog::~ShareAudioDialog().

Here is the caller graph for this function:

GetOAuthService()

CLOUD_AUDIOCOM_API OAuthService & audacity::cloud::audiocom::GetOAuthService

(

)

Returns the instance of the OAuthService.

Definition at line 382 of file OAuthService.cpp.

{
   static OAuthService service;
   return service;
}

Referenced by audacity::cloud::audiocom::CloudSyncService::GetHeadSnapshotID(), audacity::cloud::audiocom::CloudSyncService::GetProjects(), audacity::cloud::audiocom::sync::ProjectCloudUIExtension::OnCloudStatusChanged(), audacity::cloud::audiocom::LinkWithTokenDialog::OnContinue(), audacity::cloud::audiocom::UserPanel::OnLinkButtonPressed(), anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::OnSave(), audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::OAuthServiceSettingsResetHandler::OnSettingResetEnd(), audacity::cloud::audiocom::CloudSyncService::OpenFromCloud(), PerformBlockingAuth(), anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::PerformCloudSave(), audacity::cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateInitialStatePanel(), anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::PopulateOrExchange(), SetCommonHeaders(), audacity::cloud::audiocom::CloudSyncService::SyncProject(), audacity::cloud::audiocom::UserService::UpdateUserData(), audacity::cloud::audiocom::UserPanel::UpdateUserData(), and audacity::cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::WaitForAuth().

Here is the caller graph for this function:

GetResponseResult()

ResponseResult audacity::cloud::audiocom::GetResponseResult	(	IResponse &	response,
		bool	readBody
	)

Definition at line 86 of file NetworkUtils.cpp.

{
   const auto resultCode = GuessResultCode(response);
 
   if (resultCode == SyncResultCode::Success)
      return { resultCode,
               readBody ? response.readAll<std::string>() : std::string {} };
 
   if (response.getError() != NetworkError::HTTPError)
      return { resultCode, response.getErrorString() };
 
   return { resultCode,
            std::string("HTTP ") + std::to_string(response.getHTTPCode()) +
               std::string("\n") + response.readAll<std::string>() };
}

References audacity::network_manager::IResponse::getError(), audacity::network_manager::IResponse::getErrorString(), audacity::network_manager::IResponse::getHTTPCode(), audacity::cloud::audiocom::anonymous_namespace{NetworkUtils.cpp}::GuessResultCode(), audacity::network_manager::IResponse::readAll(), and Success.

Referenced by audacity::cloud::audiocom::sync::DataUploader::UploadOperation::ConfirmUpload(), audacity::cloud::audiocom::sync::RemoteProjectSnapshot::DownloadBlob(), audacity::cloud::audiocom::sync::DataUploader::UploadOperation::FailUpload(), audacity::cloud::audiocom::CloudSyncService::GetProjects(), audacity::cloud::audiocom::anonymous_namespace{CloudSyncService.cpp}::PerformProjectGetRequest(), and audacity::cloud::audiocom::sync::DataUploader::UploadOperation::PerformUpload().

Here is the call graph for this function:

Here is the caller graph for this function:

GetServiceConfig()

CLOUD_AUDIOCOM_API const ServiceConfig & audacity::cloud::audiocom::GetServiceConfig

(

)

Returns the instance of the ServiceConfig.

Definition at line 373 of file ServiceConfig.cpp.

{
   static ServiceConfig config;
   return config;
}

Referenced by audacity::cloud::audiocom::sync::MixdownUploader::ExportProject(), audacity::cloud::audiocom::ShareAudioDialog::ExportProject(), audacity::cloud::audiocom::sync::ProjectCloudExtension::GetCloudProjectPage(), audacity::cloud::audiocom::CloudSyncService::GetHeadSnapshotID(), audacity::cloud::audiocom::CloudSyncService::GetProjects(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::GetSelectedProjectUrl(), audacity::cloud::audiocom::anonymous_namespace{UploadService.cpp}::GetUploadRequestPayload(), audacity::cloud::audiocom::OAuthService::HandleLinkURI(), audacity::cloud::audiocom::sync::ProjectCloudUIExtension::OnCloudStatusChanged(), anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::OnSave(), audacity::cloud::audiocom::CloudSyncService::OpenFromCloud(), anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::PerformCloudSave(), audacity::cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateInitialStatePanel(), anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::PopulateOrExchange(), audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::RefreshUrls(), audacity::cloud::audiocom::CloudSyncService::ReportUploadStats(), SetCommonHeaders(), audacity::cloud::audiocom::CloudSyncService::SyncProject(), audacity::cloud::audiocom::UserService::UpdateUserData(), audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::UploadBlocks(), audacity::cloud::audiocom::sync::UploadMixdown(), audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::UploadSnapshot(), audacity::cloud::audiocom::OAuthService::ValidateAuth(), and audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::WriteCommonFields().

Here is the caller graph for this function:

GetUploadTempPath()

CLOUD_AUDIOCOM_API wxString audacity::cloud::audiocom::GetUploadTempPath

(

)

Definition at line 628 of file UploadService.cpp.

{
   const auto tempPath = TempDirectory::DefaultTempDir();
 
   if (!wxDirExists(tempPath))
   {
      // Temp directory was not created yet.
      // Is it a first run of Audacity?
      // In any case, let's wait for some better time
      return {};
   }
 
   if (!FileNames::WritableLocationCheck(
          tempPath, XO("Cannot proceed to upload.")))
      return {};
 
   return tempPath + "/cloud/";
}

References TempDirectory::DefaultTempDir(), FileNames::WritableLocationCheck(), and XO().

Referenced by audacity::cloud::audiocom::sync::anonymous_namespace{MixdownUploader.cpp}::GenerateTempPath(), and audacity::cloud::audiocom::anonymous_namespace{ShareAudioDialog.cpp}::GenerateTempPath().

Here is the call graph for this function:

Here is the caller graph for this function:

GetUserService()

CLOUD_AUDIOCOM_API UserService & audacity::cloud::audiocom::GetUserService

(

)

Definition at line 139 of file UserService.cpp.

{
   static UserService userService;
   return userService;
}

Referenced by audacity::cloud::audiocom::sync::ProjectCloudUIExtension::OnCloudStatusChanged(), anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::OnSave(), audacity::cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateInitialStatePanel(), anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::PopulateOrExchange(), and audacity::cloud::audiocom::UserPanel::UpdateUserData().

Here is the caller graph for this function:

IsUploadRecoverable()

bool audacity::cloud::audiocom::IsUploadRecoverable

(

SyncResultCode

code

)

Definition at line 117 of file NetworkUtils.cpp.

{
   return code == SyncResultCode::Cancelled ||
          code == SyncResultCode::ConnectionFailed ||
          code == SyncResultCode::PaymentRequired ||
          code == SyncResultCode::Unauthorized ||
          code == SyncResultCode::Forbidden ||
          code == SyncResultCode::InternalClientError ||
          code == SyncResultCode::InternalServerError;
}

References Cancelled, ConnectionFailed, Forbidden, InternalClientError, InternalServerError, PaymentRequired, and Unauthorized.

Referenced by audacity::cloud::audiocom::sync::LocalProjectSnapshot::OnSnapshotCreated(), and audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::UploadSnapshot().

Here is the caller graph for this function:

PerformBlockingAuth()

AuthResult audacity::cloud::audiocom::PerformBlockingAuth	(	AudacityProject *	project,
		AudiocomTrace	trace,
		const TranslatableString &	alternativeActionLabel
	)

Definition at line 78 of file AuthorizationHandler.cpp.

{
   using namespace sync;
   auto& oauthService = GetOAuthService();
 
   // Assume, that the token is valid
   // Services will need to handle 403 errors and refresh the token
   if (GetOAuthService().HasAccessToken())
      return { AuthResult::Status::Authorised, {} };
 
   GetAuthorizationHandler().PushSuppressDialogs();
   auto popSuppress =
      finally([] { GetAuthorizationHandler().PopSuppressDialogs(); });
 
   if (oauthService.HasRefreshToken())
   {
      std::promise<std::optional<AuthResult>> promise;
 
      oauthService.ValidateAuth(
         [&promise](auto...) { promise.set_value({}); }, trace, true);
 
      if (auto waitResult = WaitForAuth(promise.get_future(), project))
         return *waitResult;
   }
 
   auto linkResult =
      sync::LinkAccountDialog { project, alternativeActionLabel }.ShowDialog();
 
   if (linkResult == LinkAccountDialog::CancelButtonIdentifier())
      return { AuthResult::Status::Cancelled, {} };
 
   if (linkResult == LinkAccountDialog::AlternativeButtonIdentifier())
      return { AuthResult::Status::UseAlternative, {} };
 
   std::promise<std::optional<AuthResult>> promise;
 
   auto authSubscription = oauthService.Subscribe(
      [&promise](auto& result)
      {
         promise.set_value(
            result.authorised ?
               AuthResult { AuthResult::Status::Authorised, {} } :
               AuthResult { AuthResult::Status::Failure,
                            std::string(result.errorMessage) });
      });
 
   OpenInDefaultBrowser(
      { audacity::ToWXString(GetServiceConfig().GetOAuthLoginPage(trace)) });
 
   auto waitResult = WaitForAuth(promise.get_future(), project);
 
   if (waitResult)
      return *waitResult;
 
   return AuthResult { AuthResult::Status::Failure, {} };
}

References audacity::cloud::audiocom::AuthResult::Authorised, audacity::cloud::audiocom::AuthResult::Cancelled, audacity::cloud::audiocom::AuthResult::Failure, GetAuthorizationHandler(), GetOAuthService(), audacity::cloud::audiocom::AuthorizationHandler::PopSuppressDialogs(), project, audacity::cloud::audiocom::AuthorizationHandler::PushSuppressDialogs(), audacity::cloud::audiocom::AuthResult::UseAlternative, and audacity::cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::WaitForAuth().

Referenced by anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::OnLoad(), audacity::cloud::audiocom::sync::OpenProjectFromCloud(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::Refresh(), anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::SaveCloudProject(), and audacity::cloud::audiocom::sync::SyncCloudProject().

Here is the call graph for this function:

Here is the caller graph for this function:

SetCommonHeaders()

void audacity::cloud::audiocom::SetCommonHeaders

(

Request &

request

)

Definition at line 102 of file NetworkUtils.cpp.

{
   const auto language = GetServiceConfig().GetAcceptLanguageValue();
 
   if (!language.empty())
      request.setHeader(
         audacity::network_manager::common_headers::AcceptLanguage, language);
 
   auto& oauthService = GetOAuthService();
 
   if (oauthService.HasAccessToken())
      request.setHeader(
         common_headers::Authorization, oauthService.GetAccessToken());
}

References audacity::network_manager::common_headers::AcceptLanguage, audacity::network_manager::common_headers::Authorization, audacity::cloud::audiocom::ServiceConfig::GetAcceptLanguageValue(), GetOAuthService(), GetServiceConfig(), and audacity::network_manager::Request::setHeader().

Referenced by audacity::cloud::audiocom::sync::LocalProjectSnapshot::DeleteSnapshot(), audacity::cloud::audiocom::CloudSyncService::GetProjects(), audacity::cloud::audiocom::sync::LocalProjectSnapshot::MarkSnapshotSynced(), audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::MarkSnapshotSynced(), audacity::cloud::audiocom::anonymous_namespace{CloudSyncService.cpp}::PerformProjectGetRequest(), audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::RefreshUrls(), and audacity::cloud::audiocom::CloudSyncService::ReportUploadStats().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

CloudProjectsSavePath

CLOUD_AUDIOCOM_API StringSetting audacity::cloud::audiocom::CloudProjectsSavePath

Initial value:

{
   "/cloud/audiocom/CloudProjectsSavePath",
   []
   {
      wxFileNameWrapper path { FileNames::DataDir(), "" };
      path.AppendDir("CloudProjects");
      return path.GetPath();
   }
}

Definition at line 18 of file CloudLibrarySettings.cpp.

Referenced by anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::Browse(), anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::Commit(), anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::OnSave(), anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::PopulateOrExchange(), and audacity::cloud::audiocom::CloudSyncService::SyncCloudSnapshot().

DaysToKeepFiles

CLOUD_AUDIOCOM_API IntSetting audacity::cloud::audiocom::DaysToKeepFiles

Initial value:

{
   "/cloud/audiocom/DaysToKeepFiles", 30
}

Definition at line 28 of file CloudLibrarySettings.cpp.

Referenced by anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::Commit(), audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncHousekeeper.cpp}::Housekeeper::PerformHousekeeping(), and anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::PopulateOrExchange().