Configuration for the audio.com. More...

#include <ServiceConfig.h>

Collaboration diagram for audacity::cloud::audiocom::ServiceConfig:

Public Member Functions
	ServiceConfig ()

std::string	GetAPIEndpoint () const
	API endpoint. More...

std::string	GetOAuthLoginPage () const
	Page to open in browser to initiate OAuth. More...

std::string	GetOAuthClientID () const
	OAuth2 client ID. More...

std::string	GetOAuthClientSecret () const
	OAuth2 client secret. More...

std::string	GetOAuthRedirectURL () const
	OAuth2 redirect URL. Only used to satisfy the protocol. More...

std::string	GetAPIUrl (std::string_view apiURI) const
	Helper to construct the full URLs for the API. More...

std::string	GetFinishUploadPage (std::string_view audioID, std::string_view token) const
	Helper to construct the page URL for the anonymous upload last stage. More...

std::string	GetAudioURL (std::string_view userSlug, std::string_view audioSlug) const
	Helper to construct the page URL for the authorised upload. More...

std::chrono::milliseconds	GetProgressCallbackTimeout () const
	Timeout between progress callbacks. More...

std::vector< std::string >	GetPreferredAudioFormats (bool preferLossless=true) const
	Preferred audio format. More...

rapidjson::Document	GetExportConfig (const std::string &exporterName) const
	Export configuration suitable for the mime type provided. More...

std::string	GetDownloadMime () const

std::string	GetAcceptLanguageValue () const
	Returns the preferred language. More...

std::string	GetCreateProjectUrl () const

std::string	GetCreateSnapshotUrl (std::string_view projectId) const

std::string	GetSnapshotSyncUrl (std::string_view projectId, std::string_view snapshotId) const

std::string	GetProjectsUrl (int page, int pageSize, std::string_view searchTerm) const

std::string	GetProjectInfoUrl (std::string_view projectId) const

std::string	GetSnapshotInfoUrl (std::string_view projectId, std::string_view snapshotId) const

std::string	GetDeleteSnapshotUrl (std::string_view projectId, std::string_view snapshotId) const

std::string	GetNetworkStatsUrl (std::string_view projectId) const

std::string	GetProjectPageUrl (std::string_view userId, std::string_view projectId) const

std::string	GetProjectsPageUrl (std::string_view userId) const

Private Attributes
std::string	mApiEndpoint

std::string	mOAuthClientID

std::string	mOAuthClientSecret

std::string	mOAuthRedirectURL

std::string	mOAuthLoginPage

std::string	mFinishUploadPage

std::string	mFrontendURL

std::string	mPreferredMimeType

Detailed Description

Configuration for the audio.com.

Definition at line 22 of file ServiceConfig.h.

Constructor & Destructor Documentation

◆ ServiceConfig()

audacity::cloud::audiocom::ServiceConfig::ServiceConfig ( )

Definition at line 85 of file ServiceConfig.cpp.

{
   mApiEndpoint       = audacity::ToUTF8(audioComApiEndpoint.Read());
   mOAuthClientID     = audacity::ToUTF8(audioComOAuthClientID.Read());
   mOAuthClientSecret = audacity::ToUTF8(audioComOAuthClientSecret.Read());
   mOAuthRedirectURL  = audacity::ToUTF8(audioComOAuthRedirectURL.Read());
   mOAuthLoginPage    = audacity::ToUTF8(audioComOAuthLoginPage.Read());
   mFinishUploadPage  = audacity::ToUTF8(audioComFinishUploadPage.Read());
   mFrontendURL       = audacity::ToUTF8(audioComFrontendUrl.Read());
   mPreferredMimeType = audacity::ToUTF8(audioComAudioDownloadMimeType.Read());
}

Here is the call graph for this function:

Member Function Documentation

◆ GetAcceptLanguageValue()

std::string audacity::cloud::audiocom::ServiceConfig::GetAcceptLanguageValue ( ) const

Returns the preferred language.

Definition at line 203 of file ServiceConfig.cpp.

