#include <ProjectCloudExtension.h>

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

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

Classes
struct	CloudStatusChangedNotifier

struct	UploadQueueElement

Public Member Functions
	ProjectCloudExtension (AudacityProject &project)

	~ProjectCloudExtension () override

bool	IsCloudProject () const

void	OnLoad ()

void	OnSyncStarted ()
	This method is called from the UI thread. More...

void	OnSyncResumed (std::shared_ptr< ProjectUploadOperation > uploadOperation, int64_t missingBlocksCount, bool needsProjectUpload)
	This method is called from the UI thread. More...

void	OnUploadOperationCreated (std::shared_ptr< ProjectUploadOperation > uploadOperation)
	This method is called from the UI thread. More...

void	OnBlocksHashed (ProjectUploadOperation &uploadOperation)
	This method is called not from the UI thread. More...

void	OnSnapshotCreated (const ProjectUploadOperation &uploadOperation, const CreateSnapshotResponse &response)
	This method is called from the network thread. More...

void	OnProjectDataUploaded (const ProjectUploadOperation &uploadOperation)
	This method is called from the network thread. More...

void	OnBlockUploaded (const ProjectUploadOperation &uploadOperation, std::string_view blockID, bool successful)
	This method is called from the network thread. More...

void	OnSyncCompleted (const ProjectUploadOperation *uploadOperation, std::optional< CloudSyncError > error)
	This method is called from any thread. More...

void	AbortLastUploadOperation ()

void	CancelSync ()

bool	IsSyncing () const

std::string	GetCloudProjectId () const

std::string	GetSnapshotId () const

void	OnUpdateSaved (const ProjectSerializer &serializer)

std::weak_ptr< AudacityProject >	GetProject () const

int64_t	GetSavesCount () const

Observer::Subscription	SubscribeStatusChanged (std::function< void(const CloudStatusChangedMessage &)> callback, bool onUIThread)

std::string	GetCloudProjectPage () const

bool	IsBlockLocked (int64_t blockID) const

ProjectSyncStatus	GetCurrentSyncStatus () const

bool	IsFirstSyncDialogShown () const

void	SetFirstSyncDialogShown (bool shown=true)

Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static ProjectCloudExtension &	Get (AudacityProject &project)

static const ProjectCloudExtension &	Get (const AudacityProject &project)

Private Member Functions
void	UpdateIdFromDatabase ()

void	UnsafeUpdateProgress ()

void	Publish (CloudStatusChangedMessage cloudStatus, bool canMerge)

void	MarkProjectSynced (bool success)

UploadQueueElement *	UnsafeFindUploadQueueElement (const ProjectUploadOperation &uploadOperation)

const UploadQueueElement *	UnsafeFindUploadQueueElement (const ProjectUploadOperation &uploadOperation) const

void	OnProjectPathChanged ()

Private Attributes
AudacityProject &	mProject

Observer::Subscription	mProjectPathChangedSubscription

std::mutex	mIdentifiersMutex

std::string	mProjectId

std::string	mSnapshotId

std::mutex	mUploadQueueMutex

std::vector< std::shared_ptr< UploadQueueElement > >	mUploadQueue

std::mutex	mStatusMutex

CloudStatusChangedMessage	mLastStatus

std::unique_ptr< CloudStatusChangedNotifier >	mAsyncStateNotifier

std::unique_ptr< CloudStatusChangedNotifier >	mUIStateNotifier

std::atomic< bool >	mUINotificationPending { false }

Detailed Description

Definition at line 55 of file ProjectCloudExtension.h.

Constructor & Destructor Documentation

◆ ProjectCloudExtension()

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

explicit

