audacity::cloud::audiocom::UserService Class Reference

Service for providing information about the user profile. More...

#include <UserService.h>

Inheritance diagram for audacity::cloud::audiocom::UserService:

Collaboration diagram for audacity::cloud::audiocom::UserService:

Public Member Functions
void	UpdateUserData ()
	Request the service to update the data. More...
void	ClearUserData ()
	Reset the user profile data. More...
wxString	GetUserId () const
	Gets user id. More...
wxString	GetUserSlug () const
	"Slug" used to construct shareable URLs More...
wxString	GetDisplayName () const
	Get the user name to display in the dialog. More...
wxString	GetAvatarPath () const
	Gets a path to the avatar. More...
Public Member Functions inherited from Observer::Publisher< UserDataChanged >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Private Member Functions
void	DownloadAvatar (std::string_view url)

Additional Inherited Members
Public Types inherited from Observer::Publisher< UserDataChanged >
using	message_type = UserDataChanged
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const UserDataChanged &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< UserDataChanged >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< UserDataChanged >
CallbackReturn	Publish (const UserDataChanged &message)
	Send a message to connected callbacks. More...

Detailed Description

Service for providing information about the user profile.

Definition at line 26 of file UserService.h.

Member Function Documentation

ClearUserData()

void audacity::cloud::audiocom::UserService::ClearUserData

(

)

Reset the user profile data.

Definition at line 125 of file UserService.cpp.

{
   BasicUI::CallAfter(
      [this]()
      {
         // No valid data was present, do not spam Publish()
         if (GetUserSlug().empty())
            return;
 
         userId.Write({});
         userName.Write({});
         displayName.Write({});
         avatarEtag.Write({});
 
         gPrefs->Flush();
 
         Publish({});
      });
}

References audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::avatarEtag, BasicUI::CallAfter(), audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::displayName, audacity::BasicSettings::Flush(), GetUserSlug(), gPrefs, Observer::Publisher< UserDataChanged >::Publish(), audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::userId, audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::userName, and Setting< T >::Write().

Here is the call graph for this function:

DownloadAvatar()

void audacity::cloud::audiocom::UserService::DownloadAvatar ( std::string_view  url )

private

Definition at line 151 of file UserService.cpp.

{
   const auto avatarPath = MakeAvatarPath();
   const auto avatarTempPath = avatarPath + ".tmp";
 
   if (url.empty())
   {
      if (wxFileExists(avatarPath))
         wxRemoveFile(avatarPath);
 
      return;
   }
 
   std::shared_ptr<wxFile> avatarFile = std::make_shared<wxFile>();
 
   if (!avatarFile->Create(avatarTempPath, true))
      return;
 
   using namespace audacity::network_manager;
 
   auto request = Request(std::string(url));
 
   const auto etag = audacity::ToUTF8(avatarEtag.Read());
 
   // If ETag is present - use it to prevent re-downloading the same file
   if (!etag.empty() && wxFileExists(avatarPath))
      request.setHeader(common_headers::IfNoneMatch, etag);
 
   auto response = NetworkManager::GetInstance().doGet(request);
 
   response->setOnDataReceivedCallback(
      [response, avatarFile](auto)
      {
         std::vector<char> buffer(response->getBytesAvailable());
 
         size_t bytes = response->readData(buffer.data(), buffer.size());
 
         avatarFile->Write(buffer.data(), buffer.size());
      });
 
   response->setRequestFinishedCallback(
      [response, avatarFile, avatarPath, avatarTempPath, this](auto)
      {
         avatarFile->Close();
 
         const auto httpCode = response->getHTTPCode();
 
         if (httpCode != 200)
         {
            // For any response except 200 just remove the temp file
            wxRemoveFile(avatarTempPath);
            return;
         }
 
         const auto etag = response->getHeader("ETag");
         const auto oldPath = avatarPath + ".old";
 
         if (wxFileExists(avatarPath))
            if (!wxRenameFile(avatarPath, oldPath))
               return;
 
         if (!wxRenameFile(avatarTempPath, avatarPath))
         {
            // Try at least to get it back...
            wxRenameFile(oldPath, avatarPath);
            return;
         }
 
         if (wxFileExists(oldPath))
            wxRemoveFile(oldPath);
 
         BasicUI::CallAfter(
            [this, etag]()
            {
               avatarEtag.Write(etag);
               gPrefs->Flush();
 
               Publish({});
            });
      });
}

References audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::avatarEtag, BasicUI::CallAfter(), audacity::network_manager::NetworkManager::doGet(), audacity::BasicSettings::Flush(), audacity::network_manager::NetworkManager::GetInstance(), gPrefs, audacity::network_manager::common_headers::IfNoneMatch, audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::MakeAvatarPath(), Observer::Publisher< UserDataChanged >::Publish(), Setting< T >::Read(), audacity::ToUTF8(), and Setting< T >::Write().

Referenced by UpdateUserData().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAvatarPath()

wxString audacity::cloud::audiocom::UserService::GetAvatarPath

(

)

const

Gets a path to the avatar.

Definition at line 248 of file UserService.cpp.

{
   auto path = MakeAvatarPath();
 
   if (!wxFileExists(path))
      return {};
 
   return path;
}

References audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::MakeAvatarPath().

Here is the call graph for this function:

GetDisplayName()

wxString audacity::cloud::audiocom::UserService::GetDisplayName

(

)

const

Get the user name to display in the dialog.

Definition at line 238 of file UserService.cpp.

{
   return displayName.Read();
}

References audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::displayName, and Setting< T >::Read().

Here is the call graph for this function:

GetUserId()

wxString audacity::cloud::audiocom::UserService::GetUserId

(

)

const

Gets user id.

Definition at line 233 of file UserService.cpp.

{
   return userId.Read();
}

References Setting< T >::Read(), and audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::userId.

Here is the call graph for this function:

GetUserSlug()

wxString audacity::cloud::audiocom::UserService::GetUserSlug

(

)

const

"Slug" used to construct shareable URLs

Definition at line 243 of file UserService.cpp.

{
   return userName.Read();
}

References Setting< T >::Read(), and audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::userName.

Referenced by ClearUserData().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateUserData()

void audacity::cloud::audiocom::UserService::UpdateUserData

(

)

Request the service to update the data.

Definition at line 62 of file UserService.cpp.

{
   auto& oauthService = GetOAuthService();
 
   if (!oauthService.HasAccessToken())
      return;
 
   using namespace audacity::network_manager;
 
   Request request(GetServiceConfig().GetAPIUrl("/me"));
 
   request.setHeader(
      common_headers::Authorization,
      std::string(oauthService.GetAccessToken()));
 
   request.setHeader(
      common_headers::Accept, common_content_types::ApplicationJson);
 
   auto response = NetworkManager::GetInstance().doGet(request);
 
   response->setRequestFinishedCallback(
      [response, this](auto)
      {
         const auto httpCode = response->getHTTPCode();
 
         if (httpCode != 200)
            return;
 
         const auto body = response->readAll<std::string>();
 
         using namespace rapidjson;
 
         Document document;
         document.Parse(body.data(), body.size());
 
         if (!document.IsObject())
            return;
 
         const auto id = document["id"].GetString();
         const auto username = document["username"].GetString();
         const auto avatar = document["avatar"].GetString();
         const auto profileName = document["profile"]["name"].GetString();
 
         BasicUI::CallAfter(
            [this, 
             id = std::string(id),
             username = std::string(username),
             profileName = std::string(profileName),
             avatar = std::string(avatar)]()
            {
               userId.Write(audacity::ToWXString(id));
               userName.Write(audacity::ToWXString(username));
               displayName.Write(audacity::ToWXString(profileName));
 
               gPrefs->Flush();
 
               DownloadAvatar(avatar);
 
               Publish({});
            });
      });
}

References audacity::network_manager::common_headers::Accept, audacity::network_manager::common_content_types::ApplicationJson, audacity::network_manager::common_headers::Authorization, BasicUI::CallAfter(), audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::displayName, audacity::network_manager::NetworkManager::doGet(), DownloadAvatar(), audacity::BasicSettings::Flush(), audacity::network_manager::NetworkManager::GetInstance(), audacity::cloud::audiocom::GetOAuthService(), audacity::cloud::audiocom::GetServiceConfig(), gPrefs, Observer::Publisher< UserDataChanged >::Publish(), audacity::network_manager::Request::setHeader(), audacity::ToWXString(), audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::userId, audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::userName, and Setting< T >::Write().

Here is the call graph for this function:

---

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

• UserService.h
• UserService.cpp