{
   auto language = Languages::GetLang();
 
   if (language.Contains(L"-") && language.Length() > 2)
      return wxString::Format(
                "%s;q=1.0, %s;q=0.7, *;q=0.5", language, language.Left(2))
         .ToStdString();
   else
      return wxString::Format("%s;q=1.0, *;q=0.5", language).ToStdString();
}

References Languages::GetLang().

Referenced by audacity::cloud::audiocom::SetCommonHeaders(), audacity::cloud::audiocom::anonymous_namespace{UploadService.cpp}::AudiocomUploadOperation::SetRequiredHeaders(), and audacity::cloud::audiocom::sync::LocalProjectSnapshot::UpdateProjectSnapshot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAPIEndpoint()

std::string audacity::cloud::audiocom::ServiceConfig::GetAPIEndpoint ( ) const

API endpoint.

Definition at line 97 of file ServiceConfig.cpp.

{
   return mApiEndpoint;
}

References mApiEndpoint.

◆ GetAPIUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetAPIUrl ( std::string_view apiURI ) const

Helper to construct the full URLs for the API.

Definition at line 123 of file ServiceConfig.cpp.

{
   return mApiEndpoint + std::string(apiURI);
}

References mApiEndpoint.

Referenced by audacity::cloud::audiocom::anonymous_namespace{UploadService.cpp}::AudiocomUploadOperation::DiscardResult(), audacity::cloud::audiocom::OAuthService::DoAuthorise(), GetCreateProjectUrl(), and audacity::cloud::audiocom::anonymous_namespace{UploadService.cpp}::AudiocomUploadOperation::InitiateUpload().

Here is the caller graph for this function:

◆ GetAudioURL()

std::string audacity::cloud::audiocom::ServiceConfig::GetAudioURL	(	std::string_view	userSlug,
		std::string_view	audioSlug
	)		const

Helper to construct the page URL for the authorised upload.

Definition at line 137 of file ServiceConfig.cpp.

{
   return Substitute(
      "{frontend_url}/{user_slug}/audio/{audio_slug}/edit",
      { { "frontend_url", mFrontendURL },
        { "user_slug", userSlug },
        { "audio_slug", audioSlug } });
}

References mFrontendURL, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

Referenced by audacity::cloud::audiocom::anonymous_namespace{UploadService.cpp}::AudiocomUploadOperation::CompletePromise().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCreateProjectUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetCreateProjectUrl ( ) const

Definition at line 215 of file ServiceConfig.cpp.

{
   return GetAPIUrl("/project");
}

References GetAPIUrl().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCreateSnapshotUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetCreateSnapshotUrl ( std::string_view projectId ) const

Definition at line 221 of file ServiceConfig.cpp.

{
   return Substitute(
      "{api_url}/project/{project_id}/snapshot",
      { { "api_url", mApiEndpoint }, { "project_id", projectId } });
}

References mApiEndpoint, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDeleteSnapshotUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetDeleteSnapshotUrl	(	std::string_view	projectId,
		std::string_view	snapshotId
	)		const

Definition at line 277 of file ServiceConfig.cpp.

{
   return Substitute(
      "{api_url}/project/{project_id}/snapshot/{snapshot_id}",
      {
         { "api_url", mApiEndpoint },
         { "project_id", projectId },
         { "snapshot_id", snapshotId },
      });
}

References mApiEndpoint, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDownloadMime()

std::string audacity::cloud::audiocom::ServiceConfig::GetDownloadMime ( ) const

Return the mime type server should store the file. This is a requirement from audiocom

Definition at line 198 of file ServiceConfig.cpp.

{
   return mPreferredMimeType;
}

References mPreferredMimeType.

Referenced by audacity::cloud::audiocom::anonymous_namespace{UploadService.cpp}::GetUploadRequestPayload().

Here is the caller graph for this function:

◆ GetExportConfig()

rapidjson::Document audacity::cloud::audiocom::ServiceConfig::GetExportConfig ( const std::string & exporterName ) const

Export configuration suitable for the mime type provided.

Definition at line 162 of file ServiceConfig.cpp.