Definition at line 105 of file ProjectCloudExtension.cpp.

    : mProject { project }
    , mProjectPathChangedSubscription { ProjectFileIO::Get(project).Subscribe(
         [this](auto message)
         {
            if (message == ProjectFileIOMessage::ProjectFilePathChange)
               OnProjectPathChanged();
         }) }
    , mAsyncStateNotifier { std::make_unique<CloudStatusChangedNotifier>() }
    , mUIStateNotifier { std::make_unique<CloudStatusChangedNotifier>() }
{
   if (!ProjectFileIO::Get(project).IsTemporary())
      UpdateIdFromDatabase();
}

References OnProjectPathChanged(), and ProjectFilePathChange.

Here is the call graph for this function:

◆ ~ProjectCloudExtension()

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

overridedefault

Member Function Documentation

◆ AbortLastUploadOperation()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::AbortLastUploadOperation ( )

◆ CancelSync()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::CancelSync ( )

Definition at line 350 of file ProjectCloudExtension.cpp.

{
   std::vector<std::shared_ptr<UploadQueueElement>> queue;
 
   {
      auto lock = std::lock_guard { mUploadQueueMutex };
      std::swap(queue, mUploadQueue);
   }
 
   if (queue.empty())
      return;
 
   for (auto& item : queue)
   {
      if (!item->Operation)
         continue;
 
      item->Operation->Cancel();
   }
}

References anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

◆ Get() [1/2]

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

static

Definition at line 122 of file ProjectCloudExtension.cpp.

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

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

Referenced by audacity::cloud::audiocom::sync::GetOpenedProject(), audacity::cloud::audiocom::sync::OpenProjectFromCloud(), audacity::cloud::audiocom::sync::ReopenProject(), audacity::cloud::audiocom::sync::SaveToCloud(), and audacity::cloud::audiocom::sync::UploadMixdown().

Here is the caller graph for this function:

◆ Get() [2/2]

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

static

Definition at line 128 of file ProjectCloudExtension.cpp.

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

References project.

◆ GetCloudProjectId()

std::string audacity::cloud::audiocom::sync::ProjectCloudExtension::GetCloudProjectId ( ) const

Definition at line 378 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard { mIdentifiersMutex };
 
   return mProjectId;
}

Referenced by audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::GetHash(), audacity::cloud::audiocom::sync::GetOpenedProject(), audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::Perform(), audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::ProjectBlocksLock(), audacity::cloud::audiocom::sync::ResumeProjectUpload(), audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::UpdateProjectHashesInCache(), and audacity::cloud::audiocom::sync::LocalProjectSnapshot::UpdateProjectSnapshot().

Here is the caller graph for this function:

◆ GetCloudProjectPage()

std::string audacity::cloud::audiocom::sync::ProjectCloudExtension::GetCloudProjectPage ( ) const

Definition at line 614 of file ProjectCloudExtension.cpp.

{
   const auto projectId =
      ProjectCloudExtension::Get(mProject).GetCloudProjectId();
 
   const auto userSlug =
      CloudProjectsDatabase::Get().GetProjectUserSlug(projectId);
 
   return GetServiceConfig().GetProjectPageUrl(userSlug, projectId);
}

References BasicUI::Get(), audacity::cloud::audiocom::ServiceConfig::GetProjectPageUrl(), and audacity::cloud::audiocom::GetServiceConfig().

Here is the call graph for this function:

◆ GetCurrentSyncStatus()

ProjectSyncStatus audacity::cloud::audiocom::sync::ProjectCloudExtension::GetCurrentSyncStatus ( ) const

Definition at line 639 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard {
      const_cast<ProjectCloudExtension*>(this)->mStatusMutex
   };
 
   return mLastStatus.Status;
}

◆ GetProject()

std::weak_ptr< AudacityProject > audacity::cloud::audiocom::sync::ProjectCloudExtension::GetProject ( ) const

Definition at line 443 of file ProjectCloudExtension.cpp.

{
   return mProject.weak_from_this();
}

◆ GetSavesCount()

int64_t audacity::cloud::audiocom::sync::ProjectCloudExtension::GetSavesCount ( ) const

