Move common PVer4 code into a V4ProtocolManagerUtil class.

components/safe_browsing_db/v4_get_hash_protocol_manager.cc

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "components/safe_browsing_db/v4_get_hash_protocol_manager.h"
 
 #include <utility>
 
 #include "base/base64.h"
-#include "base/logging.h"
 #include "base/macros.h"
 #include "base/metrics/histogram_macros.h"
-#include "base/metrics/sparse_histogram.h"
-#include "base/rand_util.h"
-#include "base/stl_util.h"
-#include "base/strings/string_util.h"
-#include "base/strings/stringprintf.h"
 #include "base/timer/timer.h"
-#include "net/base/escape.h"
 #include "net/base/load_flags.h"
-#include "net/base/net_errors.h"
 #include "net/http/http_response_headers.h"
 #include "net/http/http_status_code.h"
 #include "net/url_request/url_fetcher.h"
 #include "net/url_request/url_request_context_getter.h"
-#include "net/url_request/url_request_status.h"
 
 using base::Time;
 using base::TimeDelta;
 
 namespace {
 
-// Enumerate parsing failures for histogramming purposes.  DO NOT CHANGE
-// THE ORDERING OF THESE VALUES.
-enum ParseResultType {
-  // Error parsing the protocol buffer from a string.
-  PARSE_FROM_STRING_ERROR = 0,
-
-  // A match in the response had an unexpected THREAT_ENTRY_TYPE.
-  UNEXPECTED_THREAT_ENTRY_TYPE_ERROR = 1,
-
-  // A match in the response had an unexpected THREAT_TYPE.
-  UNEXPECTED_THREAT_TYPE_ERROR = 2,
-
-  // A match in the response had an unexpected PLATFORM_TYPE.
-  UNEXPECTED_PLATFORM_TYPE_ERROR = 3,
-
-  // A match in the response contained no metadata where metadata was
-  // expected.
-  NO_METADATA_ERROR = 4,
-
-  // A match in the response contained a ThreatType that was inconsistent
-  // with the other matches.
-  INCONSISTENT_THREAT_TYPE_ERROR = 5,
-
-  // Memory space for histograms is determined by the max.  ALWAYS
-  // ADD NEW VALUES BEFORE THIS ONE.
-  PARSE_GET_HASH_RESULT_MAX = 6
-};
-
 // Record parsing errors of a GetHash result.
 void RecordParseGetHashResult(ParseResultType result_type) {
   UMA_HISTOGRAM_ENUMERATION("SafeBrowsing.ParseV4HashResult", result_type,
-                            PARSE_GET_HASH_RESULT_MAX);
+                            PARSE_RESULT_TYPE_MAX);
 }
 
 }  // namespace
 
 namespace safe_browsing {
 
 const char kUmaV4HashResponseMetricName[] =
     "SafeBrowsing.GetV4HashHttpResponseOrErrorCode";
 
 // The default V4GetHashProtocolManagerFactory.
 class V4GetHashProtocolManagerFactoryImpl
     : public V4GetHashProtocolManagerFactory {
  public:
   V4GetHashProtocolManagerFactoryImpl() {}
   ~V4GetHashProtocolManagerFactoryImpl() override {}
   V4GetHashProtocolManager* CreateProtocolManager(
       net::URLRequestContextGetter* request_context_getter,
-      const V4GetHashProtocolConfig& config) override {
+      const V4ProtocolConfig& config) override {
     return new V4GetHashProtocolManager(request_context_getter, config);
   }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(V4GetHashProtocolManagerFactoryImpl);
 };
 
 // V4GetHashProtocolManager implementation --------------------------------
 
 // static
 V4GetHashProtocolManagerFactory* V4GetHashProtocolManager::factory_ = NULL;
 
 // static
 V4GetHashProtocolManager* V4GetHashProtocolManager::Create(
     net::URLRequestContextGetter* request_context_getter,
-    const V4GetHashProtocolConfig& config) {
+    const V4ProtocolConfig& config) {
   if (!factory_)
     factory_ = new V4GetHashProtocolManagerFactoryImpl();
   return factory_->CreateProtocolManager(request_context_getter, config);
 }
 
-// static
-// Backoff interval is MIN(((2^(n-1))*15 minutes) * (RAND + 1), 24 hours) where
-// n is the number of consecutive errors.
-base::TimeDelta V4GetHashProtocolManager::GetNextBackOffInterval(
-    size_t* error_count,
-    size_t* multiplier) {
-  DCHECK(multiplier && error_count);
-  (*error_count)++;
-  if (*error_count > 1 && *error_count < 9) {
-    // With error count 9 and above we will hit the 24 hour max interval.
-    // Cap the multiplier here to prevent integer overflow errors.
-    *multiplier *= 2;
-  }
-  base::TimeDelta next =
-      base::TimeDelta::FromMinutes(*multiplier * (1 + base::RandDouble()) * 15);
-
-  base::TimeDelta day = base::TimeDelta::FromHours(24);
-
-  if (next < day)
-    return next;
-  else
-    return day;
-}
-
 void V4GetHashProtocolManager::ResetGetHashErrors() {
   gethash_error_count_ = 0;
   gethash_back_off_mult_ = 1;
 }
 
 V4GetHashProtocolManager::V4GetHashProtocolManager(
     net::URLRequestContextGetter* request_context_getter,
-    const V4GetHashProtocolConfig& config)
+    const V4ProtocolConfig& config)
     : gethash_error_count_(0),
       gethash_back_off_mult_(1),
       next_gethash_time_(Time::FromDoubleT(0)),
