anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension Class Reference

Inheritance diagram for anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension:

Collaboration diagram for anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension:

Public Member Functions
void	ForceCloudSave ()
void	SetUploadModeForNextSave (UploadMode mode)
void	SetSnapshotCallbackForNextSave (CreateSnapshotCallback callback)
Public Member Functions inherited from ProjectFileIOExtension
virtual	~ProjectFileIOExtension ()
virtual OnOpenAction	OnOpen (AudacityProject &project, const std::string &path)=0
	This hook is called before the project is opened. More...
virtual void	OnLoad (AudacityProject &project)=0
	This hook is called after the project is loaded. More...
virtual OnSaveAction	OnSave (AudacityProject &project, const ProjectSaveCallback &projectSaveCallback)=0
	This hook is called before the project is saved. More...
virtual OnCloseAction	OnClose (AudacityProject &project)=0
	This hook is called before the project is closed. More...
virtual void	OnUpdateSaved (AudacityProject &project, const ProjectSerializer &serializer)=0
	This hook is called after the project blob is saved. More...
virtual bool	IsBlockLocked (const AudacityProject &project, int64_t blockId) const =0
	This hook is called to check if a block is locked. More...

Private Member Functions
OnOpenAction	OnOpen (AudacityProject &project, const std::string &path) override
	This hook is called before the project is opened. More...
void	OnLoad (AudacityProject &project) override
	This hook is called after the project is loaded. More...
OnSaveAction	PerformCloudSave (AudacityProject &project, std::string name, std::string filePath, const ProjectSaveCallback &projectSaveCallback, bool fileRenamed)
OnSaveAction	SaveCloudProject (AudacityProject &project, const ProjectSaveCallback &projectSaveCallback)
OnSaveAction	OnSave (AudacityProject &project, const ProjectSaveCallback &projectSaveCallback) override
	This hook is called before the project is saved. More...
OnCloseAction	OnClose (AudacityProject &project) override
	This hook is called before the project is closed. More...
void	OnUpdateSaved (AudacityProject &project, const ProjectSerializer &serializer) override
	This hook is called after the project blob is saved. More...
bool	IsBlockLocked (const AudacityProject &project, int64_t blockId) const override
	This hook is called to check if a block is locked. More...

Private Attributes
CreateSnapshotCallback	mSnapshotCallback
UploadMode	mUploadMode { UploadMode::Normal }
bool	mForceCloudSave {}

Detailed Description

Definition at line 46 of file CloudProjectFileIOExtensions.cpp.

Member Function Documentation

ForceCloudSave()

void anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::ForceCloudSave ( )

inline

Definition at line 267 of file CloudProjectFileIOExtensions.cpp.

   {
      mForceCloudSave = true;
   }

IsBlockLocked()

bool anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::IsBlockLocked ( const AudacityProject &  project, int64_t  blockId  ) const

inlineoverrideprivatevirtual

This hook is called to check if a block is locked.

Implements ProjectFileIOExtension.

Definition at line 261 of file CloudProjectFileIOExtensions.cpp.

   {
      return ProjectCloudExtension::Get(project).IsBlockLocked(blockId);
   }

References BasicUI::Get(), and project.

Here is the call graph for this function:

OnClose()

OnCloseAction anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::OnClose ( AudacityProject &  project )

inlineoverrideprivatevirtual

This hook is called before the project is closed.

Implements ProjectFileIOExtension.

Definition at line 198 of file CloudProjectFileIOExtensions.cpp.

   {
      auto& projectCloudExtension = ProjectCloudExtension::Get(project);
 
      if (!projectCloudExtension.IsCloudProject())
         return OnCloseAction::Continue;
 
      return OnCloseHook::Call(project) ? OnCloseAction::Continue :
                                          OnCloseAction::Veto;
   }

References Continue, BasicUI::Get(), project, and Veto.

Here is the call graph for this function:

OnLoad()

void anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::OnLoad ( AudacityProject &  project )

inlineoverrideprivatevirtual

This hook is called after the project is loaded.

Implements ProjectFileIOExtension.

Definition at line 55 of file CloudProjectFileIOExtensions.cpp.

   {
      auto& projectCloudExtenstion = ProjectCloudExtension::Get(project);
      projectCloudExtenstion.OnLoad();
 
      if (projectCloudExtenstion.IsCloudProject())
         ResumeProjectUpload(
            projectCloudExtenstion,
            [&project] { PerformBlockingAuth(&project); });
   }

References BasicUI::Get(), audacity::cloud::audiocom::PerformBlockingAuth(), project, and audacity::cloud::audiocom::sync::ResumeProjectUpload().

Here is the call graph for this function:

OnOpen()

OnOpenAction anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::OnOpen ( AudacityProject &  project, const std::string &  path  )

inlineoverrideprivatevirtual

This hook is called before the project is opened.