Definition at line 448 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard { mIdentifiersMutex };
 
   if (mProjectId.empty())
      return 0;
 
   auto& cloudDatabase = CloudProjectsDatabase::Get();
   auto dbData         = cloudDatabase.GetProjectData(mProjectId);
 
   if (!dbData)
      return 0;
 
   return dbData->SavesCount;
}

References BasicUI::Get().

Here is the call graph for this function:

◆ GetSnapshotId()

std::string audacity::cloud::audiocom::sync::ProjectCloudExtension::GetSnapshotId ( ) const

Definition at line 385 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard { mIdentifiersMutex };
 
   return mSnapshotId;
}

Referenced by audacity::cloud::audiocom::sync::OpenProjectFromCloud(), and audacity::cloud::audiocom::sync::LocalProjectSnapshot::UpdateProjectSnapshot().

Here is the caller graph for this function:

◆ IsBlockLocked()

bool audacity::cloud::audiocom::sync::ProjectCloudExtension::IsBlockLocked ( int64_t blockID ) const

Definition at line 625 of file ProjectCloudExtension.cpp.

{
   // Try load the project info first based on the
   // file path
   const_cast<ProjectCloudExtension*>(this)->OnLoad();
 
   const auto projectId = GetCloudProjectId();
 
   if (projectId.empty())
      return false;
 
   return CloudProjectsDatabase::Get().IsProjectBlockLocked(projectId, blockID);
}

References BasicUI::Get().

Here is the call graph for this function:

◆ IsCloudProject()

bool audacity::cloud::audiocom::sync::ProjectCloudExtension::IsCloudProject ( ) const

Definition at line 133 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard { mIdentifiersMutex };
   return !mProjectId.empty();
}

Referenced by audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::GetHash(), audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::ProjectBlocksLock(), audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::UpdateProjectHashesInCache(), and audacity::cloud::audiocom::sync::LocalProjectSnapshot::UpdateProjectSnapshot().

Here is the caller graph for this function:

◆ IsFirstSyncDialogShown()

bool audacity::cloud::audiocom::sync::ProjectCloudExtension::IsFirstSyncDialogShown ( ) const

Definition at line 648 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard { mIdentifiersMutex };
 
   if (mProjectId.empty())
      return false;
 
   return CloudProjectsDatabase::Get().IsFirstSyncDialogShown(mProjectId);
}

References BasicUI::Get().

Here is the call graph for this function:

◆ IsSyncing()

bool audacity::cloud::audiocom::sync::ProjectCloudExtension::IsSyncing ( ) const

Definition at line 371 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard { mStatusMutex };
 
   return mLastStatus.Status == ProjectSyncStatus::Syncing;
}

◆ MarkProjectSynced()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::MarkProjectSynced ( bool success )

private

Definition at line 552 of file ProjectCloudExtension.cpp.

{
   auto& cloudDatabase = CloudProjectsDatabase::Get();
 
   const auto projectFilePath =
      audacity::ToUTF8(ProjectFileIO::Get(mProject).GetFileName());
 
   auto previousDbData = cloudDatabase.GetProjectDataForPath(projectFilePath);
 
   DBProjectData dbData;
 
   if (previousDbData)
      dbData = *previousDbData;
 
   dbData.LastModified = wxDateTime::Now().GetTicks();
   dbData.LastRead     = dbData.LastModified;
   dbData.SyncStatus   = success ? DBProjectData::SyncStatusSynced :
                                   DBProjectData::SyncStatusUploading;
 
   cloudDatabase.UpdateProjectData(dbData);
}

References BasicUI::Get(), ProjectFileIO::Get(), audacity::cloud::audiocom::sync::DBProjectData::LastModified, audacity::cloud::audiocom::sync::DBProjectData::LastRead, audacity::cloud::audiocom::sync::DBProjectData::SyncStatus, and audacity::ToUTF8().

Here is the call graph for this function:

◆ OnBlocksHashed()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnBlocksHashed ( ProjectUploadOperation & uploadOperation )

This method is called not from the UI thread.