{
   if (mimeType == "audio/x-wavpack")
   {
      rapidjson::Document config;
      config.SetObject();
      config.AddMember("quality", rapidjson::Value(2), config.GetAllocator());
      config.AddMember("bit_rate", rapidjson::Value(40), config.GetAllocator());
      config.AddMember("bit_depth", 24, config.GetAllocator());
      config.AddMember("hybrid_mode", false, config.GetAllocator());
      return config;
   }
   else if (mimeType == "audio/x-flac")
   {
      rapidjson::Document config;
      config.SetObject();
      config.AddMember(
         "bit_depth", rapidjson::Value(24), config.GetAllocator());
      config.AddMember("level", rapidjson::Value(5), config.GetAllocator());
   }
   else if (mimeType == "audio/x-wav")
   {
      return {};
   }
   else if (mimeType == "audio/mpeg")
   {
      rapidjson::Document config;
      config.SetObject();
      config.AddMember("mode", rapidjson::Value("VBR"), config.GetAllocator());
      config.AddMember("quality", rapidjson::Value(5), config.GetAllocator());
      return config;
   }
 
   throw std::invalid_argument("unknown mime-type");
}

Referenced by audacity::cloud::audiocom::sync::MixdownUploader::ExportProject(), and audacity::cloud::audiocom::ShareAudioDialog::ExportProject().

Here is the caller graph for this function:

◆ GetFinishUploadPage()

std::string audacity::cloud::audiocom::ServiceConfig::GetFinishUploadPage	(	std::string_view	audioID,
		std::string_view	token
	)		const

Helper to construct the page URL for the anonymous upload last stage.

Definition at line 128 of file ServiceConfig.cpp.

{
   return Substitute(
      mFinishUploadPage, { { "audio_id", audioID },
                           { "auth_token", token },
                           { "auth_client_id", mOAuthClientID } });
}

References mFinishUploadPage, mOAuthClientID, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

Referenced by audacity::cloud::audiocom::anonymous_namespace{UploadService.cpp}::AudiocomUploadOperation::CompletePromise().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNetworkStatsUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetNetworkStatsUrl ( std::string_view projectId ) const

Definition at line 289 of file ServiceConfig.cpp.

{
   return Substitute(
      "{api_url}/project/{project_id}/network-stats",
      {
         { "api_url", mApiEndpoint },
         { "project_id", projectId },
      });
}

References mApiEndpoint, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

Here is the call graph for this function:

◆ GetOAuthClientID()

std::string audacity::cloud::audiocom::ServiceConfig::GetOAuthClientID ( ) const

OAuth2 client ID.

Definition at line 108 of file ServiceConfig.cpp.

{
   return mOAuthClientID;
}

References mOAuthClientID.

Referenced by GetOAuthLoginPage(), and audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::WriteCommonFields().

Here is the caller graph for this function:

◆ GetOAuthClientSecret()

std::string audacity::cloud::audiocom::ServiceConfig::GetOAuthClientSecret ( ) const

OAuth2 client secret.

Definition at line 113 of file ServiceConfig.cpp.

{
   return mOAuthClientSecret;
}

References mOAuthClientSecret.

Referenced by audacity::cloud::audiocom::anonymous_namespace{OAuthService.cpp}::WriteCommonFields().

Here is the caller graph for this function:

◆ GetOAuthLoginPage()

std::string audacity::cloud::audiocom::ServiceConfig::GetOAuthLoginPage ( ) const

Page to open in browser to initiate OAuth.

Definition at line 102 of file ServiceConfig.cpp.

{
   return Substitute(
      mOAuthLoginPage, { { "auth_client_id", GetOAuthClientID() } });
}

References GetOAuthClientID(), mOAuthLoginPage, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

Here is the call graph for this function:

◆ GetOAuthRedirectURL()

std::string audacity::cloud::audiocom::ServiceConfig::GetOAuthRedirectURL ( ) const

OAuth2 redirect URL. Only used to satisfy the protocol.

Definition at line 118 of file ServiceConfig.cpp.

{
   return mOAuthRedirectURL;
}

References mOAuthRedirectURL.

Referenced by audacity::cloud::audiocom::OAuthService::AuthoriseCode().

Here is the caller graph for this function:

◆ GetPreferredAudioFormats()

std::vector< std::string > audacity::cloud::audiocom::ServiceConfig::GetPreferredAudioFormats ( bool preferLossless = true ) const

Preferred audio format.

Definition at line 153 of file ServiceConfig.cpp.

{
   if (preferLossless)
      return { "audio/x-wavpack", "audio/x-flac", "audio/x-wav" };
   else
      return { "audio/mpeg" };
}

◆ GetProgressCallbackTimeout()

std::chrono::milliseconds audacity::cloud::audiocom::ServiceConfig::GetProgressCallbackTimeout ( ) const

Timeout between progress callbacks.

Definition at line 147 of file ServiceConfig.cpp.

{
   return std::chrono::seconds(3);
}

Referenced by audacity::cloud::audiocom::anonymous_namespace{UploadService.cpp}::AudiocomUploadOperation::HandleUploadProgress().

Here is the caller graph for this function:

◆ GetProjectInfoUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetProjectInfoUrl ( std::string_view projectId ) const

Definition at line 256 of file ServiceConfig.cpp.

{
   return Substitute(
      "{api_url}/project/{project_id}", {
                                           { "api_url", mApiEndpoint },
                                           { "project_id", projectId },
                                        });
}

References mApiEndpoint, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

Referenced by audacity::cloud::audiocom::anonymous_namespace{CloudSyncService.cpp}::GetProjectInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetProjectPageUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetProjectPageUrl	(	std::string_view	userId,
		std::string_view	projectId
	)		const

Definition at line 299 of file ServiceConfig.cpp.

{
   return Substitute(
      "{frontend_url}/{user_slug}/projects/{project_id}",
      {
         { "frontend_url", mFrontendURL },
         { "user_slug", userId },
         { "project_id", projectId },
      });
}

References mFrontendURL, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

Referenced by audacity::cloud::audiocom::sync::ProjectCloudExtension::GetCloudProjectPage(), and audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::GetSelectedProjectUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetProjectsPageUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetProjectsPageUrl ( std::string_view userId ) const

Definition at line 311 of file ServiceConfig.cpp.

{
   return Substitute(
      "{frontend_url}/{user_slug}/projects",
      {
         { "frontend_url", mFrontendURL },
         { "user_slug", userId },
      });
}

References mFrontendURL, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

Here is the call graph for this function:

◆ GetProjectsUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetProjectsUrl	(	int	page,
		int	pageSize,
		std::string_view	searchTerm
	)		const

Definition at line 238 of file ServiceConfig.cpp.

{
   if (searchTerm.empty())
   return Substitute(
      "{api_url}/project?page={page}&per-page={page_size}",
      { { "api_url", mApiEndpoint },
        { "page", std::to_string(page) },
        { "page_size", std::to_string(pageSize) }, });
 
   return Substitute(
      "{api_url}/project?page={page}&per-page={page_size}&q={search_term}",
      { { "api_url", mApiEndpoint },
        { "page", std::to_string(page) },
        { "page_size", std::to_string(pageSize) },
        { "search_term", searchTerm }, });
}

References mApiEndpoint, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

Here is the call graph for this function:

◆ GetSnapshotInfoUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetSnapshotInfoUrl	(	std::string_view	projectId,
		std::string_view	snapshotId
	)		const

Definition at line 265 of file ServiceConfig.cpp.

{
   return Substitute(
      "{api_url}/project/{project_id}/snapshot/{snapshot_id}?expand=blocks,file_url",
      {
         { "api_url", mApiEndpoint },
         { "project_id", projectId },
         { "snapshot_id", snapshotId },
      });
}

References mApiEndpoint, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

Referenced by audacity::cloud::audiocom::anonymous_namespace{CloudSyncService.cpp}::GetSnapshotInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSnapshotSyncUrl()

std::string audacity::cloud::audiocom::ServiceConfig::GetSnapshotSyncUrl	(	std::string_view	projectId,
		std::string_view	snapshotId
	)		const

Definition at line 228 of file ServiceConfig.cpp.

