audacity::cloud::audiocom::sync::ProjectCloudUIExtension Class Reference

#include <ProjectCloudUIExtension.h>

Inheritance diagram for audacity::cloud::audiocom::sync::ProjectCloudUIExtension:

Collaboration diagram for audacity::cloud::audiocom::sync::ProjectCloudUIExtension:

Public Member Functions
	ProjectCloudUIExtension (AudacityProject &project)
	~ProjectCloudUIExtension () override
bool	AllowClosing ()
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static ProjectCloudUIExtension &	Get (AudacityProject &project)
static const ProjectCloudUIExtension &	Get (const AudacityProject &project)

Private Member Functions
void	SetUploadProgress (double progress)
void	OnCloudStatusChanged (const CloudStatusChangedMessage &message)

Private Attributes
AudacityProject &	mProject
std::unique_ptr< BasicUI::ProgressDialog >	mProgressDialog
double	mProgress { 0.0 }
std::atomic< bool >	mInSync { false }
bool	mClosingCancelled { false }
Observer::Subscription	mCloudStatusChangedSubscription

Detailed Description

Definition at line 29 of file ProjectCloudUIExtension.h.

Constructor & Destructor Documentation

ProjectCloudUIExtension()

audacity::cloud::audiocom::sync::ProjectCloudUIExtension::ProjectCloudUIExtension ( AudacityProject &  project )

explicit

Definition at line 50 of file ProjectCloudUIExtension.cpp.

    : mProject { project }
    , mCloudStatusChangedSubscription {
       ProjectCloudExtension::Get(project).SubscribeStatusChanged(
          [this](const auto& status) { OnCloudStatusChanged(status); }, true)
    }
{
}

References OnCloudStatusChanged().

Here is the call graph for this function:

~ProjectCloudUIExtension()

audacity::cloud::audiocom::sync::ProjectCloudUIExtension::~ProjectCloudUIExtension ( )

overridedefault

Member Function Documentation

AllowClosing()

bool audacity::cloud::audiocom::sync::ProjectCloudUIExtension::AllowClosing

(

)

Definition at line 77 of file ProjectCloudUIExtension.cpp.

{
   while (mInSync.load(std::memory_order_acquire) && !mClosingCancelled)
   {
      if (mProgressDialog == nullptr)
      {
         mProgressDialog = BasicUI::MakeProgress(
            XO("Save to audio.com"),
            XO("Project is syncing with audio.com. Do you want to stop the sync process?"),
            BasicUI::ProgressShowCancel | BasicUI::ProgressShowStop);
      }
 
      const auto result = mProgressDialog->Poll(mProgress * 10000, 10000);
 
      if (result == BasicUI::ProgressResult::Cancelled)
      {
         mClosingCancelled = true;
         mProgressDialog.reset();
      }
 
      if (result == BasicUI::ProgressResult::Stopped)
         ProjectCloudExtension::Get(mProject).CancelSync();
 
      BasicUI::Yield();
   }
 
   bool closingCancelled = mClosingCancelled;
   mClosingCancelled     = false;
 
   mProgressDialog.reset();
 
   return !mInSync.load(std::memory_order_acquire) || !closingCancelled;
}

References BasicUI::Cancelled, BasicUI::Get(), BasicUI::MakeProgress(), BasicUI::ProgressShowCancel, BasicUI::ProgressShowStop, BasicUI::Stopped, XO(), and BasicUI::Yield().

Here is the call graph for this function:

Get() [1/2]

ProjectCloudUIExtension & audacity::cloud::audiocom::sync::ProjectCloudUIExtension::Get ( AudacityProject &  project )

static

Definition at line 61 of file ProjectCloudUIExtension.cpp.

{
   return project.AttachedObjects::Get<ProjectCloudUIExtension&>(key);
}

References audacity::cloud::audiocom::sync::anonymous_namespace{ProjectCloudUIExtension.cpp}::key, and project.

Get() [2/2]

const ProjectCloudUIExtension & audacity::cloud::audiocom::sync::ProjectCloudUIExtension::Get ( const AudacityProject &  project )

static

Definition at line 67 of file ProjectCloudUIExtension.cpp.

{
   return Get(const_cast<AudacityProject&>(project));
}

References project.

OnCloudStatusChanged()

void audacity::cloud::audiocom::sync::ProjectCloudUIExtension::OnCloudStatusChanged ( const CloudStatusChangedMessage &  message )

private

Definition at line 111 of file ProjectCloudUIExtension.cpp.