Definition at line 193 of file ProjectCloudExtension.cpp.

{
   auto lock    = std::lock_guard { mUploadQueueMutex };
   auto element = UnsafeFindUploadQueueElement(uploadOperation);
 
   if (!element)
      return;
 
   element->ReadyForUpload = true;
   uploadOperation.Start();
}

References audacity::cloud::audiocom::sync::ProjectUploadOperation::Start().

Here is the call graph for this function:

◆ OnBlockUploaded()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnBlockUploaded	(	const ProjectUploadOperation &	uploadOperation,
		std::string_view	blockID,
		bool	successful
	)

This method is called from the network thread.

Definition at line 267 of file ProjectCloudExtension.cpp.

{
   auto lock    = std::lock_guard { mUploadQueueMutex };
   auto element = UnsafeFindUploadQueueElement(uploadOperation);
 
   if (!element)
      return;
 
   element->BlocksHandled++;
 
   UnsafeUpdateProgress();
}

Referenced by audacity::cloud::audiocom::sync::LocalProjectSnapshot::OnSnapshotCreated().

Here is the caller graph for this function:

◆ OnLoad()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnLoad ( )

Definition at line 139 of file ProjectCloudExtension.cpp.

{
   UpdateIdFromDatabase();
}

◆ OnProjectDataUploaded()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnProjectDataUploaded ( const ProjectUploadOperation & uploadOperation )

This method is called from the network thread.

Definition at line 253 of file ProjectCloudExtension.cpp.

{
   auto lock    = std::lock_guard { mUploadQueueMutex };
   auto element = UnsafeFindUploadQueueElement(uploadOperation);
 
   if (!element)
      return;
 
   element->ProjectDataUploaded = true;
 
   UnsafeUpdateProgress();
}

Referenced by audacity::cloud::audiocom::sync::LocalProjectSnapshot::OnSnapshotCreated().

Here is the caller graph for this function:

◆ OnProjectPathChanged()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnProjectPathChanged ( )

private

Definition at line 594 of file ProjectCloudExtension.cpp.

{
   bool wasCloudProject = false;
 
   {
      auto lock = std::lock_guard { mIdentifiersMutex };
 
      wasCloudProject = !mProjectId.empty();
 
      mProjectId.clear();
      mSnapshotId.clear();
   }
 
   // This will set the status to cloud if the project is a cloud project
   UpdateIdFromDatabase();
 
   if (mProjectId.empty() && wasCloudProject)
      Publish({ ProjectSyncStatus::Local }, false);
}

Referenced by ProjectCloudExtension().

Here is the caller graph for this function:

◆ OnSnapshotCreated()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnSnapshotCreated	(	const ProjectUploadOperation &	uploadOperation,
		const CreateSnapshotResponse &	response
	)

This method is called from the network thread.

Definition at line 206 of file ProjectCloudExtension.cpp.

{
   auto& cloudDatabase = CloudProjectsDatabase::Get();
 
   const auto projectFilePath =
      audacity::ToUTF8(ProjectFileIO::Get(mProject).GetFileName());
 
   auto previousDbData = cloudDatabase.GetProjectDataForPath(projectFilePath);
 
   DBProjectData dbData;
 
   if (previousDbData)
      dbData = *previousDbData;
 
   dbData.ProjectId    = response.Project.Id;
   dbData.SnapshotId   = response.Snapshot.Id;
   dbData.LocalPath    = projectFilePath;
   dbData.LastModified = wxDateTime::Now().GetTicks();
   dbData.LastRead     = dbData.LastModified;
   dbData.SyncStatus   = DBProjectData::SyncStatusUploading;
   dbData.SavesCount++;
 
   cloudDatabase.UpdateProjectData(dbData);
   cloudDatabase.SetProjectUserSlug(
      response.Project.Id, response.Project.Username);
 
   {
      auto lock = std::lock_guard { mIdentifiersMutex };
 
      mProjectId  = response.Project.Id;
      mSnapshotId = response.Snapshot.Id;
   }
 
   auto lock    = std::lock_guard { mUploadQueueMutex };
   auto element = UnsafeFindUploadQueueElement(uploadOperation);
 
   if (!element)
      return;
 
   element->BlocksTotal      = response.SyncState.MissingBlocks.size();
   element->SnapshotResponse = response;
 
   UnsafeUpdateProgress();
}

