Quirks Client for downloading and providing display profiles

components/quirks/quirks_manager.h

+// 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.
+
+#ifndef COMPONENTS_QUIRKS_QUIRKS_MANAGER_H_
+#define COMPONENTS_QUIRKS_QUIRKS_MANAGER_H_
+
+#include <set>
+
+#include "base/callback.h"
+#include "base/macros.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
+#include "base/time/time.h"
+#include "components/quirks/quirks_client.h"
+#include "components/quirks/quirks_export.h"
+
+class GURL;
+class PrefRegistrySimple;
+class PrefService;
+
+namespace base {
+class SequencedWorkerPool;
+class SingleThreadTaskRunner;
+}
+
+namespace net {
+class URLFetcher;
+class URLFetcherDelegate;
+class URLRequestContextGetter;
+}
+
+namespace quirks {
+
+// Format int as hex string for filename.
+QUIRKS_EXPORT std::string IdToHexString(int64_t product_id);
+
+// Append ".icc" to hex string in filename.
+QUIRKS_EXPORT std::string IdToFileName(int64_t product_id);
+
+// Finds icc file, if it exists; creates and starts QuirksClient if it doesn't.
+// In all cases, sends results to provided callback.
+QUIRKS_EXPORT void RequestIccProfilePath(
+    int64_t product_id,
+    const RequestFinishedCallback& on_request_finished);
+
+// Handles needed components from browser (local preferences, url context
+// getter, blocking pool, etc).
+class QUIRKS_EXPORT QuirksManager {
+ public:
+  using FakeQuirksFetcherCreator =
+      base::Callback<scoped_ptr<net::URLFetcher>(const GURL&,
+                                                 net::URLFetcherDelegate*)>;
+
+  using DaysSinceOobeCallback = base::Callback<void(int)>;
+
+  // Delegate class, so implementation can access browser functionality.
+  class Delegate {
+   public:
+    virtual ~Delegate() = default;
+
+    // Provides Chrome API key for quirks server.
+    virtual std::string GetApiKey() const = 0;
+
+    // Returns the read-only directory where icc files were added before the
+    // Quirks Client provided them.
+    virtual base::FilePath GetBuiltInDisplayProfileDirectory() const = 0;
+
+    // Returns the path to the writable display profile directory.
+    // This directory must already exist.
+    virtual base::FilePath GetDownloadDisplayProfileDirectory() const = 0;
+
+    // Gets days since first login, returns via callback.
+    virtual void GetDaysSinceOobe(DaysSinceOobeCallback callback) const = 0;
+
+   private:
+    DISALLOW_ASSIGN(Delegate);
+  };
+
+  static void Initialize(
+      scoped_ptr<Delegate> delegate,
+      scoped_refptr<base::SequencedWorkerPool> blocking_pool,
+      PrefService* local_state,
+      scoped_refptr<net::URLRequestContextGetter> url_context_getter);
+  static void Shutdown();
+  static void OnLoginCompleted();  // Start queued downloads after login.

[stevenjb, 2016/03/10 19:29:31]

I think this would be a little more clear as a member function instead of a
static. i.e.

QuirksManager::Get()->OnLoginCompleted();

This assumes that QuirksManager will always be initialized, which I believe is
logically correct? If not, it would be more clear to do something like:

if (QuirksManager::IsInitialized())
  QuirksManager::Get()->OnLoginCompleted();

with a comment describing the circumstances under which it might not be
initialized. This will make it clear that it might not be initialized due to,
e.g., a command line flag and not to a timing issue.

As the code is currently written, if g_manager is null this will quietly fail.

One reason to put this logic into the caller is that the calling code may get
moved or re-factored at some point. We want to make sure that doesn't break any
assumptions.

[Greg Levin, 2016/03/15 18:12:57]

Done.  Also made RequestIccProfilePath() a member.  As best I can tell,
g_manager can't be NULL while ChromeBrowser's main message loop is running (at
least, under any non-horrible circumstances).

+  static QuirksManager* Get();
+
+  static void RegisterPrefs(PrefRegistrySimple* registry);
+
+  // Entry point into manager.  Finds or downloads icc file.
+  void RequestIccFilePath(int64_t product_id,
+                          const RequestFinishedCallback& on_request_finished);
+
+  void ClientFinished(QuirksClient* client);
+
+  // UMA stats for server check reason and results.
+  void RecordReasonUmaStat(QuirksClient::RequestReason reason);
+  void RecordFileFoundUmaStat(bool success);
+
+  // Creates a real URLFetcher for OS, and a fake one for tests.
+  scoped_ptr<net::URLFetcher> CreateURLFetcher(
+      const std::string& url,
+      net::URLFetcherDelegate* delegate);
+
+  Delegate* delegate() const { return delegate_.get(); }
+  base::SequencedWorkerPool* blocking_pool() const {
+    return blocking_pool_.get();
+  }
+
+  net::URLRequestContextGetter* url_context_getter() const {
+    return url_context_getter_.get();
+  }
+
+ protected:
+  friend class QuirksBrowserTest;
+
+  void SetFakeQuirksFetcherCreatorForTests(
+      const FakeQuirksFetcherCreator& creator) {
+    fake_quirks_fetcher_creator_ = creator;
+  }
+
+ private:
+  QuirksManager(scoped_ptr<Delegate> delegate,
+                scoped_refptr<base::SequencedWorkerPool> blocking_pool,
+                PrefService* local_state,
+                scoped_refptr<net::URLRequestContextGetter> url_context_getter);
+  ~QuirksManager();
+
+  // Callback after checking for existing icc file; proceed if not found.
+  void OnIccFilePathRequestCompleted(
+      int64_t product_id,
+      const RequestFinishedCallback& on_request_finished,
+      base::FilePath path);
+
+  // Callback after checking OOBE date; launch client if appropriate.
+  void OnDaysSinceOobeReceived(
+      int64_t product_id,
+      const RequestFinishedCallback& on_request_finished,
+      int days_since_oobe);
+
+  // Create and start a client to download file.
+  void CreateClient(int64_t product_id,
+                    const RequestFinishedCallback& on_request_finished);
+
+  // Records time of most recent server check.
+  void SetLastServerCheck(int64_t product_id, const base::Time& last_check);
+
+  std::set<scoped_ptr<QuirksClient>> clients_;
+  bool waiting_for_login_;  // Don't start downloads before first session login.
+
+  // These objects provide resources from the browser.
+  scoped_ptr<Delegate> delegate_;  // Impl runs from chrome/browser.
+  scoped_refptr<base::SequencedWorkerPool> blocking_pool_;
+  PrefService* local_state_;  // For local prefs.
+  scoped_refptr<net::URLRequestContextGetter> url_context_getter_;
+
+  FakeQuirksFetcherCreator fake_quirks_fetcher_creator_;  // For tests.
+
+  // Factory for callbacks.
+  base::WeakPtrFactory<QuirksManager> weak_ptr_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(QuirksManager);
+};
+
+}  // namespace quirks
+
+#endif  // COMPONENTS_QUIRKS_QUIRKS_MANAGER_H_