Send platform, build channel and country code as part of ad confirmat…

…ion calls where it meets privacy standards
brave · Mar 26, 2020 · 22b4e4c · 22b4e4c
1 parent 0977bb0
commit 22b4e4c
Show file tree

Hide file tree

Showing 43 changed files with 651 additions and 15 deletions.
diff --git a/browser/brave_stats_updater.cc b/browser/brave_stats_updater.cc
@@ -12,6 +12,7 @@
 #include "brave/browser/brave_stats_updater_params.h"
 #include "brave/browser/brave_stats_updater_util.h"
 #include "brave/browser/version_info.h"
+#include "brave/common/brave_channel_info.h"
 #include "brave/common/pref_names.h"
 #include "brave/components/brave_referrals/buildflags/buildflags.h"
 #include "chrome/browser/browser_process.h"

diff --git a/browser/brave_stats_updater_util.cc b/browser/brave_stats_updater_util.cc
@@ -11,7 +11,6 @@
 #include "base/strings/string_piece.h"
 #include "base/strings/string_split.h"
 #include "base/strings/stringprintf.h"
-#include "chrome/common/channel_info.h"
 
 namespace brave {
 
@@ -22,13 +21,6 @@ std::string GetDateAsYMD(const base::Time& time) {
                             exploded.day_of_month);
 }
 