Referenced by audacity::cloud::audiocom::sync::LocalProjectSnapshot::OnSnapshotCreated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnSyncCompleted()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnSyncCompleted	(	const ProjectUploadOperation *	uploadOperation,
		std::optional< CloudSyncError >	error
	)

This method is called from any thread.

Definition at line 282 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard { mUploadQueueMutex };
 
   auto element = uploadOperation != nullptr ?
                     UnsafeFindUploadQueueElement(*uploadOperation) :
                     nullptr;
 
   if (element != nullptr)
   {
      element->Synced = true;
 
      if (
         error.has_value() && error->Type == CloudSyncError::Aborted &&
         element->SnapshotResponse)
      {
         auto& cloudDatabase = CloudProjectsDatabase::Get();
 
         const auto projectFilePath =
            audacity::ToUTF8(ProjectFileIO::Get(mProject).GetFileName());
 
         auto previousDbData =
            cloudDatabase.GetProjectDataForPath(projectFilePath);
 
         DBProjectData dbData;
 
         if (previousDbData)
            dbData = *previousDbData;
 
         const auto parentId = element->SnapshotResponse->Snapshot.ParentId;
 
         dbData.SnapshotId = parentId;
 
         cloudDatabase.UpdateProjectData(dbData);
 
         {
            auto lock   = std::lock_guard { mIdentifiersMutex };
            mSnapshotId = parentId;
         }
      }
   }
 
   // std::all_of returns true if the range is empty
   if (!std::all_of(
          mUploadQueue.begin(), mUploadQueue.end(),
          [](auto& operation) { return operation->Synced; }))
   {
      UnsafeUpdateProgress();
      return;
   }
 
   mUploadQueue.clear();
 
   MarkProjectSynced(!error.has_value());
 
   Publish(
      { error.has_value() ? ProjectSyncStatus::Failed :
                            ProjectSyncStatus::Synced,
        {},
        error },
      false);
 
   if (!IsCloudProject())
      Publish({ ProjectSyncStatus::Local }, false);
}

References BasicUI::Get(), ProjectFileIO::Get(), audacity::cloud::audiocom::sync::DBProjectData::SnapshotId, and audacity::ToUTF8().

Referenced by audacity::cloud::audiocom::sync::LocalProjectSnapshot::MarkSnapshotSynced(), and audacity::cloud::audiocom::sync::LocalProjectSnapshot::UploadFailed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnSyncResumed()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnSyncResumed	(	std::shared_ptr< ProjectUploadOperation >	uploadOperation,
		int64_t	missingBlocksCount,
		bool	needsProjectUpload
	)

This method is called from the UI thread.

Definition at line 162 of file ProjectCloudExtension.cpp.

{
   auto element                 = std::make_shared<UploadQueueElement>();
   element->Operation           = uploadOperation;
   element->BlocksTotal         = missingBlocksCount;
   element->ProjectDataUploaded = !needsProjectUpload;
 
   {
      auto lock = std::lock_guard { mUploadQueueMutex };
      mUploadQueue.push_back(element);
   }
 
   uploadOperation->Start();
   UnsafeUpdateProgress();
}

Referenced by audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::Perform().

Here is the caller graph for this function:

◆ OnSyncStarted()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnSyncStarted ( )

This method is called from the UI thread.

Definition at line 144 of file ProjectCloudExtension.cpp.