Implements ProjectFileIOExtension.

Definition at line 49 of file CloudProjectFileIOExtensions.cpp.

   {
      return SyncCloudProject(project, path) ? OnOpenAction::Continue :
                                               OnOpenAction::Cancel;
   }

References Cancel, Continue, project, and audacity::cloud::audiocom::sync::SyncCloudProject().

Here is the call graph for this function:

OnSave()

OnSaveAction anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::OnSave ( AudacityProject &  project, const ProjectSaveCallback &  projectSaveCallback  )

inlineoverrideprivatevirtual

This hook is called before the project is saved.

Implements ProjectFileIOExtension.

Definition at line 140 of file CloudProjectFileIOExtensions.cpp.

   {
      auto& projectCloudExtension = ProjectCloudExtension::Get(project);
      auto& projectFileIO         = ProjectFileIO::Get(project);
 
      const bool isTemporary    = projectFileIO.IsTemporary();
      const bool isCloudProject = projectCloudExtension.IsCloudProject();
 
      const bool pendingCloudSave = mForceCloudSave;
      mForceCloudSave             = false;
 
      auto parent = &ProjectWindow::Get(project);
 
      // Check location first
      if (isTemporary && !pendingCloudSave)
      {
         CloudLocationDialog cloudLocationDialog { parent,
                                                   LocationDialogType::Save };
         const auto saveAction = cloudLocationDialog.ShowDialog();
 
         // Not doing a cloud save
         if (saveAction == LocationDialogResult::Local)
            return OnSaveAction::Continue;
         else if (saveAction == LocationDialogResult::Cancel)
            return OnSaveAction::Cancelled;
      }
 
      // For regular projects - do nothing
      if (!isTemporary && !pendingCloudSave && !isCloudProject)
         return OnSaveAction::Continue;
 
      if (!isTemporary)
         return SaveCloudProject(project, projectSaveCallback);
 
      auto result = CloudProjectPropertiesDialog::Show(
         GetServiceConfig(), GetOAuthService(), GetUserService(),
         project.GetProjectName(), parent, false);
 
      if (result.first == CloudProjectPropertiesDialog::Action::Cancel)
         // Suppress the Save function completely
         return OnSaveAction::Cancelled;
      else if (
         result.first == CloudProjectPropertiesDialog::Action::SaveLocally)
         // Just let the things flow as usual
         return OnSaveAction::Continue;
 
      const auto dir = CloudProjectsSavePath.Read();
      FileNames::MkDir(dir);
 
      const auto filePath = sync::MakeSafeProjectPath(dir, result.second);
 
      return PerformCloudSave(
         project, result.second, audacity::ToUTF8(filePath),
         projectSaveCallback, true);
   }

References Cancelled, audacity::cloud::audiocom::CloudProjectsSavePath, Continue, BasicUI::Get(), ProjectFileIO::Get(), ProjectWindow::Get(), audacity::cloud::audiocom::GetOAuthService(), audacity::cloud::audiocom::GetServiceConfig(), audacity::cloud::audiocom::GetUserService(), audacity::cloud::audiocom::sync::MakeSafeProjectPath(), FileNames::MkDir(), project, Setting< T >::Read(), ExportProgressUI::Show(), audacity::cloud::audiocom::sync::CloudLocationDialog::ShowDialog(), and audacity::ToUTF8().

Here is the call graph for this function:

OnUpdateSaved()

void anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::OnUpdateSaved ( AudacityProject &  project, const ProjectSerializer &  serializer  )

inlineoverrideprivatevirtual

This hook is called after the project blob is saved.

Implements ProjectFileIOExtension.

Definition at line 209 of file CloudProjectFileIOExtensions.cpp.

   {
      auto& projectCloudExtension = ProjectCloudExtension::Get(project);
 
      if (!projectCloudExtension.IsCloudProject())
         return;
 
      projectCloudExtension.OnUpdateSaved(serializer);
 
      const int savesCount = projectCloudExtension.GetSavesCount();
 
      if (savesCount < 2)
      {
         SyncInBackroundDialog { &project }.ShowDialog();
      }
 
      if (projectCloudExtension.IsFirstSyncDialogShown())
         return;
 
      ShowDialogOn(
         [weakProject = project.weak_from_this()]
         {
            auto project = weakProject.lock();
 
            if (!project)
               return true;
 
            return ProjectCloudExtension::Get(*project)
                      .GetCurrentSyncStatus() == ProjectSyncStatus::Synced;
         },
         [weakProject = project.weak_from_this()]
         {
            auto project = weakProject.lock();
 
            if (
               !project ||
               ProjectCloudExtension::Get(*project).IsFirstSyncDialogShown())
               return;
 
            ProjectCloudExtension::Get(*project).SetFirstSyncDialogShown(true);
 
            const auto result =
               SyncSucceededDialog { project.get() }.ShowDialog();
 
            if (result == SyncSucceededDialog::ViewOnlineIdentifier())
               BasicUI::OpenInDefaultBrowser(audacity::ToWXString(
                  ProjectCloudExtension::Get(*project).GetCloudProjectPage()));
         });
   }