-std::string GetChannelName() {
-  std::string channel = chrome::GetChannelName();
-  if (channel.empty())
-    channel = "release";
-  return channel;
-}
-
 std::string GetPlatformIdentifier() {
 #if defined(OS_WIN)
   if (base::SysInfo::OperatingSystemArchitecture() == "x86")

diff --git a/browser/brave_stats_updater_util.h b/browser/brave_stats_updater_util.h
@@ -15,8 +15,6 @@ namespace brave {
 
 std::string GetDateAsYMD(const base::Time& time);
 
-std::string GetChannelName();
-
 std::string GetPlatformIdentifier();
 
 int GetIsoWeekNumber(const base::Time& time);

diff --git a/common/BUILD.gn b/common/BUILD.gn
@@ -47,6 +47,8 @@ source_set("switches") {
 
 source_set("common") {
   sources = [
+    "brave_channel_info.cc",
+    "brave_channel_info.h",
     "brave_content_client.cc",
     "brave_content_client.h",
     "brave_features.cc",

diff --git a/common/brave_channel_info.cc b/common/brave_channel_info.cc
@@ -0,0 +1,21 @@
+/* Copyright (c) 2020 The Brave Authors. All rights reserved.
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "brave/common/brave_channel_info.h"
+
+#include "chrome/common/channel_info.h"
+
+namespace brave {
+
+std::string GetChannelName() {
+  std::string channel_name = chrome::GetChannelName();
+  if (channel_name.empty()) {
+    channel_name = "release";
+  }
+
+  return channel_name;
+}
+
+}  // namespace brave
diff --git a/common/brave_channel_info.h b/common/brave_channel_info.h
@@ -0,0 +1,18 @@
+/* Copyright (c) 2020 The Brave Authors. All rights reserved.
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef BRAVE_COMMON_BRAVE_CHANNEL_INFO_H_
+#define BRAVE_COMMON_BRAVE_CHANNEL_INFO_H_
+
+#include <string>
+
+namespace brave {
+
+std::string GetChannelName();
+
+}
+
+#endif  // BRAVE_COMMON_BRAVE_CHANNEL_INFO_H_
+
diff --git a/components/brave_rewards/browser/android_util.cc b/components/brave_rewards/browser/android_util.cc
@@ -5,13 +5,15 @@
 
 #include "base/json/json_reader.h"
 #include "brave/components/brave_rewards/browser/android_util.h"
+#include "brave/common/brave_channel_info.h"
 
 namespace android_util {
 
 ledger::ClientInfoPtr GetAndroidClientInfo() {
   auto info = ledger::ClientInfo::New();
   info->platform = ledger::Platform::ANDROID_R;
   info->os = ledger::OperatingSystem::UNDEFINED;
+  info->channel = brave::GetChannelName();
   return info;
 }
 

diff --git a/components/brave_rewards/browser/rewards_service_impl.cc b/components/brave_rewards/browser/rewards_service_impl.cc
@@ -38,6 +38,7 @@
 #include "brave/base/containers/utils.h"
 #include "brave/browser/ui/webui/brave_rewards_source.h"
 #include "brave/components/brave_rewards/common/pref_names.h"
+#include "brave/common/brave_channel_info.h"
 #include "brave/common/pref_names.h"
 #include "brave/components/brave_ads/browser/ads_service.h"
 #include "brave/components/brave_ads/browser/ads_service_factory.h"
@@ -3273,6 +3274,8 @@ ledger::ClientInfoPtr GetDesktopClientInfo() {
     info->os = ledger::OperatingSystem::UNDEFINED;
   #endif
 
+  info->channel = brave::GetChannelName();
+
   return info;
 }
 

diff --git a/components/p3a/BUILD.gn b/components/p3a/BUILD.gn
@@ -26,6 +26,7 @@ source_set("p3a") {
   ]
 
   deps = [
+    "//brave/common",
     "//brave/components/p3a:buildflags",
     "//brave/components/brave_prochlo",
     "//brave/components/brave_prochlo:prochlo_proto",

diff --git a/components/p3a/brave_p3a_service.cc b/components/p3a/brave_p3a_service.cc
@@ -19,6 +19,7 @@
 #include "base/trace_event/trace_event.h"
 #include "brave/browser/brave_stats_updater_util.h"
 #include "brave/browser/version_info.h"
+#include "brave/common/brave_channel_info.h"
 #include "brave/common/pref_names.h"
 #include "brave/components/brave_prochlo/prochlo_message.pb.h"
 #include "brave/components/p3a/brave_p3a_log_store.h"

diff --git a/test/BUILD.gn b/test/BUILD.gn
@@ -357,6 +357,7 @@ test("brave_unit_tests") {
       "//brave/vendor/bat-native-ads/src/bat/ads/internal/ads_tabs_unittest.cc",
       "//brave/vendor/bat-native-ads/src/bat/ads/internal/ads_client_mock.cc",
       "//brave/vendor/bat-native-ads/src/bat/ads/internal/ads_client_mock.h",
+      "//brave/vendor/bat-native-confirmations/src/bat/confirmations/internal/platform_helper_mock.h",
       "//brave/vendor/bat-native-confirmations/src/bat/confirmations/internal/ad_grants_unittest.cc",
       "//brave/vendor/bat-native-confirmations/src/bat/confirmations/internal/payments_unittest.cc",
       "//brave/vendor/bat-native-confirmations/src/bat/confirmations/internal/confirmations_create_confirmation_request_unittest.cc",

diff --git a/vendor/bat-native-ads/include/bat/ads/ad_info.h b/vendor/bat-native-ads/include/bat/ads/ad_info.h
@@ -29,6 +29,7 @@ struct ADS_EXPORT AdInfo {
   std::string creative_set_id;
   std::string category;
   std::string target_url;
+  std::string geo_target;
 };
 
 }  // namespace ads

diff --git a/vendor/bat-native-ads/src/bat/ads/ad_info.cc b/vendor/bat-native-ads/src/bat/ads/ad_info.cc
@@ -51,6 +51,10 @@ Result AdInfo::FromJson(
     target_url = document["url"].GetString();
   }
 
+  if (document.HasMember("geo_target")) {
+    geo_target = document["geo_target"].GetString();
+  }
+
   return SUCCESS;
 }
 
@@ -71,6 +75,9 @@ void SaveToJson(
   writer->String("url");
   writer->String(info.target_url.c_str());
 
+  writer->String("geo_target");
+  writer->String(info.geo_target.c_str());
+
   writer->EndObject();
 }
 

diff --git a/vendor/bat-native-ads/src/bat/ads/ad_notification_info.cc b/vendor/bat-native-ads/src/bat/ads/ad_notification_info.cc
@@ -101,6 +101,9 @@ void SaveToJson(
   writer->String("url");
   writer->String(info.target_url.c_str());
 
+  writer->String("geo_target");
+  writer->String(info.geo_target.c_str());
+
   writer->EndObject();
 }
 

diff --git a/vendor/bat-native-ads/src/bat/ads/internal/ad_notifications.cc b/vendor/bat-native-ads/src/bat/ads/internal/ad_notifications.cc
@@ -31,6 +31,7 @@ const char kNotificationCategoryKey[] = "category";
 const char kNotificationTitleKey[] = "advertiser";
 const char kNotificationBodyKey[] = "text";
 const char kNotificationTargetUrlKey[] = "url";
+const char kNotificationGeoTargetKey[] = "geo_target";
 
 AdNotifications::AdNotifications(
     AdsImpl* ads,
@@ -214,6 +215,10 @@ bool AdNotifications::GetNotificationFromDictionary(
     return false;
   }
 
+  if (!GetGeoTargetFromDictionary(dictionary, &notification_info.geo_target)) {
+    return false;
+  }
+
   *info = notification_info;
 
   return true;
@@ -269,6 +274,12 @@ bool AdNotifications::GetTargetUrlFromDictionary(
   return GetStringFromDictionary(kNotificationTargetUrlKey, dictionary, value);
 }
 
+bool AdNotifications::GetGeoTargetFromDictionary(
+    base::DictionaryValue* dictionary,
+    std::string* value) const {
+  return GetStringFromDictionary(kNotificationGeoTargetKey, dictionary, value);
+}
+
 bool AdNotifications::GetStringFromDictionary(
     const std::string& key,
     base::DictionaryValue* dictionary,

diff --git a/vendor/bat-native-ads/src/bat/ads/internal/ad_notifications.h b/vendor/bat-native-ads/src/bat/ads/internal/ad_notifications.h
@@ -87,6 +87,9 @@ class AdNotifications {
   bool GetTargetUrlFromDictionary(
       base::DictionaryValue* dictionary,
       std::string* value) const;
+  bool GetGeoTargetFromDictionary(
+      base::DictionaryValue* dictionary,
+      std::string* value) const;
 
   bool GetStringFromDictionary(
     const std::string& key,

diff --git a/vendor/bat-native-ads/src/bat/ads/internal/ads_impl.cc b/vendor/bat-native-ads/src/bat/ads/internal/ads_impl.cc
@@ -1464,6 +1464,7 @@ bool AdsImpl::ShowAdNotification(
   ad_notification->title = info.title;
   ad_notification->body = info.body;
   ad_notification->target_url = helper::Uri::GetUri(info.target_url);
+  ad_notification->geo_target = info.geo_targets.at(0);
 
   BLOG(INFO) << "Ad notification shown:"
       << std::endl << "  uuid: " << ad_notification->uuid

diff --git a/vendor/bat-native-confirmations/BUILD.gn b/vendor/bat-native-confirmations/BUILD.gn
@@ -75,6 +75,8 @@ source_set("bat-native-confirmations") {
     "src/bat/confirmations/internal/ledger_serve_helper.cc",
     "src/bat/confirmations/internal/ledger_serve_helper.h",
     "src/bat/confirmations/internal/logging.h",
+    "src/bat/confirmations/internal/platform_helper.cc",
+    "src/bat/confirmations/internal/platform_helper.h",
     "src/bat/confirmations/internal/payment_info.h",
     "src/bat/confirmations/internal/payments.cc",
     "src/bat/confirmations/internal/payments.h",
@@ -100,6 +102,41 @@ source_set("bat-native-confirmations") {
     "src/bat/confirmations/internal/unblinded_tokens.h",
   ]
 
+  if (is_android) {
+    sources += [
+      "src/bat/confirmations/internal/platform_helper_android.cc",
+      "src/bat/confirmations/internal/platform_helper_android.h",
+    ]
+  }
+
+  if (is_linux) {
+    sources += [
+      "src/bat/confirmations/internal/platform_helper_linux.cc",
+      "src/bat/confirmations/internal/platform_helper_linux.h",
+    ]
+  }
+
+  if (is_mac) {
+    sources += [
+      "src/bat/confirmations/internal/platform_helper_mac.mm",
+      "src/bat/confirmations/internal/platform_helper_mac.h",
+    ]
+  }
+
+  if (is_ios) {
+    sources += [
+      "src/bat/confirmations/internal/platform_helper_ios.mm",
+      "src/bat/confirmations/internal/platform_helper_ios.h",
+    ]
+  }
+
+  if (is_win) {
+    sources += [
+      "src/bat/confirmations/internal/platform_helper_win.cc",
+      "src/bat/confirmations/internal/platform_helper_win.h",
+    ]
+  }
+
   public_deps = [
     ":challenge_bypass_libs",
   ]

diff --git a/vendor/bat-native-confirmations/include/bat/confirmations/ad_info.h b/vendor/bat-native-confirmations/include/bat/confirmations/ad_info.h
@@ -23,6 +23,7 @@ struct CONFIRMATIONS_EXPORT AdInfo {
   std::string creative_set_id;
   std::string category;
   std::string target_url;
+  std::string geo_target;
 };
 
 }  // namespace confirmations

diff --git a/vendor/bat-native-confirmations/src/bat/confirmations/internal/confirmation_info.h b/vendor/bat-native-confirmations/src/bat/confirmations/internal/confirmation_info.h
@@ -34,6 +34,7 @@ struct ConfirmationInfo {
   BlindedToken blinded_payment_token;
   std::string credential;
   uint64_t timestamp_in_seconds;
+  std::string country_code;
   bool created;
 };
 

diff --git a/vendor/bat-native-confirmations/src/bat/confirmations/internal/confirmations_impl.cc b/vendor/bat-native-confirmations/src/bat/confirmations/internal/confirmations_impl.cc
@@ -56,6 +56,10 @@ ConfirmationsImpl::~ConfirmationsImpl() {
   StopPayingOutRedeemedTokens();
 }
 
+ConfirmationsClient* ConfirmationsImpl::get_client() const {
+  return confirmations_client_;
+}
+
 void ConfirmationsImpl::Initialize(
     OnInitializeCallback callback) {
   BLOG(INFO) << "Initializing confirmations";
@@ -1143,6 +1147,7 @@ void ConfirmationsImpl::ConfirmAd(
       << std::endl << "  creativeSetId: " << info.creative_set_id
       << std::endl << "  category: " << info.category
       << std::endl << "  targetUrl: " << info.target_url
+      << std::endl << "  geoTarget: " << info.geo_target
       << std::endl << "  confirmationType: " << std::string(confirmation_type);
 
   redeem_token_->Redeem(info, confirmation_type);

diff --git a/vendor/bat-native-confirmations/src/bat/confirmations/internal/confirmations_impl.h b/vendor/bat-native-confirmations/src/bat/confirmations/internal/confirmations_impl.h
@@ -33,6 +33,8 @@ class ConfirmationsImpl : public Confirmations {
   explicit ConfirmationsImpl(ConfirmationsClient* confirmations_client);
   ~ConfirmationsImpl() override;
 
+  ConfirmationsClient* get_client() const;
+
   void Initialize(OnInitializeCallback callback) override;
 
   // Wallet

diff --git a/...or/bat-native-confirmations/src/bat/confirmations/internal/create_confirmation_request.cc b/...or/bat-native-confirmations/src/bat/confirmations/internal/create_confirmation_request.cc
@@ -8,14 +8,20 @@
 #include "bat/confirmations/internal/token_info.h"
 #include "bat/confirmations/internal/create_confirmation_request.h"
 #include "bat/confirmations/internal/ads_serve_helper.h"
+#include "bat/confirmations/internal/platform_helper.h"
 #include "bat/confirmations/internal/security_helper.h"
+#include "bat/confirmations/internal/static_values.h"
 #include "base/logging.h"
 #include "base/json/json_writer.h"
 #include "base/values.h"
 
 namespace confirmations {
 
-CreateConfirmationRequest::CreateConfirmationRequest() = default;
+CreateConfirmationRequest::CreateConfirmationRequest(
+    ConfirmationsImpl* confirmations)
+    : confirmations_(confirmations) {
+  DCHECK(confirmations_);
+}
 
 CreateConfirmationRequest::~CreateConfirmationRequest() = default;
 
@@ -79,6 +85,28 @@ std::string CreateConfirmationRequest::CreateConfirmationRequestDTO(
   auto type = std::string(info.type);
   payload.SetKey("type", base::Value(type));
 
+  std::string country_code = info.country_code;
+  const auto iter = kLargeAnonymityCountryCodes.find(country_code);
+  if (iter != kLargeAnonymityCountryCodes.end()) {
+    const bool large_anonymity_country_code = iter->second;
+    if (large_anonymity_country_code) {
+      const auto iter = kPrivacyCountryCodes.find(country_code);
+      if (iter != kPrivacyCountryCodes.end()) {
+        country_code = "??";
+      }
+
+      payload.SetKey("countryCode", base::Value(country_code));
+    }
+  }
+
+  const std::string platform = PlatformHelper::GetInstance()->GetPlatformName();
+  if (!platform.empty()) {
+    payload.SetKey("platform", base::Value(platform));
+  }
+
+  const auto client_info = confirmations_->get_client()->GetClientInfo();
+  payload.SetKey("channelName", base::Value(client_info->channel));
+
   std::string json;
   base::JSONWriter::Write(payload, &json);