{
   auto element = std::make_shared<UploadQueueElement>();
 
   element->Data.Tracks = TrackList::Create(nullptr);
 
   for (auto pTrack : TrackList::Get(mProject))
   {
      if (pTrack->GetId() == TrackId {})
         // Don't copy a pending added track
         continue;
      element->Data.Tracks->Add(pTrack->Duplicate());
   }
 
   auto lock = std::lock_guard { mUploadQueueMutex };
   mUploadQueue.push_back(std::move(element));
}

References TrackList::Create(), and TrackList::Get().

Here is the call graph for this function:

◆ OnUpdateSaved()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnUpdateSaved ( const ProjectSerializer & serializer )

Definition at line 392 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard { mUploadQueueMutex };
 
   if (mUploadQueue.empty())
      return;
 
   const size_t dictSize    = serializer.GetDict().GetSize();
   const size_t projectSize = serializer.GetData().GetSize();
 
   std::vector<uint8_t> data;
   data.resize(projectSize + dictSize + sizeof(uint64_t));
 
   const uint64_t dictSizeData =
      IsLittleEndian() ? dictSize : SwapIntBytes(dictSize);
 
   std::memcpy(data.data(), &dictSizeData, sizeof(uint64_t));
 
   uint64_t offset = sizeof(dictSize);
 
   for (const auto [chunkData, size] : serializer.GetDict())
   {
      std::memcpy(data.data() + offset, chunkData, size);
      offset += size;
   }
 
   for (const auto [chunkData, size] : serializer.GetData())
   {
      std::memcpy(data.data() + offset, chunkData, size);
      offset += size;
   }
 
   mUploadQueue.back()->Data.ProjectSnapshot = std::move(data);
 
   if (mUploadQueue.back()->Operation)
   {
      mUploadQueue.back()->Operation->SetUploadData(mUploadQueue.back()->Data);
 
      auto dbData = CloudProjectsDatabase::Get().GetProjectData(mProjectId);
 
      if (dbData)
      {
         dbData->LocalPath =
            audacity::ToUTF8(ProjectFileIO::Get(mProject).GetFileName());
         CloudProjectsDatabase::Get().UpdateProjectData(*dbData);
      }
   }
   else
      Publish({ ProjectSyncStatus::Failed }, false);
}

References BasicUI::Get(), ProjectFileIO::Get(), ProjectSerializer::GetData(), ProjectSerializer::GetDict(), MemoryStream::GetSize(), IsLittleEndian(), size, SwapIntBytes(), and audacity::ToUTF8().

Here is the call graph for this function:

◆ OnUploadOperationCreated()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::OnUploadOperationCreated ( std::shared_ptr< ProjectUploadOperation > uploadOperation )

This method is called from the UI thread.

Definition at line 180 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard { mUploadQueueMutex };
   assert(mUploadQueue.size() > 0);
 
   if (mUploadQueue.empty())
      return;
 
   mUploadQueue.back()->Operation = uploadOperation;
   UnsafeUpdateProgress();
}

◆ Publish()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::Publish	(	CloudStatusChangedMessage	cloudStatus,
		bool	canMerge
	)

private

Definition at line 523 of file ProjectCloudExtension.cpp.

{
   {
      auto lock   = std::lock_guard { mStatusMutex };
      mLastStatus = cloudStatus;
   }
 
   mAsyncStateNotifier->Enqueue(cloudStatus, canMerge);
   mUIStateNotifier->Enqueue(cloudStatus, canMerge);
 
   mAsyncStateNotifier->PublishSafe();
 
   if (BasicUI::IsUiThread())
   {
      mUINotificationPending.store(false);
      mUIStateNotifier->PublishSafe();
   }
   else if (!mUINotificationPending.exchange(true))
   {
      BasicUI::CallAfter(
         [this]
         {
            if (mUINotificationPending.exchange(false))
               mUIStateNotifier->PublishSafe();
         });
   }
}

References BasicUI::CallAfter(), and BasicUI::IsUiThread().

Here is the call graph for this function:

◆ SetFirstSyncDialogShown()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::SetFirstSyncDialogShown ( bool shown = true )

