UploadService.h

Go to the documentation of this file.

/*  SPDX-License-Identifier: GPL-2.0-or-later */
/*!********************************************************************
 
  Audacity: A Digital Audio Editor
 
  UploadService.h
 
  Dmitry Vedenko
 
**********************************************************************/
#pragma once
 
#include <cstdint>
#include <functional>
#include <memory>
#include <utility>
#include <variant>
#include <vector>
 
#include <wx/string.h>
 
enum class AudiocomTrace;
 
namespace audacity::cloud::audiocom
{
class ServiceConfig;
class OAuthService;
 
struct CLOUD_AUDIOCOM_API UploadFailedPayload final
{
   int32_t code {};
   int32_t status {};
 
   std::string name;
   std::string message;
 
   using AdditionalError = std::pair<std::string, std::string>;
   std::vector<AdditionalError> additionalErrors;
};
 
struct CLOUD_AUDIOCOM_API UploadSuccessfulPayload final
{
   std::string audioId;
   std::string audioSlug;
   std::string uploadToken;
   std::string audioUrl;
};
 
struct CLOUD_AUDIOCOM_API UploadOperationCompleted final
{
   enum class Result
   {
      Success,
      Aborted,
      FileNotFound,
      Unauthorized,
      InvalidData,
      UnexpectedResponse,
      UploadFailed
   };
 
   Result result;
 
   using Payload = std::variant<
      std::monostate,
      UploadSuccessfulPayload,
      UploadFailedPayload
   >;
 
   Payload payload;
};
 
class CLOUD_AUDIOCOM_API UploadOperation
{
public:
   virtual ~UploadOperation();
 
   virtual bool IsCompleted() = 0;
   virtual void Abort() = 0;
   virtual void DiscardResult() = 0;
};
 
class CLOUD_AUDIOCOM_API UploadOperationHandle final
{
public:
   UploadOperationHandle() = default;
   explicit UploadOperationHandle(std::shared_ptr<UploadOperation> operation);
 
   UploadOperationHandle(const UploadOperationHandle&) = delete;
   UploadOperationHandle(UploadOperationHandle&&) = default;
   UploadOperationHandle& operator=(const UploadOperationHandle&) = delete;
   UploadOperationHandle& operator=(UploadOperationHandle&&) = default;
 
   ~UploadOperationHandle();
 
   explicit operator bool() const noexcept;
 
   UploadOperation* operator->() const noexcept;
 
private:
   std::shared_ptr<UploadOperation> mOperation {};
};
 
class CLOUD_AUDIOCOM_API UploadService final
{
public:
   UploadService(const ServiceConfig& config, OAuthService& service);
 
   using CompletedCallback =
      std::function<void(const UploadOperationCompleted&)>;
 
   using ProgressCallback = std::function<void(uint64_t current, uint64_t total)>;
 
   /*
      Both callbacks are invoked from the network thread.
 
      If projectName is empty, the name for the uploaded file is deduced from the fileName.
   */
   UploadOperationHandle Upload(
      const wxString& fileName, const wxString& projectName, bool isPublic,
      CompletedCallback completedCallback, ProgressCallback progressCallback,
      AudiocomTrace);
 
private:
   const ServiceConfig& mServiceConfig;
   OAuthService& mOAuthService;
};
 
CLOUD_AUDIOCOM_API wxString GetUploadTempPath();
} // namespace audacity::cloud::audiocom