References BasicUI::Get(), BasicUI::OpenInDefaultBrowser(), project, audacity::cloud::audiocom::sync::ShowDialogOn(), and audacity::ToWXString().

Here is the call graph for this function:

PerformCloudSave()

OnSaveAction anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::PerformCloudSave ( AudacityProject &  project, std::string  name, std::string  filePath, const ProjectSaveCallback &  projectSaveCallback, bool  fileRenamed  )

inlineprivate

Definition at line 66 of file CloudProjectFileIOExtensions.cpp.

   {
      auto& projectCloudExtension = ProjectCloudExtension::Get(project);
 
      projectCloudExtension.OnSyncStarted();
 
      auto future = LocalProjectSnapshot::Create(
         GetServiceConfig(), GetOAuthService(), projectCloudExtension, name,
         mUploadMode);
 
      mUploadMode = UploadMode::Normal;
 
      // Do we need UI here?
      // while (future.wait_for(std::chrono::milliseconds(50)) !=
      //       std::future_status::ready)
      //   BasicUI::Yield();
 
      auto result = future.get();
 
      if (!result.Response)
         // Prevent any updates to the file to preserve the correct state.
         // Errors would be handled by the UI extension
         return OnSaveAction::Cancelled;
 
      if (!projectSaveCallback(audacity::ToUTF8(filePath), fileRenamed))
      {
         if (result.Operation)
            result.Operation->Abort();
         else
            projectCloudExtension.OnSyncCompleted(
               nullptr, CloudSyncError { CloudSyncError::Aborted });
         // Something has failed horrible during the save
         return OnSaveAction::Cancelled;
      }
 
      if (mSnapshotCallback)
      {
         mSnapshotCallback(*result.Response);
         mSnapshotCallback = {};
      }
 
      return OnSaveAction::Handled;
   }

References Cancelled, BasicUI::Get(), audacity::cloud::audiocom::GetOAuthService(), audacity::cloud::audiocom::GetServiceConfig(), Handled, name, project, and audacity::ToUTF8().

Here is the call graph for this function:

SaveCloudProject()

OnSaveAction anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::SaveCloudProject ( AudacityProject &  project, const ProjectSaveCallback &  projectSaveCallback  )

inlineprivate

Definition at line 112 of file CloudProjectFileIOExtensions.cpp.

   {
      auto authResult = PerformBlockingAuth(&project);
 
      if (authResult.Result == AuthResult::Status::Failure)
      {
         LinkFailedDialog dialog { &ProjectWindow::Get(project) };
         dialog.ShowModal();
         // Pretend we have canceled the save
         return OnSaveAction::Cancelled;
      }
      else if (authResult.Result == AuthResult::Status::Cancelled)
      {
         return OnSaveAction::Cancelled;
      }
      else if (authResult.Result == AuthResult::Status::UseAlternative)
      {
         ProjectFileIO::Get(project).MarkTemporary();
         return OnSaveAction::Continue;
      }
 
      return PerformCloudSave(
         project, audacity::ToUTF8(project.GetProjectName()),
         audacity::ToUTF8(ProjectFileIO::Get(project).GetFileName()),
         projectSaveCallback, false);
   }

References Cancelled, RefreshCode::Cancelled, Continue, ProjectFileIO::Get(), ProjectWindow::Get(), ProjectFileIO::GetFileName(), ProjectFileIO::MarkTemporary(), audacity::cloud::audiocom::PerformBlockingAuth(), project, and audacity::ToUTF8().

Here is the call graph for this function:

SetSnapshotCallbackForNextSave()

void anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::SetSnapshotCallbackForNextSave ( CreateSnapshotCallback  callback )

inline

Definition at line 277 of file CloudProjectFileIOExtensions.cpp.

   {
      mSnapshotCallback = std::move(callback);
   }

SetUploadModeForNextSave()

void anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::SetUploadModeForNextSave ( UploadMode  mode )

inline

Definition at line 272 of file CloudProjectFileIOExtensions.cpp.

   {
      mUploadMode = mode;
   }

Member Data Documentation

mForceCloudSave

bool anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::mForceCloudSave {}

private

Definition at line 288 of file CloudProjectFileIOExtensions.cpp.

mSnapshotCallback

CreateSnapshotCallback anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::mSnapshotCallback

private

Definition at line 284 of file CloudProjectFileIOExtensions.cpp.

mUploadMode

UploadMode anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension::mUploadMode { UploadMode::Normal }

private

Definition at line 286 of file CloudProjectFileIOExtensions.cpp.

---

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

• CloudProjectFileIOExtensions.cpp