{
   mInSync = message.IsSyncing();
 
   if (!mInSync)
      mProgressDialog.reset();
   else
      SetUploadProgress(message.Progress);
 
   // It the sync was successful - check for unsuccessful operations before
   if (message.Status == ProjectSyncStatus::Synced)
      ResumeProjectUpload(ProjectCloudExtension::Get(mProject), {});
 
   if (message.Status != ProjectSyncStatus::Failed || !message.Error)
      return;
 
   const auto error = *message.Error;
 
   switch (error.Type)
   {
   case CloudSyncError::Authorization:
      // How do we got here? Probable auth_token is invalid?
      GetOAuthService().UnlinkAccount();
      SaveToCloud(mProject, UploadMode::Normal);
      break;
   case CloudSyncError::ProjectLimitReached:
      [[fallthrough]];
   case CloudSyncError::ProjectStorageLimitReached:
   {
      auto result = ProjectLimitDialog { &mProject }.ShowDialog();
 
      if (result == ProjectLimitDialog::VisitAudioComIdentifier())
      {
         const auto slug = audacity::ToUTF8(GetUserService().GetUserSlug());
 
         BasicUI::OpenInDefaultBrowser(
            GetServiceConfig().GetProjectsPageUrl(slug));
 
         WaitForActionDialog {
            &mProject,
            XO("Waiting for space to free up"),
            XO("Once you have made storage space available on audio.com, click Retry."),
         }
            .ShowDialog();
         SaveToCloud(mProject, UploadMode::Normal);
      }
      else if (result == ProjectLimitDialog::SaveLocallyButtonIdentifier())
      {
         if (!ResaveLocally(mProject))
            SaveToCloud(mProject, UploadMode::Normal);
      }
   }
   break;
   case CloudSyncError::ProjectVersionConflict:
   {
      if (
         ProjectVersionConflictDialog { &mProject,
                                        ProjectVersionConflictDialogMode::Save }
            .ShowDialog() == ProjectVersionConflictDialog::UseLocalIdentifier())
      {
         SaveToCloud(mProject, UploadMode::ForceOverwrite);
      }
      else
      {
         ReopenProject(mProject);
      }
   }
   break;
   case CloudSyncError::ProjectNotFound:
   {
      if (
         NotCloudProjectDialog { &mProject }.ShowDialog() ==
         NotCloudProjectDialog::SaveLocallyIdentifier())
      {
         if (!ResaveLocally(mProject))
            SaveToCloud(mProject, UploadMode::CreateNew);
      }
      else
      {
         SaveToCloud(mProject, UploadMode::CreateNew);
      }
   }
   break;
   case CloudSyncError::Network:
   {
      ConnectionIssuesDialog { &mProject }.ShowDialog();
   }
   break;
   case CloudSyncError::DataUploadFailed:
      [[fallthrough]];
   case CloudSyncError::Server:
      [[fallthrough]];
   case CloudSyncError::ClientFailure:
      SyncFailedDialog::OnSave(error);
      break;
   case CloudSyncError::Cancelled:
      [[fallthrough]];
   default:
      break;
   }
 
   wxLogError(
      "Cloud sync has failed: %s", audacity::ToWXString(error.ErrorMessage));
}

References audacity::network_manager::common_headers::Authorization, RefreshCode::Cancelled, audacity::cloud::audiocom::sync::CloudStatusChangedMessage::Error, BasicUI::Get(), audacity::cloud::audiocom::GetOAuthService(), audacity::cloud::audiocom::GetServiceConfig(), audacity::cloud::audiocom::GetUserService(), audacity::cloud::audiocom::sync::CloudStatusChangedMessage::IsSyncing(), anonymous_namespace{FileMenus.cpp}::OnSave(), BasicUI::OpenInDefaultBrowser(), audacity::cloud::audiocom::sync::CloudStatusChangedMessage::Progress, audacity::cloud::audiocom::sync::ReopenProject(), audacity::cloud::audiocom::sync::ResaveLocally(), audacity::cloud::audiocom::sync::ResumeProjectUpload(), audacity::cloud::audiocom::sync::SaveToCloud(), audacity::cloud::audiocom::sync::AudioComDialogBase::ShowDialog(), audacity::cloud::audiocom::sync::CloudStatusChangedMessage::Status, audacity::ToUTF8(), audacity::ToWXString(), audacity::cloud::audiocom::OAuthService::UnlinkAccount(), and XO().

Referenced by ProjectCloudUIExtension().

Here is the call graph for this function:

Here is the caller graph for this function:

SetUploadProgress()

void audacity::cloud::audiocom::sync::ProjectCloudUIExtension::SetUploadProgress ( double  progress )

private

Definition at line 72 of file ProjectCloudUIExtension.cpp.

{
   mProgress = progress;
}

Member Data Documentation

mClosingCancelled

bool audacity::cloud::audiocom::sync::ProjectCloudUIExtension::mClosingCancelled { false }

private

Definition at line 51 of file ProjectCloudUIExtension.h.

mCloudStatusChangedSubscription

Observer::Subscription audacity::cloud::audiocom::sync::ProjectCloudUIExtension::mCloudStatusChangedSubscription

private

Definition at line 53 of file ProjectCloudUIExtension.h.

mInSync

std::atomic<bool> audacity::cloud::audiocom::sync::ProjectCloudUIExtension::mInSync { false }

private

Definition at line 50 of file ProjectCloudUIExtension.h.

mProgress

double audacity::cloud::audiocom::sync::ProjectCloudUIExtension::mProgress { 0.0 }

private

Definition at line 48 of file ProjectCloudUIExtension.h.

mProgressDialog

std::unique_ptr<BasicUI::ProgressDialog> audacity::cloud::audiocom::sync::ProjectCloudUIExtension::mProgressDialog

private

Definition at line 46 of file ProjectCloudUIExtension.h.

mProject

AudacityProject& audacity::cloud::audiocom::sync::ProjectCloudUIExtension::mProject

private

Definition at line 44 of file ProjectCloudUIExtension.h.

---

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

• ProjectCloudUIExtension.h
• ProjectCloudUIExtension.cpp