Add user agent to headers for all RetroAchievements server calls

Requested agent syntax is "Dolphin/5.0-23456"
dolphin-emu · Apr 30, 2024 · 2a0fbdc · 2a0fbdc
1 parent a954451
commit 2a0fbdc
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 5 deletions.
diff --git a/Source/Core/Common/Version.cpp b/Source/Core/Common/Version.cpp
@@ -9,6 +9,8 @@
 
 namespace Common
 {
+#define EMULATOR_NAME "Dolphin"
+
 #ifdef _DEBUG
 #define BUILD_TYPE_STR "Debug "
 #elif defined DEBUGFAST
@@ -19,10 +21,10 @@ namespace Common
 
 const std::string& GetScmRevStr()
 {
-  static const std::string scm_rev_str = "Dolphin "
+  static const std::string scm_rev_str = EMULATOR_NAME " "
   // Note this macro can be empty if the master branch does not exist.
 #if 1 - SCM_COMMITS_AHEAD_MASTER - 1 != 0
-                                         "[" SCM_BRANCH_STR "] "
+                                                       "[" SCM_BRANCH_STR "] "
 #endif
 
 #ifdef __INTEL_COMPILER
@@ -51,6 +53,12 @@ const std::string& GetScmBranchStr()
   return scm_branch_str;
 }
 
+const std::string& GetUserAgentStr()
+{
+  static const std::string user_agent_str = std::string(EMULATOR_NAME "/") + SCM_DESC_STR;
+  return user_agent_str;
+}
+
 const std::string& GetScmDistributorStr()
 {
   static const std::string scm_distributor_str = SCM_DISTRIBUTOR_STR;

diff --git a/Source/Core/Common/Version.h b/Source/Core/Common/Version.h
@@ -11,6 +11,7 @@ const std::string& GetScmDescStr();
 const std::string& GetScmBranchStr();
 const std::string& GetScmRevStr();
 const std::string& GetScmRevGitStr();
+const std::string& GetUserAgentStr();
 const std::string& GetScmDistributorStr();
 const std::string& GetScmUpdateTrackStr();
 const std::string& GetNetplayDolphinVer();

diff --git a/Source/Core/Core/AchievementManager.cpp b/Source/Core/Core/AchievementManager.cpp
@@ -15,6 +15,7 @@
 #include "Common/HttpRequest.h"
 #include "Common/Image.h"
 #include "Common/Logging/Log.h"
+#include "Common/Version.h"
 #include "Common/WorkQueueThread.h"
 #include "Core/Config/AchievementSettings.h"
 #include "Core/Core.h"
@@ -24,6 +25,9 @@
 #include "VideoCommon/OnScreenDisplay.h"
 #include "VideoCommon/VideoEvents.h"
 
+static const Common::HttpRequest::Headers USER_AGENT_HEADER = {
+    {"User-Agent", Common::GetUserAgentStr()}};
+
 static std::unique_ptr<OSD::Icon> DecodeBadgeToOSDIcon(const AchievementManager::Badge& badge);
 
 AchievementManager& AchievementManager::GetInstance()
@@ -1120,7 +1124,7 @@ AchievementManager::ResponseType AchievementManager::FetchGameData()
     ERROR_LOG_FMT(ACHIEVEMENTS, "Invalid API request for game data.");
     return ResponseType::INVALID_REQUEST;
   }
-  auto http_response = http_request.Post(api_request.url, api_request.post_data);
+  auto http_response = http_request.Post(api_request.url, api_request.post_data, USER_AGENT_HEADER);
   rc_api_destroy_request(&api_request);
   if (!http_response.has_value() || http_response->size() == 0)
   {
@@ -1637,7 +1641,7 @@ AchievementManager::ResponseType AchievementManager::Request(
     ERROR_LOG_FMT(ACHIEVEMENTS, "Invalid API request.");
     return ResponseType::INVALID_REQUEST;
   }
-  auto http_response = http_request.Post(api_request.url, api_request.post_data);
+  auto http_response = http_request.Post(api_request.url, api_request.post_data, USER_AGENT_HEADER);
   rc_api_destroy_request(&api_request);
   if (http_response.has_value() && http_response->size() > 0)
   {
@@ -1676,7 +1680,7 @@ AchievementManager::RequestImage(rc_api_fetch_image_request_t rc_request, Badge*
     ERROR_LOG_FMT(ACHIEVEMENTS, "Invalid request for image.");
     return ResponseType::INVALID_REQUEST;
   }
-  auto http_response = http_request.Get(api_request.url);
+  auto http_response = http_request.Get(api_request.url, USER_AGENT_HEADER);
   if (http_response.has_value() && http_response->size() > 0)
   {
     rc_api_destroy_request(&api_request);