Definition at line 658 of file ProjectCloudExtension.cpp.

{
   auto lock = std::lock_guard { mIdentifiersMutex };
 
   if (mProjectId.empty())
      return;
 
   CloudProjectsDatabase::Get().SetFirstSyncDialogShown(mProjectId, shown);
}

References BasicUI::Get().

Here is the call graph for this function:

◆ SubscribeStatusChanged()

Observer::Subscription audacity::cloud::audiocom::sync::ProjectCloudExtension::SubscribeStatusChanged	(	std::function< void(const CloudStatusChangedMessage &)>	callback,
		bool	onUIThread
	)

Definition at line 464 of file ProjectCloudExtension.cpp.

{
   return onUIThread ? mUIStateNotifier->SubscribeSafe(std::move(callback)) :
                       mAsyncStateNotifier->SubscribeSafe(std::move(callback));
}

◆ UnsafeFindUploadQueueElement() [1/2]

ProjectCloudExtension::UploadQueueElement * audacity::cloud::audiocom::sync::ProjectCloudExtension::UnsafeFindUploadQueueElement ( const ProjectUploadOperation & uploadOperation )

private

Definition at line 575 of file ProjectCloudExtension.cpp.

{
   auto it = std::find_if(
      mUploadQueue.begin(), mUploadQueue.end(),
      [&](const auto& element)
      { return element->Operation.get() == &uploadOperation; });
 
   return it != mUploadQueue.end() ? it->get() : nullptr;
}

◆ UnsafeFindUploadQueueElement() [2/2]

const ProjectCloudExtension::UploadQueueElement * audacity::cloud::audiocom::sync::ProjectCloudExtension::UnsafeFindUploadQueueElement ( const ProjectUploadOperation & uploadOperation ) const

private

Definition at line 587 of file ProjectCloudExtension.cpp.

{
   return const_cast<ProjectCloudExtension*>(this)
      ->UnsafeFindUploadQueueElement(uploadOperation);
}

◆ UnsafeUpdateProgress()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::UnsafeUpdateProgress ( )

private

Definition at line 500 of file ProjectCloudExtension.cpp.

{
   if (mUploadQueue.empty())
      return;
 
   int64_t handledElements = 0;
   int64_t totalElements   = 0;
 
   for (auto& element : mUploadQueue)
   {
      handledElements +=
         element->BlocksHandled + int(element->ProjectDataUploaded);
      totalElements += element->BlocksTotal + 1;
   }
 
   assert(totalElements > 0);
 
   Publish(
      { ProjectSyncStatus::Syncing,
        double(handledElements) / double(totalElements) },
      true);
}

◆ UpdateIdFromDatabase()

void audacity::cloud::audiocom::sync::ProjectCloudExtension::UpdateIdFromDatabase ( )

private

Definition at line 472 of file ProjectCloudExtension.cpp.

{
   auto& projectFileIO = ProjectFileIO::Get(mProject);
   auto& cloudDatabase = CloudProjectsDatabase::Get();
 
   auto projectData = cloudDatabase.GetProjectDataForPath(
      audacity::ToUTF8(projectFileIO.GetFileName()));
 
   if (!projectData)
      return;
 
   {
      auto lock = std::lock_guard { mIdentifiersMutex };
 
      mProjectId  = projectData->ProjectId;
      mSnapshotId = projectData->SnapshotId;
   }
 
   Publish(
      {
         projectData->SyncStatus ==
               DBProjectData::SyncStatusType::SyncStatusSynced ?
            ProjectSyncStatus::Synced :
            ProjectSyncStatus::Unsynced,
      },
      false);
}

References BasicUI::Get(), ProjectFileIO::Get(), and audacity::ToUTF8().

Here is the call graph for this function:

Member Data Documentation

◆ mAsyncStateNotifier

std::unique_ptr<CloudStatusChangedNotifier> audacity::cloud::audiocom::sync::ProjectCloudExtension::mAsyncStateNotifier