{
   return Substitute(
      "{api_url}/project/{project_id}/snapshot/{snapshot_id}/sync",
      { { "api_url", mApiEndpoint },
        { "project_id", projectId },
        { "snapshot_id", snapshotId } });
}

References mApiEndpoint, and audacity::cloud::audiocom::anonymous_namespace{ServiceConfig.cpp}::Substitute().

Referenced by audacity::cloud::audiocom::sync::LocalProjectSnapshot::MarkSnapshotSynced(), audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::RefreshUrls(), and audacity::cloud::audiocom::sync::LocalProjectSnapshot::StorePendingSnapshot().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mApiEndpoint

std::string audacity::cloud::audiocom::ServiceConfig::mApiEndpoint

private

Definition at line 73 of file ServiceConfig.h.

Referenced by GetAPIEndpoint(), GetAPIUrl(), GetCreateSnapshotUrl(), GetDeleteSnapshotUrl(), GetNetworkStatsUrl(), GetProjectInfoUrl(), GetProjectsUrl(), GetSnapshotInfoUrl(), GetSnapshotSyncUrl(), and ServiceConfig().

◆ mFinishUploadPage

std::string audacity::cloud::audiocom::ServiceConfig::mFinishUploadPage

private

Definition at line 78 of file ServiceConfig.h.

Referenced by GetFinishUploadPage(), and ServiceConfig().

◆ mFrontendURL

std::string audacity::cloud::audiocom::ServiceConfig::mFrontendURL

private

Definition at line 79 of file ServiceConfig.h.

Referenced by GetAudioURL(), GetProjectPageUrl(), GetProjectsPageUrl(), and ServiceConfig().

◆ mOAuthClientID

std::string audacity::cloud::audiocom::ServiceConfig::mOAuthClientID

private

Definition at line 74 of file ServiceConfig.h.

Referenced by GetFinishUploadPage(), GetOAuthClientID(), and ServiceConfig().

◆ mOAuthClientSecret

std::string audacity::cloud::audiocom::ServiceConfig::mOAuthClientSecret

private

Definition at line 75 of file ServiceConfig.h.

Referenced by GetOAuthClientSecret(), and ServiceConfig().

◆ mOAuthLoginPage

std::string audacity::cloud::audiocom::ServiceConfig::mOAuthLoginPage

private

Definition at line 77 of file ServiceConfig.h.

Referenced by GetOAuthLoginPage(), and ServiceConfig().

◆ mOAuthRedirectURL

std::string audacity::cloud::audiocom::ServiceConfig::mOAuthRedirectURL

private

Definition at line 76 of file ServiceConfig.h.

Referenced by GetOAuthRedirectURL(), and ServiceConfig().

◆ mPreferredMimeType

std::string audacity::cloud::audiocom::ServiceConfig::mPreferredMimeType

private

Definition at line 80 of file ServiceConfig.h.

Referenced by GetDownloadMime(), and ServiceConfig().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ServiceConfig()

Member Function Documentation

◆ GetAcceptLanguageValue()

◆ GetAPIEndpoint()

◆ GetAPIUrl()

◆ GetAudioURL()

◆ GetCreateProjectUrl()

◆ GetCreateSnapshotUrl()

◆ GetDeleteSnapshotUrl()

◆ GetDownloadMime()

◆ GetExportConfig()

◆ GetFinishUploadPage()

◆ GetNetworkStatsUrl()

◆ GetOAuthClientID()

◆ GetOAuthClientSecret()

◆ GetOAuthLoginPage()

◆ GetOAuthRedirectURL()

◆ GetPreferredAudioFormats()

◆ GetProgressCallbackTimeout()

◆ GetProjectInfoUrl()

◆ GetProjectPageUrl()

◆ GetProjectsPageUrl()

◆ GetProjectsUrl()

◆ GetSnapshotInfoUrl()

◆ GetSnapshotSyncUrl()

Member Data Documentation

◆ mApiEndpoint

◆ mFinishUploadPage

◆ mFrontendURL

◆ mOAuthClientID

◆ mOAuthClientSecret

◆ mOAuthLoginPage

◆ mOAuthRedirectURL

◆ mPreferredMimeType