-      version_(config.version),
-      client_name_(config.client_name),
-      key_param_(config.key_param),
+      config_(config),
       request_context_getter_(request_context_getter),
       url_fetcher_id_(0) {
-  DCHECK(!version_.empty());
 }
 
 // static
 void V4GetHashProtocolManager::RecordGetHashResult(ResultType result_type) {
   UMA_HISTOGRAM_ENUMERATION("SafeBrowsing.GetV4HashResult", result_type,
                             GET_HASH_RESULT_MAX);
 }
 
-void V4GetHashProtocolManager::RecordHttpResponseOrErrorCode(
-    const char* metric_name,
-    const net::URLRequestStatus& status,
-    int response_code) {
-  UMA_HISTOGRAM_SPARSE_SLOWLY(
-      metric_name, status.is_success() ? response_code : status.error());
-}
-
 V4GetHashProtocolManager::~V4GetHashProtocolManager() {
   // Delete in-progress SafeBrowsing requests.
   STLDeleteContainerPairFirstPointers(hash_requests_.begin(),
                                       hash_requests_.end());
   hash_requests_.clear();
 }
 
 std::string V4GetHashProtocolManager::GetHashRequest(
     const std::vector<SBPrefix>& prefixes,
     const std::vector<PlatformType>& platforms,
@@ skipping 160 matching lines @@
 
   HashRequests::iterator it = hash_requests_.find(source);
   DCHECK(it != hash_requests_.end()) << "Request not found";
 
   // FindFullHashes response.
   // Reset the scoped pointer so the fetcher gets destroyed properly.
   scoped_ptr<const net::URLFetcher> fetcher(it->first);
 
   int response_code = source->GetResponseCode();
   net::URLRequestStatus status = source->GetStatus();
-  RecordHttpResponseOrErrorCode(kUmaV4HashResponseMetricName, status,
-                                response_code);
+  V4ProtocolManagerUtil::RecordHttpResponseOrErrorCode(
+      kUmaV4HashResponseMetricName, status, response_code);
 
   const FullHashCallback& callback = it->second;
   std::vector<SBFullHashResult> full_hashes;
   base::TimeDelta negative_cache_duration;
   if (status.is_success() && response_code == net::HTTP_OK) {
     RecordGetHashResult(GET_HASH_STATUS_200);
     ResetGetHashErrors();
     std::string data;
     source->GetResponseAsString(&data);
     if (!ParseHashResponse(data, &full_hashes, &negative_cache_duration)) {
@@ skipping 17 matching lines @@
   // Invoke the callback with full_hashes, even if there was a parse error or
   // an error response code (in which case full_hashes will be empty). The
   // caller can't be blocked indefinitely.
   callback.Run(full_hashes, negative_cache_duration);
 
   hash_requests_.erase(it);
 }
 
 void V4GetHashProtocolManager::HandleGetHashError(const Time& now) {
   DCHECK(CalledOnValidThread());
-  base::TimeDelta next =
-      GetNextBackOffInterval(&gethash_error_count_, &gethash_back_off_mult_);
+  base::TimeDelta next = V4ProtocolManagerUtil::GetNextBackOffInterval(
+      &gethash_error_count_, &gethash_back_off_mult_);
   next_gethash_time_ = now + next;
 }
 
-// The API hash call uses the pver4 Safe Browsing server.
-GURL V4GetHashProtocolManager::GetHashUrl(
-    const std::string& request_base64) const {
-  std::string url =
-      ComposePver4Url(kSbV4UrlPrefix, "encodedFullHashes", request_base64,
-                      client_name_, version_, key_param_);
-  return GURL(url);
+GURL V4GetHashProtocolManager::GetHashUrl(const std::string& req_base64) const {
+  return V4ProtocolManagerUtil::GetRequestUrl(req_base64, "encodedFullHashes",
+                                              config_);
 }
 
-// static
-std::string V4GetHashProtocolManager::ComposePver4Url(
-    const std::string& prefix,
-    const std::string& method,
-    const std::string& request_base64,
-    const std::string& client_id,
-    const std::string& version,
-    const std::string& key_param) {
-  DCHECK(!prefix.empty() && !method.empty() && !client_id.empty() &&
-         !version.empty());
-  std::string url =
-      base::StringPrintf("%s/%s/%s?alt=proto&client_id=%s&client_version=%s",
-                         prefix.c_str(), method.c_str(), request_base64.c_str(),
-                         client_id.c_str(), version.c_str());
-  if (!key_param.empty()) {
-    base::StringAppendF(&url, "&key=%s",
-                        net::EscapeQueryParamValue(key_param, true).c_str());
-  }
-  return url;
-}
 
 }  // namespace safe_browsing