private

Definition at line 154 of file ProjectCloudExtension.h.

◆ mIdentifiersMutex

std::mutex audacity::cloud::audiocom::sync::ProjectCloudExtension::mIdentifiersMutex

mutableprivate

Definition at line 144 of file ProjectCloudExtension.h.

◆ mLastStatus

CloudStatusChangedMessage audacity::cloud::audiocom::sync::ProjectCloudExtension::mLastStatus

private

Definition at line 152 of file ProjectCloudExtension.h.

◆ mProject

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

private

Definition at line 140 of file ProjectCloudExtension.h.

◆ mProjectId

std::string audacity::cloud::audiocom::sync::ProjectCloudExtension::mProjectId

private

Definition at line 145 of file ProjectCloudExtension.h.

◆ mProjectPathChangedSubscription

Observer::Subscription audacity::cloud::audiocom::sync::ProjectCloudExtension::mProjectPathChangedSubscription

private

Definition at line 142 of file ProjectCloudExtension.h.

◆ mSnapshotId

std::string audacity::cloud::audiocom::sync::ProjectCloudExtension::mSnapshotId

private

Definition at line 146 of file ProjectCloudExtension.h.

◆ mStatusMutex

std::mutex audacity::cloud::audiocom::sync::ProjectCloudExtension::mStatusMutex

mutableprivate

Definition at line 151 of file ProjectCloudExtension.h.

◆ mUINotificationPending

std::atomic<bool> audacity::cloud::audiocom::sync::ProjectCloudExtension::mUINotificationPending { false }

private

Definition at line 156 of file ProjectCloudExtension.h.

◆ mUIStateNotifier

std::unique_ptr<CloudStatusChangedNotifier> audacity::cloud::audiocom::sync::ProjectCloudExtension::mUIStateNotifier

private

Definition at line 155 of file ProjectCloudExtension.h.

◆ mUploadQueue

std::vector<std::shared_ptr<UploadQueueElement> > audacity::cloud::audiocom::sync::ProjectCloudExtension::mUploadQueue

private

Definition at line 149 of file ProjectCloudExtension.h.

◆ mUploadQueueMutex

std::mutex audacity::cloud::audiocom::sync::ProjectCloudExtension::mUploadQueueMutex

private

Definition at line 148 of file ProjectCloudExtension.h.

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

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProjectCloudExtension()

◆ ~ProjectCloudExtension()

Member Function Documentation

◆ AbortLastUploadOperation()

◆ CancelSync()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetCloudProjectId()

◆ GetCloudProjectPage()

◆ GetCurrentSyncStatus()

◆ GetProject()

◆ GetSavesCount()

◆ GetSnapshotId()

◆ IsBlockLocked()

◆ IsCloudProject()

◆ IsFirstSyncDialogShown()

◆ IsSyncing()

◆ MarkProjectSynced()

◆ OnBlocksHashed()

◆ OnBlockUploaded()

◆ OnLoad()

◆ OnProjectDataUploaded()

◆ OnProjectPathChanged()

◆ OnSnapshotCreated()

◆ OnSyncCompleted()

◆ OnSyncResumed()

◆ OnSyncStarted()

◆ OnUpdateSaved()

◆ OnUploadOperationCreated()

◆ Publish()

◆ SetFirstSyncDialogShown()

◆ SubscribeStatusChanged()

◆ UnsafeFindUploadQueueElement() [1/2]

◆ UnsafeFindUploadQueueElement() [2/2]

◆ UnsafeUpdateProgress()

◆ UpdateIdFromDatabase()

Member Data Documentation

◆ mAsyncStateNotifier

◆ mIdentifiersMutex

◆ mLastStatus

◆ mProject

◆ mProjectId

◆ mProjectPathChangedSubscription

◆ mSnapshotId

◆ mStatusMutex

◆ mUINotificationPending

◆ mUIStateNotifier

◆ mUploadQueue

◆ mUploadQueueMutex